Applies to: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2007-09-05

Use the Get-SystemMessage cmdlet in Microsoft Exchange Server 2007 to view the delivery status notification (DSN) or quota messages on computers that have the Hub Transport server role or Edge Transport server role installed.

Syntax

Get-SystemMessage [-Identity <SystemMessageIdParameter>] [-DomainController <Fqdn>]
Get-SystemMessage [-DomainController <Fqdn>] [-Original <SwitchParameter>]

Parameters

Parameter Required Type Description

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 reads only to the local Active Directory Application Mode (ADAM) instance.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.SystemMessageIdParameter

This parameter specifies the identity of the DSN or quota message.

You can also retrieve 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 retrieve 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:

  • 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 prohibit send 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.

You can omit the Identity parameter label.

Original

Optional

System.Management.Automation.SwitchParameter

This parameter enables you to retrieve the list of default DSN or quota messages that were included with Exchange 2007 when you installed Exchange 2007.

Detailed Description

This cmdlet lets you view default and 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.

You can retrieve a customized DSN or quota message by specifying the identity of the message by using the Identity parameter. You can retrieve a list of built-in DSN or quota messages by using the Original parameter.

Note:
You cannot specify the Original and Identity parameters in the same command.

To run the Get-SystemMessage cmdlet, the account you use must be delegated the following:

  • Exchange Organization Administrator role

To run the Get-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.

Input Types

Return Types

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Example

In the following example code, the first example shows how you can display a summary list of all customized DSN and quota messages configured on the server.

The second example shows how you can view the detailed configuration of a specific customized DSN message by piping the output of the Get-SystemMessage cmdlet to the Format-List cmdlet.

The third example shows how you can view the detailed configuration of a specific customized quota message by piping the output of the Get-SystemMessage cmdlet to the Format-List cmdlet.

The fourth example shows how to view a list of all built-in DSN and quota messages.

For more information about pipelining, see Pipelining. For more information about how to work with the output of a cmdlet, see Working with Command Output.

Copy Code
Get-SystemMessage
Get-SystemMessage En\Internal\5.3.2 | Format-List
Get-SystemMessage En\WarningMailbox | Format-List
Get-SystemMessage -Original