Remove-SystemMessage
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Remove-SystemMessage cmdlet in Microsoft Exchange Server 2007 to delete customized Delivery Status Notification (DSN) or quota messages on computers that have the Hub Transport server role or Edge Transport server role installed.
Syntax
Remove-SystemMessage -Identity <SystemMessageIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Detailed Description
This cmdlet lets you delete 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.
To run the Remove-SystemMessage cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
To run the Remove-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. 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 also identify a customized quota message by using 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 retrieves data from 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. |
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 shows how to remove a customized DSN message from the server. To remove a customized DSN message, you must type the identity of the DSN message on the command line.
The second example shows how to remove a customized quota message from the server. To remove a customized quota message, you must type the identity of the quota message on the command line.
Remove-SystemMessage En\Internal\5.7.9
Remove-SystemMessage En\WarningMailbox
Only customized DSN and quota messages can be removed from the server. Built-in DSN and quota messages cannot be removed. When a customized DSN or quota message is removed, the message text reverts to the built-in text included with Exchange Server.