Get-DbaDbMailAccount

Synopsis

Retrieves Database Mail account configurations from SQL Server instances

Description

Retrieves Database Mail account configurations including email addresses, display names, SMTP server settings, and authentication details from SQL Server instances. This function helps DBAs audit email configurations across their environment, troubleshoot mail delivery issues, and document Database Mail settings for compliance or migration purposes. The returned account objects include connection details, server configurations, and account properties that can be used to verify proper Database Mail setup.

Syntax

Get-DbaDbMailAccount
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Account] <String[]>]
    [[-ExcludeAccount] <String[]>]
    [[-InputObject] <SqlMail[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

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

Returns Database Mail accounts on sql01\sharepoint.

Example: 2

PS C:\> Get-DbaDbMailAccount -SqlInstance sql01\sharepoint -Account 'The DBA Team'

Returns ‘The DBA Team’ Database Mail account from sql01\sharepoint.

Example: 3

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

Returns the Database Mail accounts on sql01\sharepoint then return a bunch more columns.

Example: 4

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

Returns the Database Mail accounts for sql2014, sql2016 and sqlcluster\sharepoint.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

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

-Account

Specifies one or more Database Mail account names to retrieve. Accepts exact account names and supports multiple values.
Use this when you need to check specific mail accounts rather than retrieving all configured accounts on the instance.

-ExcludeAccount

Specifies one or more Database Mail account names to exclude from results. Accepts exact account names and supports multiple values.
Use this when you want to retrieve most accounts but skip specific ones, such as excluding test or deprecated accounts from auditing reports.

-InputObject

Accepts SqlMail objects from the pipeline, typically from Get-DbaDbMail. Allows you to chain Database Mail commands together.
Use this when processing multiple instances through Get-DbaDbMail or when working with previously retrieved Database Mail configurations.

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

Returns one or more Database Mail account objects from the target SQL Server instance(s). Each account object includes configuration details for sending emails through Database Mail.

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)
• ID: The unique identifier (int) for the Database Mail account within the instance
• Name: The name of the Database Mail account
• DisplayName: The display name used in the “From” field of emails sent by this account
• Description: Text description of the account
• EmailAddress: The email address used as the sender (from address) for this account
• ReplyToAddress: The reply-to email address for emails sent from this account
• IsBusyAccount: Boolean indicating if the account is currently busy sending messages
• MailServers: Collection of SMTP servers configured for this account

Additional properties available (from SMO SqlMailAccount object):

• Account: The account owner or associated account information
• AccountType: Type of the account
• CreateDate: DateTime when the account was created
• Urn: The unified resource name (URN) for the object
• Parent: Reference to the parent SqlMail object
• Properties: Collection of property objects for the account
• State: Current state of the account object (Existing, Creating, Deleting)
• Uid: Unique identifier for the account Use Select-Object * to access all available properties if needed.