< Back
New-DbaDbMailAccount
Post
NAME New-DbaDbMailAccount
SYNOPSIS
Creates a new database mail account
SYNTAX
New-DbaDbMailAccount [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [-Name] <String> [[-DisplayName] <String>] [[-Description] <String>] [-EmailAddress] <String>
[[-ReplyToAddress] <String>] [[-MailServer] <String>] [-Force <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Creates a new database mail account
PARAMETERS
-Description [<String>]
Sets the description of the purpose of the mail account.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-DisplayName [<String>]
Sets the name of the mail account that is displayed in messages.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EmailAddress [<String>]
Sets the e-mail address of the mail account.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Force [<Switch>]
If this switch is enabled, the Mail Account will be created even if the mail server is not present.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-MailServer [<String>]
The name of the mail server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<String>]
The Name of the account to be created.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ReplyToAddress [<String>]
Sets the e-mail address to which the mail account replies.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL
Server version 2008 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: DbMail
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$account = New-DbaDbMailAccount -SqlInstance sql2017 -Name 'The DBA Team' -EmailAddress admin@ad.local
-MailServer smtp.ad.local
Creates a new db mail account with the email address admin@ad.local on sql2017 named "The DBA Team" using the
smtp.ad.local mail server
RELATED LINKS
https://dbatools.io/New-DbaDbMailAccount
SYNOPSIS
Creates a new database mail account
SYNTAX
New-DbaDbMailAccount [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [-Name] <String> [[-DisplayName] <String>] [[-Description] <String>] [-EmailAddress] <String>
[[-ReplyToAddress] <String>] [[-MailServer] <String>] [-Force <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Creates a new database mail account
PARAMETERS
-Description [<String>]
Sets the description of the purpose of the mail account.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-DisplayName [<String>]
Sets the name of the mail account that is displayed in messages.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EmailAddress [<String>]
Sets the e-mail address of the mail account.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Force [<Switch>]
If this switch is enabled, the Mail Account will be created even if the mail server is not present.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-MailServer [<String>]
The name of the mail server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<String>]
The Name of the account to be created.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ReplyToAddress [<String>]
Sets the e-mail address to which the mail account replies.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL
Server version 2008 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: DbMail
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$account = New-DbaDbMailAccount -SqlInstance sql2017 -Name 'The DBA Team' -EmailAddress admin@ad.local
-MailServer smtp.ad.local
Creates a new db mail account with the email address admin@ad.local on sql2017 named "The DBA Team" using the
smtp.ad.local mail server
RELATED LINKS
https://dbatools.io/New-DbaDbMailAccount