commands

^

Get-DbaDbMailServer

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

 

Synopsis

Gets database mail servers from SQL Server

Description

Gets database mail servers from SQL Server

Syntax

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

 

Examples

 

Example: 1
PS C:\> Get-DbaDbMailServer -SqlInstance sql01\sharepoint

Returns all DBMail servers on sql01\sharepoint

Example: 2
PS C:\> Get-DbaDbMailServer -SqlInstance sql01\sharepoint -Server DbaTeam

Returns The DBA Team DBMail server from sql01\sharepoint

Example: 3
PS C:\> Get-DbaDbMailServer -SqlInstance sql01\sharepoint | Select-Object *

Returns the DBMail servers on sql01\sharepoint then return a bunch more columns

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

Returns the DBMail servers for "sql2014","sql2016" and "sqlcluster\sharepoint"

Optional Parameters

-SqlInstance

TThe 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
-Server

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

Alias Name
Required False
Pipeline false
Default Value
-Account

Get only the mail server associated with specific accounts

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-DbaDbMailServer on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaDbMailServer.