New-SystemMessage (RTM)
Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.
Applies to: Exchange Server 2007
Use the New-SystemMessage cmdlet in Microsoft Exchange Server 2007 to create new 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
New-SystemMessage -DsnCode <EnhancedStatusCode> -Internal <$true | $false> -Language <CultureInfo> -Text <String> [-DomainController <Fqdn>] [-TemplateInstance <PSObject>]
New-SystemMessage -Language <CultureInfo> -QuotaMessageType <WarningMailboxUnlimitedSize | WarningPublicFolderUnlimitedSize | WarningMailbox | WarningPublicFolder | ProhibitSendMailbox | ProhibitPostPublicFolder | ProhibitSendReceiveMailBox> -Text <String> [-DomainController <Fqdn>] [-TemplateInstance <PSObject>]
Detailed Description
This cmdlet lets you create new 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.
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 New-SystemMessage cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
To run the New-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 Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
DsnCode |
Required |
Microsoft.Exchange.Data.EnhancedStatusCode |
This parameter specifies which DSN code the DSN message applies to. This parameter can be a built-in code, or it can be a customized administrator-defined code. Note This parameter is not required and cannot be used when the QuotaMessageType parameter is specified. |
Internal |
Required |
System.Boolean |
This parameter specifies whether the message is displayed to users who are inside the Exchange Server organization. For messages that are only displayed internally, enter Note This parameter is not required and cannot be used when the QuotaMessageType parameter is specified. |
Language |
Required |
System.Globalization.CultureInfo |
This parameter specifies the language of the message. The message can be created in any Exchange Server-supported language. Languages are specified by using their locale name. For example, English is "en". Japanese is "ja". For a complete list of locales, see Supported Locales for Use with System Messages. |
QuotaMessageType |
Required |
Microsoft.Exchange.Data.Directory.SystemConfiguration.QuotaMessageType |
This parameter selects the type of quota message to create. The QuotaMessageType parameter accepts the following values:
Note This parameter is not required and cannot be used when the DsnCode parameter is specified. |
Text |
Required |
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. |
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. |
TemplateInstance |
Optional |
System.Management.Automation.PSObject |
When an existing object is supplied to this parameter, the command uses the configuration of the object to create a duplicate object on a local or target server. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
Exceptions
| Exceptions | Description |
|---|---|
Example
In the following example code, the first example adds a new customized DSN message that has the DSN code 5.3.5. This DSN message will only be displayed to external users. The text for the DSN message is included on the command line, together with the message language, English.
The second example adds a new customized WarningMailbox quota message. This message will be displayed to users who meet the following criteria:
The mailbox has exceeded the warning mailbox limit configured on the mailbox.
There is no prohibit send or prohibit receive mailbox quota configured.
The mailbox is located on a server that uses the English locale.
New-SystemMessage -DsnCode 5.3.5 -Language En -Internal $false -Text "The recipient e-mail system can't process this e-mail message. Please contact your system administrator for more information."
New-SystemMessage -QuotaMessageType WarningMailbox -Language En -Text "Your mailbox has exceeded the warning limit specified by your e-mail administrator. Please reduce the size of your mailbox."