< Back
New-DbaDbMailProfile
Post
NAME New-DbaDbMailProfile
SYNOPSIS
Creates a new database mail profile
SYNTAX
New-DbaDbMailProfile [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [-Name] <String> [[-Description] <String>] [[-MailAccountName] <String>] [[-MailAccountPriority]
<Int>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Creates a new database mail profile, and optionally associates it to a database mail account
PARAMETERS
-Description [<String>]
Sets the description of the purpose of the mail profile.
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
-MailAccountName [<String>]
Associates a db mail account to link to this db mail profile.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-MailAccountPriority [<Int>]
Sets the priority of the linked db mail account when linking to this db mail profile.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<String>]
The Name of the profile to be created.
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: Ian Lanham (@ilanham)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$profile = New-DbaDbMailProfile -SqlInstance sql2017 -Name 'The DBA Team'
Creates a new db mail profile
RELATED LINKS
https://dbatools.io/New-DbaDbMailProfile
SYNOPSIS
Creates a new database mail profile
SYNTAX
New-DbaDbMailProfile [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [-Name] <String> [[-Description] <String>] [[-MailAccountName] <String>] [[-MailAccountPriority]
<Int>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Creates a new database mail profile, and optionally associates it to a database mail account
PARAMETERS
-Description [<String>]
Sets the description of the purpose of the mail profile.
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
-MailAccountName [<String>]
Associates a db mail account to link to this db mail profile.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-MailAccountPriority [<Int>]
Sets the priority of the linked db mail account when linking to this db mail profile.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<String>]
The Name of the profile to be created.
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: Ian Lanham (@ilanham)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$profile = New-DbaDbMailProfile -SqlInstance sql2017 -Name 'The DBA Team'
Creates a new db mail profile
RELATED LINKS
https://dbatools.io/New-DbaDbMailProfile