< Back
Get-DbaDbMailProfile
Post
NAME Get-DbaDbMailProfile
SYNOPSIS
Gets database mail profiles from SQL Server
SYNTAX
Get-DbaDbMailProfile [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Profile] <System.String[]>] [[-ExcludeProfile] <System.String[]>]
[[-InputObject] <Microsoft.SqlServer.Management.Smo.Mail.SqlMail[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Gets database mail profiles 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
-ExcludeProfile [<System.String[]>]
Specifies one or more profile(s) to exclude.
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
-Profile [<System.String[]>]
Specifies one or more profile(s) to get. If unspecified, all profiles 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-DbaDbMailProfile -SqlInstance sql01\\sharepoint
Returns DBMail profiles on sql01\\sharepoint
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaDbMailProfile -SqlInstance sql01\\sharepoint -Profile 'The DBA Team'
Returns The DBA Team DBMail profile from sql01\\sharepoint
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaDbMailProfile -SqlInstance sql01\\sharepoint | Select-Object *
Returns the DBMail profiles on sql01\\sharepoint then return a bunch more columns
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>$servers = "sql2014","sql2016", "sqlcluster\\sharepoint"
PS C:\\> $servers | Get-DbaDbMail | Get-DbaDbMailProfile
Returns the DBMail profiles for "sql2014","sql2016" and "sqlcluster\\sharepoint"
RELATED LINKS
https://dbatools.io/Get-DbaDbMailProfile
SYNOPSIS
Gets database mail profiles from SQL Server
SYNTAX
Get-DbaDbMailProfile [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Profile] <System.String[]>] [[-ExcludeProfile] <System.String[]>]
[[-InputObject] <Microsoft.SqlServer.Management.Smo.Mail.SqlMail[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Gets database mail profiles 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
-ExcludeProfile [<System.String[]>]
Specifies one or more profile(s) to exclude.
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
-Profile [<System.String[]>]
Specifies one or more profile(s) to get. If unspecified, all profiles 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-DbaDbMailProfile -SqlInstance sql01\\sharepoint
Returns DBMail profiles on sql01\\sharepoint
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaDbMailProfile -SqlInstance sql01\\sharepoint -Profile 'The DBA Team'
Returns The DBA Team DBMail profile from sql01\\sharepoint
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaDbMailProfile -SqlInstance sql01\\sharepoint | Select-Object *
Returns the DBMail profiles on sql01\\sharepoint then return a bunch more columns
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>$servers = "sql2014","sql2016", "sqlcluster\\sharepoint"
PS C:\\> $servers | Get-DbaDbMail | Get-DbaDbMailProfile
Returns the DBMail profiles for "sql2014","sql2016" and "sqlcluster\\sharepoint"
RELATED LINKS
https://dbatools.io/Get-DbaDbMailProfile