Export (0) Print
Expand All
Expand Minimize

New-SystemMessage

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-04-11

This cmdlet is available only in on-premises Exchange Server 2013.

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.

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 | WarningMailboxMessagesPerFolderCount | ProhibitReceiveMailboxMessagesPerFolderCount | WarningFolderHierarchyChildrenCount | ProhibitReceiveFolderHierarchyChildrenCountCount | WarningMailboxMessagesPerFolderUnlimitedCount | WarningFolderHierarchyChildrenUnlimitedCount | WarningFolderHierarchyDepth | ProhibitReceiveFolderHierarchyDepth | WarningFolderHierarchyDepthUnlimited> -Text <String> <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

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.

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

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.

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

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.

 

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.

NoteNote:
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.

NoteNote:
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 languages for 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:

Quota message types related to mailbox size:

  • ProhibitSendReceiveMailBox   Issued when a mailbox exceeds its ProhibitSendReceiveQuota limit.

  • ProhibitSendMailbox   Issued when a mailbox exceeds its ProhibitSendQuota limit.

  • WarningMailbox   Issued when a mailbox that has a ProhibitSendQuota limit or a ProhibitSendReceiveQuota limit configured exceeds its IssueWarningQuota limit.

  • WarningMailboxUnlimitedSize   Issued when a mailbox that doesn't have a ProhibitSendQuota limit or a ProhibitSendReceiveQuota limit configured exceeds its IssueWarningQuota limit.

Quota message types related to public folder size:

  • ProhibitPostPublicFolder   Issued when a public folder exceeds its ProhibitPostQuota limit.

  • WarningPublicFolder   Issued when a public folder that has a ProhibitPostQuota limit configured exceeds its IssueWarningQuota limit.

  • WarningPublicFolderUnlimitedSize   Issued when a public folder that doesn't have a ProhibitPostQuota limit configured exceeds its IssueWarningQuota limit.

Quota message types related to the number of messages allowed in a mailbox folder:

  • ProhibitReceiveMailboxMessagesPerFolderCount   Issued when a mailbox exceeds its MailboxMessagesPerFolderCountReceiveQuota limit.

  • WarningMailboxMessagesPerFolderCount   Issued when a mailbox that has a MailboxMessagesPerFolderCountReceiveQuota limit configured exceeds its MailboxMessagesPerFolderCountWarningQuota limit.

  • WarningMailboxMessagesPerFolderUnlimitedCount   Issued when a mailbox that doesn't have a MailboxMessagesPerFolderCountReceiveQuota limit configured exceeds its MailboxMessagesPerFolderCountWarningQuota limit.

Quota message types related to the number of subfolders that can be created in a mailbox folder:

  • ProhibitReceiveFolderHierarchyChildrenCountCount   Issued when a mailbox exceeds its FolderHierarchyChildrenCountReceiveQuota limit.

  • WarningFolderHierarchyChildrenCount   Issued when a mailbox that has a FolderHierarchyChildrenCountReceiveQuota limit configured exceeds its FolderHierarchyChildrenCountWarningQuota limit.

  • WarningFolderHierarchyChildrenUnlimitedCount   Issued when a mailbox that doesn't have a FolderHierarchyChildrenCountReceiveQuota limit configured exceeds its FolderHierarchyChildrenCountWarningQuota limit.

Quota message types related to the number of levels allowed in the folder hierarchy of a mailbox folder:

  • ProhibitReceiveFolderHierarchyDepth   Issued when a mailbox exceeds its FolderHierarchyDepthWarningQuota limit.

  • WarningFolderHierarchyDepth   Issued when a mailbox that has a FolderHierarchyDepthReceiveQuota limit configured exceeds its FolderHierarchyDepthWarningQuota limit.

  • WarningFolderHierarchyDepthUnlimited   Issued when a mailbox that doesn't have a FolderHierarchyDepthReceiveQuota limit configured exceeds its FolderHierarchyDepthWarningQuota limit.

NoteNote:
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.

The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft