commands

^

Get-DbaDbMailAccount

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Gets database mail accounts from SQL Server

Description

Gets database mail accounts from SQL Server

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.

Alias
Required False
Pipeline false
Default Value
-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.

Alias
Required False
Pipeline false
Default Value
-Account

Specifies one or more account(s) to get. If unspecified, all accounts will be returned.

Alias
Required False
Pipeline false
Default Value
-ExcludeAccount

Specifies one or more account(s) to exclude.

Alias
Required False
Pipeline false
Default Value
-InputObject

Accepts pipeline input from Get-DbaDbMail

Alias
Required False
Pipeline true (ByValue)
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False

 

Want to see the source code for this command? Check out Get-DbaDbMailAccount on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaDbMailAccount.