Get-DbaDbMailConfig

NAME Get-DbaDbMailConfig



SYNOPSIS

Gets database mail configs from SQL Server





SYNTAX

Get-DbaDbMailConfig [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]

[[-SqlCredential] <Pscredential>] [[-Name] <System.String[]>] [[-InputObject]

<Microsoft.SqlServer.Management.Smo.Mail.SqlMail[]>] [-EnableException <Switch>] [<CommonParameters>]





DESCRIPTION

Gets database mail configs from SQL Server





PARAMETERS

-EnableException [<Switch>]

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.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-InputObject [<Microsoft.SqlServer.Management.Smo.Mail.SqlMail[]>]

Accepts pipeline input from Get-DbaDbMail



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Name [<System.String[]>]

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



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SqlCredential [<Pscredential>]

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.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]

TThe target SQL Server instance or instances.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Tags: DatabaseMail, DBMail, Mail

Author: Chrissy LeMaire (@cl), netnerds.net



Website: https://dbatools.io

Copyright: (c) 2018 by dbatools, licensed under MIT

License: MIT https://opensource.org/licenses/MIT



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



RELATED LINKS

https://dbatools.io/Get-DbaDbMailConfig