| Author | Ian Lanham (@ilanham) |
| Availability | Windows, Linux, macOS |
Want to see the source code for this command? Check out New-DbaDbMailProfile on GitHub.
Want to see the Bill Of Health for this command? Check out New-DbaDbMailProfile.
Creates a new database mail profile
Creates a new database mail profile, and optionally associates it to a database mail account
New-DbaDbMailProfile
[-SqlInstance] <DbaInstanceParameter[]>
[[-SqlCredential] <PSCredential>]
[-Profile] <String>
[[-Description] <String>]
[[-MailAccountName] <String>]
[[-MailAccountPriority] <Int32>]
[-EnableException]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PS C:\> $profile = New-DbaDbMailProfile -SqlInstance sql2017 -Profile 'The DBA Team'
Creates a new database mail profile.
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 |
The name of the profile to be created.
| Alias | Name |
| Required | True |
| Pipeline | false |
| Default Value |
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 |
Sets the description of the purpose of the mail profile.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Associates a db mail account to link to this db mail profile.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Sets the priority of the linked db mail account when linking to this db mail profile.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | 0 |
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 |
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 |
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 |