functions/New-DbaDbMailAccount.ps1
|
function New-DbaDbMailAccount { <# .SYNOPSIS Creates a new database mail account .DESCRIPTION Creates a new database mail account .PARAMETER SqlInstance The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2008 or higher. .PARAMETER 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. .PARAMETER Name The Name of the account to be created. .PARAMETER DisplayName Sets the name of the mail account that is displayed in messages. .PARAMETER Description Sets the description of the purpose of the mail account. .PARAMETER EmailAddress Sets the e-mail address of the mail account. .PARAMETER ReplyToAddress Sets the e-mail address to which the mail account replies. .PARAMETER MailServer The name of the mail server. .PARAMETER 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. .PARAMETER Confirm If this switch is enabled, you will be prompted for confirmation before executing any operations that change state. .PARAMETER Force If this switch is enabled, the Mail Account will be created even if the mail server is not present. .PARAMETER 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. .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 .LINK https://dbatools.io/New-DbaDbMailAccount .EXAMPLE 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 #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = "Low")] param ( [parameter(Mandatory, ValueFromPipeline)] [DbaInstanceParameter[]]$SqlInstance, [PSCredential]$SqlCredential, [parameter(Mandatory)] [string]$Name, [string]$DisplayName = $Name, [string]$Description, [parameter(Mandatory)] [string]$EmailAddress, [string]$ReplyToAddress, [string]$MailServer, [switch]$Force, [switch]$EnableException ) process { foreach ($instance in $SqlInstance) { try { $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $SqlCredential -MinimumVersion 11 } catch { Stop-Function -Message "Error occurred while establishing connection to $instance" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue } if (Test-Bound -ParameterName MailServer) { if (-not (Get-DbaDbMailServer -SqlInstance $server -Server $MailServer) -and -not (Test-Bound -ParameterName Force)) { Stop-Function -Message "The mail server '$MailServer' does not exist on $instance. Use -Force if you need to create it anyway." -ErrorRecord $_ -Target $instance -Continue } } if ($Pscmdlet.ShouldProcess($instance, "Creating new db mail account called $Name")) { try { $account = New-Object Microsoft.SqlServer.Management.SMO.Mail.MailAccount $server.Mail, $Name $account.DisplayName = $DisplayName $account.Description = $Description $account.EmailAddress = $EmailAddress $account.ReplyToAddress = $ReplyToAddress $account.Create() } catch { Stop-Function -Message "Failure creating db mail account" -Target $Name -ErrorRecord $_ -Continue } try { $account.MailServers.Item($($server.DomainInstanceName)).Rename($MailServer) $account.Alter() $account.Refresh() Add-Member -Force -InputObject $account -MemberType NoteProperty -Name ComputerName -value $server.ComputerName Add-Member -Force -InputObject $account -MemberType NoteProperty -Name InstanceName -value $server.ServiceName Add-Member -Force -InputObject $account -MemberType NoteProperty -Name SqlInstance -value $server.DomainInstanceName $account | Select-DefaultView -Property ComputerName, InstanceName, SqlInstance, Id, Name, DisplayName, Description, EmailAddress, ReplyToAddress, IsBusyAccount, MailServers } catch { Stop-Function -Message "Failure returning output" -ErrorRecord $_ -Continue } } } } } |