commands

^

Remove-DbaDbMailProfile

Author Mikey Bronowski (@MikeyBronowski), https://bronowski.it
Availability Windows, Linux, macOS

 

Synopsis

Removes database mail profile(s).

Description

Removes the database mail profile(s) that have passed through the pipeline.

If not used with a pipeline, Get-DbaDbMailProfile will be executed with the parameters provided and the returned database mail profile(s) will be removed.

Syntax

Remove-DbaDbMailProfile
    [-SqlInstance] <DbaInstanceParameter[]>
    [-SqlCredential <PSCredential>]
    [-Profile <String[]>]
    [-ExcludeProfile <String[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-DbaDbMailProfile -InputObject <MailProfile[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Remove-DbaDbMailProfile -SqlInstance localhost, localhost\namedinstance

Removes all database mail profiles on the localhost, localhost\namedinstance instances.

Example: 2
PS C:\> Remove-DbaDbMailProfile -SqlInstance localhost -Profile MyDatabaseMailProfile

Removes MyDatabaseMailProfile database mail profile on the localhost.

Example: 3
PS C:\> Get-DbaDbMailProfile -SqlInstance SRV1 | Out-GridView -Title 'Select database mail profile(s) to drop' -OutputMode Multiple | Remove-DbaDbMailProfile

Using a pipeline this command gets all database mail profiles on SRV1, lets the user select those to remove and then removes the selected database mail profiles.

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required True
Pipeline false
Default Value
-InputObject

Allows piping from Get-DbaDbMailProfile.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

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

Specifies one or more database mail profile(s) to get. If unspecified, all profiles will be removed.

Alias
Required False
Pipeline false
Default Value
-ExcludeProfile

Specifies one or more database mail profile(s) to exclude.

Alias
Required False
Pipeline false
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
-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command. This is the default. Use -Confirm:$false to suppress these prompts.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out Remove-DbaDbMailProfile on GitHub.
Want to see the Bill Of Health for this command? Check out Remove-DbaDbMailProfile.