MyMessagesMessageType

Types that use MyMessagesMessageType:

Call that uses one or more fields of MyMessagesMessageType:

Fields

Content ( string )
ContentType
CreationDate
ExpirationDate ( dateTime )
ExternalMessageID ( string )
Flagged ( boolean )
Folder ( MyMessagesFolderType )
ForwardDetails ( MyMessagesForwardDetailsType )
ItemID ( ItemIDType (string) )
ListingStatus ( ListingStatusCodeType )
MessageID ( MyMessagesMessageIDType (string) )
MessageType ( MessageTypeCodeType )
QuestionType ( QuestionTypeCodeType )
Read ( boolean )
ReceiveDate ( dateTime )
RecipientUserID ( string )
ResponseDetails ( MyMessagesResponseDetailsType )
Sender ( string )
SendToName ( string )
Subject ( string )
Text ( string )

Content ( string ) [0..1]
The message body. Plain text. Returned only for messages created after September 2008 activation. The API does not currently check the user email format preferences that can be specified in My Messages on the eBay.com Web site.
See the Field Index to learn which calls use Content.

ContentType
Not used by any call.

CreationDate
Not used by any call.

ExpirationDate ( dateTime ) [0..1]
The date and time at which a message expires.
See the Field Index to learn which calls use ExpirationDate.

ExternalMessageID ( string ) [0..1]
An ID used by an external application to uniquely identify a message. Returned only when specified by the external application on message creation.

This value is equivalent to the value used for MessageID in GetMemberMessages.
See the Field Index to learn which calls use ExternalMessageID.

Flagged ( boolean ) [0..1]
Whether or not a message has been flagged.
See the Field Index to learn which calls use Flagged.

Folder ( MyMessagesFolderType ) [0..1]
Details relating to a My Messages folder.
See the Field Index to learn which calls use Folder.

ForwardDetails ( MyMessagesForwardDetailsType ) [0..1]
Details relating to the forwarding of an alert or message. Only returned if the alert or message is forwarded.
See the Field Index to learn which calls use ForwardDetails.

ItemID ( ItemIDType (string) ) [0..1]
A unique eBay Item ID associated with a message.
See the Field Index to learn which calls use ItemID.

ListingStatus ( see ListingStatusCodeType for possible values ) [0..1]
Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing.

Note: Starting in September 2008, for the GetMyMessages call the listing status reflects the status of the listing at the time the question was created. The listing status for this call may not match the listing status returned by other calls such as GetItemTransactions. This is returned only if Messages.Message.MessageType is AskSellerQuestion. As of early July 2008, this tag is not returned for the Sandbox environment.
See the Field Index to learn which calls use ListingStatus.

MessageID ( MyMessagesMessageIDType (string) ) [0..1]
An ID that uniquely identifies a message for a given user.

This value is not the same as the value used for the GetMemberMessages MessageID. Use the GetMemberMessages value (used as the GetMyMessages ExternalID) instead.
See the Field Index to learn which calls use MessageID.

MessageType ( see MessageTypeCodeType for possible values ) [0..1]
Specifies the type of message being retrieved through GetMyMessages.
See the Field Index to learn which calls use MessageType.

QuestionType ( see QuestionTypeCodeType for possible values ) [0..1]
Specifies the context of the question. Corresponds to the message subject. Applies if Messages.Message.MessageType is AskSellerQuestion.

Note: This tag will be returned with data starting in September 2008. As of early July 2008, this tag is not returned for the Sandbox environment.
See the Field Index to learn which calls use QuestionType.

Read ( boolean ) [0..1]
Whether or not a message has been viewed by a given user. Note that retrieving a message with the API does not mark it as read.
See the Field Index to learn which calls use Read.

ReceiveDate ( dateTime ) [0..1]
The date and time that a message was received by My Messages and stored in a database for the recipient.
See the Field Index to learn which calls use ReceiveDate.

RecipientUserID ( string ) [0..1]
The displayable user ID of the recipient.
See the Field Index to learn which calls use RecipientUserID.

ResponseDetails ( MyMessagesResponseDetailsType ) [0..1]
Details relating to the response to an alert or message.
See the Field Index to learn which calls use ResponseDetails.

Sender ( string ) [0..1]
The display name of the eBay user that sent the message.
See the Field Index to learn which calls use Sender.

SendToName ( string ) [0..1]
The displayable name of the user or eBay application to which the message is sent. Only returned for M2M, and if a value exists.
See the Field Index to learn which calls use SendToName.

Subject ( string ) [0..1]
The subject of the message.
See the Field Index to learn which calls use Subject.

Text ( string ) [0..1]
The message body. This can be either plain text or HTML, depending on which format the message was originally written in. Note that the API does not currently check the user email format preferences that can be specified in My Messages on the eBay.com Web site.
See the Field Index to learn which calls use Text.

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

© 2005–2008 eBay, Inc. All rights reserved.