Applies to: Exchange Server 2013

Topic Last Modified: 2012-06-13

Use the New-SystemMessage cmdlet to create customized delivery status notification (DSN) or quota messages, in the specified language, on Mailbox servers or Edge Transport servers.

Syntax

New-SystemMessage -DsnCode <EnhancedStatusCode> -Internal <$true | $false> -Language <CultureInfo> -Text <String> <COMMON PARAMETERS>
New-SystemMessage -Language <CultureInfo> -QuotaMessageType <WarningMailboxUnlimitedSize | WarningPublicFolderUnlimitedSize | WarningMailbox | WarningPublicFolder | ProhibitSendMailbox | ProhibitPostPublicFolder | ProhibitSendReceiveMailBox> -Text <String> <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example creates a customized DSN message for the DSN code 5.3.5 with the following settings:

  • This DSN message is only displayed to external users.

  • The text for the DSN message is provided for the English locale.

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

EXAMPLE 2

This example creates a customized WarningMailbox quota message. This message is displayed to users who meet the following criteria:

  • The mailbox has exceeded the warning mailbox limit configured on the mailbox.

  • The mailbox is located on a server that uses the English locale.

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

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 Mail Flow Permissions topic.

Parameters

Parameter Required Type Description

DsnCode

Required

Microsoft.Exchange.Data.EnhancedStatusCode

The DsnCode 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 can't be used when the QuotaMessageType parameter is specified.

Internal

Required

System.Boolean

The Internal parameter specifies whether the message is displayed to users inside the Exchange organization. For messages that are only displayed internally, set this parameter to $true. For messages that are only displayed to external users, set this parameter to $false.

Note:
This parameter can't be used when the QuotaMessageType parameter is specified.

Language

Required

System.Globalization.CultureInfo

The Language parameter specifies the language of the message. The message can be created in any Exchange-supported language. Languages are specified by using their locale name. For example, the locale name for English is en and the locale name for 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

The QuotaMessageType parameter selects the type of quota message to create.

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 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 prohibit send quota and prohibit receive quota exceeds the specified mailbox send and receive size limit.

Note:
This parameter can't be used when the DsnCode parameter is specified.

Text

Required

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.

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.

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.