Get-DbaDbMail

Synopsis

Retrieves Database Mail configuration including profiles, accounts, and settings from SQL Server instances

Description

Retrieves the complete Database Mail configuration from one or more SQL Server instances, including mail profiles, SMTP accounts, configuration values, and properties. This function provides a quick way to audit your email setup across multiple servers, troubleshoot mail delivery issues, or document your Database Mail configuration for compliance purposes. The output includes server identification details to help when working with multiple instances.

Syntax

Get-DbaDbMail
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaDbMail -SqlInstance sql01\sharepoint

Returns the db mail server object on sql01\sharepoint

Example: 2

PS C:\> Get-DbaDbMail -SqlInstance sql01\sharepoint | Select-Object *

Returns the db mail server object on sql01\sharepoint then return a bunch more columns

Example: 3

PS C:\> $servers = "sql2014","sql2016", "sqlcluster\sharepoint"
PS C:\> $servers | Get-DbaDbMail

Returns the db mail server object for “sql2014”,“sql2016” and “sqlcluster\sharepoint”

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

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.

-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.

Outputs

Microsoft.SqlServer.Management.Smo.Mail.SqlMail

Returns one SqlMail object per SQL Server instance with Database Mail configuration details. Each object includes comprehensive collections of mail profiles, accounts, and configuration settings for that instance.

Default display properties (via Select-DefaultView):

• ComputerName: The computer name of the SQL Server instance
• InstanceName: The SQL Server instance name
• SqlInstance: The full SQL Server instance name (computer\instance)
• Profiles: Collection of Database Mail profile objects configured on the instance
• Accounts: Collection of Database Mail account objects configured on the instance
• ConfigurationValues: Collection of Database Mail configuration settings (MaxFileSize, ProhibitedExtensions, etc.)
• Properties: Collection of additional mail properties All properties from the base SMO SqlMail object are accessible using Select-Object *. Use Get-DbaDbMailProfile, Get-DbaDbMailAccount, Get-DbaDbMailConfig, and Get-DbaDbMailServer commands to retrieve detailed information about specific profiles, accounts, configuration settings, and mail servers from these collections.