[This topic is in progress.]

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2011-05-07

Use the Set-SystemMessage cmdlet in Microsoft Exchange Server 2010 to modify existing customized delivery status notification (DSN) or quota messages, in the specified language, on computers that have the Hub Transport server role or Edge Transport server role installed.

Syntax

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

Detailed Description

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 Transport Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.SystemMessageIdParameter

The Identity 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:

  • WarningMailboxUnlimitedSize   Issued when a mailbox that has no prohibit send quota or prohibit receive quota exceeds the specified mailbox warning limit.

  • WarningPublicFolderUnlimitedSize   Issued when a public folder that has no prohibit send quota or prohibit receive quota exceeds the specified public folder warning limit.

  • WarningMailbox   Issued when a mailbox that has a prohibit send quota or prohibit receive quota exceeds the specified mailbox warning limit.

  • WarningPublicFolder   Issued when a public folder that has a prohibit send quota or prohibit receive quota exceeds the specified public folder warning limit.

  • ProhibitSendMailbox   Issued when a mailbox that has a prohibit send quota exceeds the specified mailbox size limit.

  • ProhibitPostPublicFolder   Issued when a public folder that has a prohibit send quota exceeds the specified public folder size limit.

  • ProhibitSendReceiveMailBox   Issued when a mailbox that has a prohibit send quota and prohibit receive quota exceeds the specified mailbox send and receive size limit.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. The DomainController parameter isn't supported on the Edge Transport server role. The Edge Transport server role writes only to the Active Directory Lightweight Directory Services (AD LDS) instance.

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 instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

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.

Return Types

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.

Examples

EXAMPLE 1

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

Copy Code 
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."

EXAMPLE 2

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

Copy Code 
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."