The Get Message process views the details of one or more messages in a queue on a computer that has the Hub Transport server role or the Edge Transport server role installed.
The following table describes the input parameters for Get Message process
Adapter request parameters for Get Message process
| | |
|---|
| Specifies the position in the result set where the displayed results start
The value of this parameter is a 1-based index in the total result set. BookmarkIndex cannot be used with the BookmarkObject parameter. | |
| Specifies the object in the result set where the displayed results start
BookmarkObject cannot be used with the BookmarkIndex parameter. | |
| Requires an expression that specifies the property value criteria for the messages that you want to display
The expression includes a property name that is followed by a comparison operator and value.
The following message properties are valid criteria for the Filter parameter: - DateReceived (The date that the message was received.)
- ExpirationTime (The time that a message will expire.)
- FromAddress (Simple Mail Transfer Protocol (SMTP) address of the sender of a message. This value is taken from MAIL FROM: in the message envelope.)
- Identity (An integer that represents a particular message and an optional server and queue identity.)
- InternetMessageId (The value of the Message-ID: header field. This property is expressed as a GUID followed by the SMTP address of the sending server, as in this example: 67D7543D6103DC4FBEBA6BC7205DACABA61231@exchange.contoso.com.)
- LastError (A text string of the last error recorded for a message.)
- MessageSourceName (A text string of the name of the component that submitted this message to the queue.)
- Queue (The identity of the queue that holds the message. Enter the queue identity in the form of Server\destination, where destination is a remote domain, mailbox server, or persistent queue name.)
- RetryCount (The number of times the delivery of a message to a destination is tried.)
- SCL (The spam confidence level of the message. Valid SCL entries are integers 0 through 9. An empty SCL property value indicates that the message hasn't been processed by the Content Filter agent.)
- Size (The size of a message.)
- SourceIP (The IP address of the external server that submits the message to the Exchange organization.)
- Status (The current message status. Message status options are Active, Retry, Suspended, PendingSuspend, or PendingRemove.)
- Subject (A text string that represents the e-mail subject. The value is taken from the Subject: header field. You can specify multiple filter criteria by using the "-"and comparison operator. Property values that are not expressed as a single integer must be enclosed in quotation marks.
| |
| Specifies the MessageIdentity integer
This integer represents a particular message and an optional server and queue identity.
The syntax for this parameter can be specified as follows: - Server\QueueIdentity\MessageIdentity
- QueueIdentity\MessageIdentity
- Server*\MessageIdentity
- MessageIdentity
| |
| Specifies whether to include the bookmark object when the query results are displayed
It is valid when it is used with the BookmarkObject or BookmarkIndex parameters. If you do not specify a value for the IncludeBookmark parameter, the default value of true is used. | |
| Specifies the identity of the queue that contains the messages that you want to display
Enter the queue identity in the form of Server\destination, where destination is a remote domain, mailbox server, or persistent queue name. | |
| Specifies the total number of items to display in the result set
The default ResultSize parameter value is set to 1,000. ResultSize supports an unlimited number of results, but Microsoft Exchange limits the result set to 250,000. | |
| Used to return information about the total number of results and the index of the first object of the current page
It is a hidden parameter and the default value is*false.* | |
| Specifies whether to search forward or backward in the result set
The default value is true. This value causes the result page to be calculated forward from either the start of the result set or forward from a bookmark if specified. | |
| Specifies the name of the server to connect to by using Remote Procedure Call (RPC) that contains the queues that hold the messages you want to display
Enter the Server parameter as a host name or a fully qualified domain name (FQDN). If this parameter is not used, the local server is queried. | |
| Specifies an array of message properties that are used to control the sort order of the result set
Separate each property by using a comma. Append + symbol to the beginning of the property name to display the results in ascending order. Append - symbol to the beginning of the property name to display the results in descending order. If you do not specify a sort order, the result set is displayed in ascending order by MessageIdentity integer. | |
