Set-SystemMessage
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Set-SystemMessage cmdlet in Microsoft Exchange Server 2007 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>]]
Set-SystemMessage [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Instance <SystemMessage>] [-Name <String>] [-Original <SwitchParameter>] [-Text <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
This cmdlet lets you modify customized DSN and quota messages. DSN messages are issued to the sender of e-mail messages that have not 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 Server.
Note The Exchange server is pre-configured with several standard DSN messages, which you cannot modify by using this cmdlet. Instead, you must create a new DSN message, with the same DSN code, to replace the preconfigured messages.
The following list describes the error conditions that trigger DSN messages that have a delivery status of persistent temporary failure and permanent failure.
4.X.X. DSN messages This type of DSN message is generated when there is a temporary problem with the recipient's mailbox or server. Such problems typically resolve themselves eventually and allow for successful delivery of the e-mail message. An example of a 4.X.X. persistent temporary failure problem is a server that has gone offline and cannot be reached.
5.X.X. DSN messages This type of DSN message is generated when a permanent or fatal error occurs with the recipient's mailbox or server. Such errors cannot be overcome by the sending mail server and therefore, the e-mail message is returned to the sender. An example of a 5.X.X. permanent failure error is a nonexistent SMTP address.
To run the Set-SystemMessage cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
To run the Set-SystemMessage cmdlet on a computer that has the Edge Transport server role installed, you must log on by using an account that is a member of the local Administrators group on that computer.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.SystemMessageIdParameter |
This 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:
You can omit the Identity parameter label. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter 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 parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that writes data to the Active Directory directory service, include the DomainController parameter in the command. The DomainController parameter is not supported on computers that run the Edge Transport server role. The Edge Transport server role writes to and reads from only the local Active Directory Application Mode (ADAM) instance. |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.SystemMessage |
This parameter enables you to pass the DSN or quota message to the command to be processed. This parameter is useful in scripts where an entire object must be passed to the command. |
Name |
Optional |
System.String |
This parameter specifies a name that you can use to describe the DSN or quota message. |
Original |
Optional |
System.Management.Automation.SwitchParameter |
This 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 |
This parameter specifies the text of the message that is 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 parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
Exceptions
| Exceptions | Description |
|---|---|
Example
In the following example code, the first example modifies the English text of an existing customized DSN message that has the DSN code 5.3.5. This DSN message is displayed only to external users. The text for the DSN message is included on the command line.
The second example modifies the English text of an existing customized WarningMailbox quota message.
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."
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."