commands

^

Get-DbaDbMailHistory

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

 

Synopsis

Gets the history of mail sent from a SQL instance

Description

Gets the history of mail sent from a SQL instance

Syntax

Get-DbaDbMailHistory
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Since] <DateTime>]
    [[-Status] <String>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

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

Returns the entire DBMail history on sql01\sharepoint

Example: 2
PS C:\> Get-DbaDbMailHistory -SqlInstance sql01\sharepoint | Select-Object *

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

Example: 3
PS C:\> $servers = "sql2014","sql2016", "sqlcluster\sharepoint"
PS C:\> $servers | Get-DbaDbMailHistory

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

Optional Parameters

-SqlInstance

TThe target SQL Server instance or instances.

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

Datetime object used to narrow the results to the send request date

Alias
Required False
Pipeline false
Default Value
-Status

Narrow the results by status. Valid values include Unsent, Sent, Failed and Retrying

Alias
Required False
Pipeline false
Default Value
Accepted Values Unsent,Sent,Failed,Retrying
-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-DbaDbMailHistory on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaDbMailHistory.