commands

^

Get-DbaDbMailConfig

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

 

Synopsis

Gets database mail configs from SQL Server

Description

Gets database mail configs from SQL Server

Syntax

Get-DbaDbMailConfig
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Name] <String[]>]
    [[-InputObject] <SqlMail[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

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

Returns DBMail configs on sql01\sharepoint

Example: 2
PS C:\> Get-DbaDbMailConfig -SqlInstance sql01\sharepoint -Name ProhibitedExtensions

Returns the ProhibitedExtensions configuration on sql01\sharepoint

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

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

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

Returns the DBMail configs 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
-Name

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

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