commands

^

New-DbaDbMailAccount

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Creates a new database mail account

Description

Creates a new database mail account

Syntax

New-DbaDbMailAccount
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [-Name] <String>
    [[-DisplayName] <String>]
    [[-Description] <String>]
    [-EmailAddress] <String>
    [[-ReplyToAddress] <String>]
    [[-MailServer] <String>]
    [-Force]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> $account = New-DbaDbMailAccount -SqlInstance sql2017 -Name 'The DBA Team' -EmailAddress [email protected] -MailServer smtp.ad.local

Creates a new db mail account with the email address [email protected] on sql2017 named "The DBA Team" using the smtp.ad.local mail server

Required Parameters

-SqlInstance

The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2008 or higher.

Alias
Required True
Pipeline true (ByValue)
Default Value
-Name

The Name of the account to be created.

Alias
Required True
Pipeline false
Default Value
-EmailAddress

Sets the e-mail address of the mail account.

Alias
Required True
Pipeline false
Default Value

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance.

Alias
Required False
Pipeline false
Default Value
-DisplayName

Sets the name of the mail account that is displayed in messages.

Alias
Required False
Pipeline false
Default Value $Name
-Description

Sets the description of the purpose of the mail account.

Alias
Required False
Pipeline false
Default Value
-ReplyToAddress

Sets the e-mail address to which the mail account replies.

Alias
Required False
Pipeline false
Default Value
-MailServer

The name of the mail server.

Alias
Required False
Pipeline false
Default Value
-Force

If this switch is enabled, the Mail Account will be created even if the mail server is not present.

Alias
Required False
Pipeline false
Default Value False
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out New-DbaDbMailAccount on GitHub.
Want to see the Bill Of Health for this command? Check out New-DbaDbMailAccount.