Set-SystemMessage

 

Applies to: Exchange Server 2016

Topic Last Modified: 2017-05-16

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

Use the Set-SystemMessage cmdlet to modify existing customized delivery status notification (DSN) or quota messages.

Set-SystemMessage -Identity <SystemMessageIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Name <String>] [-Original <SwitchParameter>] [-Text <String>] [-WhatIf [<SwitchParameter>]]

This example modifies the English text of an existing customized DSN message that has the DSN code 5.3.5.

Set-SystemMessage En\Internal\5.3.5 -Text "The recipient e-mail system can't process this e-mail message. Please contact your system administrator for more information."

This example modifies the English text of an existing customized WarningMailbox quota message.

Set-SystemMessage En\WarningMailbox -Text "Your mailbox has exceeded the warning limit specified by your e-mail administrator. Please reduce the size of your mailbox."

DSN messages are issued to the sender of e-mail 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.

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

TheIdentity parameter specifies the identity of the DSN or quota message to modify.

To modify a DSN message, use the following format: language\internal | external\system code. For more information about the syntax of the DSN message identity, see DSN message identity.

To modify a customized quota message, use the following format: language\QuotaMessageType. Language is expressed as the two-character locale code. The QuotaMessageType parameter accepts the following values:

Mailbox size quotas:

ProhibitSendReceiveMailBox   A mailbox exceeds its ProhibitSendReceiveQuota limit.

ProhibitSendMailbox   A mailbox exceeds its ProhibitSendQuota limit.

WarningMailbox   A mailbox exceeds its IssueWarningQuota limit when it has a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured.

WarningMailboxUnlimitedSize   A mailbox exceeds its IssueWarningQuota limit when it doesn't have a ProhibitSendQuota or ProhibitSendReceiveQuota limit configured.

Public folder size quotas:

ProhibitPostPublicFolder   A public folder exceeds its ProhibitPostQuota limit.

WarningPublicFolder   A public folder exceeds its IssueWarningQuota limit when it has a ProhibitPostQuota limit configured.

WarningPublicFolderUnlimitedSize   A public folder exceeds its IssueWarningQuota limit when it doesn't have a ProhibitPostQuota limit configured.

Maximum number of messages in a mailbox folder:

ProhibitReceiveMailboxMessagesPerFolderCount   A mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit.

WarningMailboxMessagesPerFolderCount   A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it has a MailboxMessagesPerFolderCountReceiveQuota limit configured.

WarningMailboxMessagesPerFolderUnlimitedCount   A mailbox exceeds its MailboxMessagesPerFolderCountWarningQuota limit when it doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured.

Maximum number of subfolders in a mailbox folder:

ProhibitReceiveFolderHierarchyChildrenCountCount   A mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit.

WarningFolderHierarchyChildrenCount   A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it has a FolderHierarchyChildrenCountReceiveQuota limit configured.

WarningFolderHierarchyChildrenUnlimitedCount   A mailbox exceeds its FolderHierarchyChildrenCountWarningQuota limit when it doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured.

ProhibitReceiveFoldersCount   A mailbox exceeds its FoldersCountReceiveQuota limit.

WarningFoldersCount   A mailbox exceeds its FoldersCountWarningQuota limit when it has a FoldersCountReceiveQuota limit configured.

WarningFoldersCountUnlimited A mailbox exceeds its FoldersCountWarningQuota limit when it doesn't have a FoldersCountReceiveQuota limit configured.

Maximum number of levels (depth) in a mailbox folder:

ProhibitReceiveFolderHierarchyDepth   A mailbox exceeds its FolderHierarchyDepthWarningQuota limit.

WarningFolderHierarchyDepth   A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it has a FolderHierarchyDepthReceiveQuota limit configured.

WarningFolderHierarchyDepthUnlimited   A mailbox exceeds its FolderHierarchyDepthWarningQuota limit when it doesn't have a FolderHierarchyDepthReceiveQuota limit configured.

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.

Name

Optional

System.String

The Name parameter specifies a name that you can use to describe the DSN or quota message.

Original

Optional

System.Management.Automation.SwitchParameter

The Original parameter reverts the DSN or quota message text back to the original shipped text. This parameter is useful when you don't want to remove the customized DSN or quota entry but want to revert to the original text.

Text

Optional

System.String

The Text parameter specifies the text of the message displayed to senders or mailbox owners. The text should explain why the message was created and what actions the sender or mailbox owner should take, if any.

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: