Remove-SystemMessage

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Remove-SystemMessage cmdlet to delete customized delivery status notification (DSN) or quota messages on Mailbox servers or Edge Transport servers.

Remove-SystemMessage -Identity <SystemMessageIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example removes a customized DSN message for the DSN code 5.7.9.

Remove-SystemMessage En\Internal\5.7.9

This example removes a customized quota message for a mailbox size warning.

Remove-SystemMessage En\WarningMailbox

DSN messages are issued to the sender of email messages that haven't reached their intended recipients. Quota messages are issued to users whose mailboxes or public folders have reached the specific warning, prohibit send, or prohibit receive quotas. Customized DSN and quota messages replace the built-in DSN or quota messages included with Exchange.

noteNote:
Only customized DSN and quota messages can be removed from the server. Built-in DSN and quota messages can't be removed. When a customized DSN or quota message is removed, the message text reverts to the built-in text included with Exchange.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "DSNs" entry in the Mail flow permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.SystemMessageIdParameter

The Identity parameter specifies the DSN or quota message you want to remove.

You can also identify a customized DSN message by using the following format: language\internal | external\system code. For more information about the syntax of the DSN message identity, see DSN message identity.

You can identify a customized quota message by using the following format: Language\QuotaMessageType. Language is expressed as the two-character locale code. QuotaMessageType accepts the following values:

Quota message types related to mailbox size:

  • ProhibitSendReceiveMailBox   Issued when a mailbox exceeds its ProhibitSendReceiveQuota limit.

  • ProhibitSendMailbox   Issued when a mailbox exceeds its ProhibitSendQuota limit.

  • WarningMailbox   Issued when a mailbox that has a ProhibitSendQuota limit or a ProhibitSendReceiveQuota limit configured exceeds its IssueWarningQuota limit.

  • WarningMailboxUnlimitedSize   Issued when a mailbox that doesn't have a ProhibitSendQuota limit or a ProhibitSendReceiveQuota limit configured exceeds its IssueWarningQuota limit.

Quota message types related to public folder size:

  • ProhibitPostPublicFolder   Issued when a public folder exceeds its ProhibitPostQuota limit.

  • WarningPublicFolder   Issued when a public folder that has a ProhibitPostQuota limit configured exceeds its IssueWarningQuota limit.

  • WarningPublicFolderUnlimitedSize   Issued when a public folder that doesn't have a ProhibitPostQuota limit configured exceeds its IssueWarningQuota limit.

Quota message types related to the number of messages allowed in a mailbox folder:

  • ProhibitReceiveMailboxMessagesPerFolderCount   Issued when a mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit.

  • WarningMailboxMessagesPerFolderCount   Issued when a mailbox that has a MailboxMessagesPerFolderCountReceiveQuota limit configured exceeds its MailboxMessagesPerFolderCountWarningQuota limit.

  • WarningMailboxMessagesPerFolderUnlimitedCount   Issued when a mailbox that doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured exceeds its MailboxMessagesPerFolderCountWarningQuota limit.

Quota message types related to the number of subfolders that can be created in a mailbox folder:

  • ProhibitReceiveFolderHierarchyChildrenCountCount   Issued when a mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit.

  • WarningFolderHierarchyChildrenCount   Issued when a mailbox that has a FolderHierarchyChildrenCountReceiveQuota limit configured exceeds its FolderHierarchyChildrenCountWarningQuota limit.

  • WarningFolderHierarchyChildrenUnlimitedCount   Issued when a mailbox that doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured exceeds its FolderHierarchyChildrenCountWarningQuota limit.

  • WarningFoldersCount Issued when the number of folders in the hierarchy exceeds the FoldersCountWarningQuota limit.

  • ProhibitReceiveFoldersCount Issued when new public folder creation fails because the public folder hierarchy is too big and has reached the FoldersCountReceiveQuota limit.

  • WarningFoldersCountUnlimited Issued when the public folder hierarchy is getting too big and does not have the FoldersCountReceiveQuota limit configured.

Quota message types related to the number of levels allowed in the folder hierarchy of a mailbox folder:

  • ProhibitReceiveFolderHierarchyDepth   Issued when a mailbox exceeds its FolderHierarchyDepthWarningQuota limit.

  • WarningFolderHierarchyDepth   Issued when a mailbox that has a FolderHierarchyDepthReceiveQuota limit configured exceeds its FolderHierarchyDepthWarningQuota limit.

  • WarningFolderHierarchyDepthUnlimited   Issued when a mailbox that doesn't have a FolderHierarchyDepthReceiveQuota limit configured exceeds its FolderHierarchyDepthWarningQuota limit.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: