GetMyMessagesRequestType ( AbstractRequestType )

Retrieves information about the messages sent to a given user.

Call that uses GetMyMessagesRequestType:

GetMyMessages

Fields

AlertIDs ( MyMessagesAlertIDArrayType )

EndTime ( dateTime )

ExternalMessageIDs ( MyMessagesExternalMessageIDArrayType )

FolderID ( long )

IncludeHighPriorityMessageOnly ( boolean )

MessageIDs ( MyMessagesMessageIDArrayType )

Pagination ( PaginationType )

StartTime ( dateTime )

AlertIDs ( MyMessagesAlertIDArrayType ) [0..1]

Not used by any call.

This container is deprecated.

See the Field Index to learn which calls use AlertIDs.

EndTime ( dateTime ) [0..1]

The end of the date-range filter. See StartTime (which is the beginning of the date-range filter).

See the Field Index to learn which calls use EndTime.

ExternalMessageIDs ( MyMessagesExternalMessageIDArrayType ) [0..1]

This field is currently available on the US site. A container for IDs that uniquely identify messages for a given user. If provided at the time of message creation, this ID can be used to retrieve messages and will take precedence over message ID.

See the Field Index to learn which calls use ExternalMessageIDs.

FolderID ( long ) [0..1]

A unique identifier for a My Messages folder. If a FolderID value is provided, only messages from the specified folder are returned in the response.

See the Field Index to learn which calls use FolderID.

IncludeHighPriorityMessageOnly ( boolean ) [0..1]

If this field is included in the request and set to true, only High Priority messages are returned in the response.

See the Field Index to learn which calls use IncludeHighPriorityMessageOnly.

MessageIDs ( MyMessagesMessageIDArrayType ) [0..1]

This container can be used to retrieve one or more specific messages identified with their unique MessageID values. Up to 10 MessageID values can be specified with one call.

See the Field Index to learn which calls use MessageIDs.

Pagination ( PaginationType ) [0..1]

Specifies how to create virtual pages in the returned list (such as total number of entries and total number of pages to return). Default value for EntriesPerPage with GetMyMessages is 25.

See the Field Index to learn which calls use Pagination.

StartTime ( dateTime ) [0..1]

The beginning of the date-range filter. Filtering takes into account the entire timestamp of when messages were sent. Messages expire after one year.

See the Field Index to learn which calls use StartTime.