The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
eBay-API-0.25
River stage zero No dependents
++
/ eBay::API::XML::DataType::MyMessagesMessageType

NAME

eBay::API::XML::DataType::MyMessagesMessageType

DESCRIPTION

Contains the message information for each message specified in MessageIDs. The amount and type of information returned varies based on the requested detail level.

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::MyMessagesMessageType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setContent()

The message body. Plain text. Returned only for messages created after late August 2008. The API does not currently check the user email format preferences that can be specified in My Messages on the eBay.com Web site.

# Argument: 'xs:string'

getContent()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnMessages

# Returns: 'xs:string'

setContentType()

The content type of the body text. The three acceptable values are "TEXT", "HTML", and "XML" (case sensitive).

# Argument: 'xs:string'

getContentType()

# Returns: 'xs:string'

setCreationDate()

The date and time that a message was created by the sender.

# Argument: 'xs:dateTime'

getCreationDate()

# Returns: 'xs:dateTime'

setExpirationDate()

The date and time at which a message expires.

# Argument: 'xs:dateTime'

getExpirationDate()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'xs:dateTime'

setExternalMessageID()

An ID used by an external application to uniquely identify a message. Returned only when specified by the external application on message creation. <br /><br /> This value is equivalent to the value used for MessageID in GetMemberMessages.

# Argument: 'xs:string'

getExternalMessageID()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'xs:string'

setFlagged()

Whether or not a message has been flagged.

# Argument: 'xs:boolean'

isFlagged()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'xs:boolean'

setFolder()

Details relating to a My Messages folder.

# Argument: 'ns:MyMessagesFolderType'

getFolder()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'ns:MyMessagesFolderType'

setForwardDetails()

Details relating to the forwarding of an alert or message. Only returned if the alert or message is forwarded.

# Argument: 'ns:MyMessagesForwardDetailsType'

getForwardDetails()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'ns:MyMessagesForwardDetailsType'

setItemID()

A unique eBay Item ID associated with a message.

# Argument: 'ns:ItemIDType'

getItemID()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders
  MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)

# Returns: 'ns:ItemIDType'

setListingStatus()

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. <br><br> <span class="tablenote"><b>Note:</b> Starting in late August 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. </span>

# Argument: 'ns:ListingStatusCodeType'

getListingStatus()

  Calls: GetMyMessages
  Returned: Conditionally
  TagStatus: ComingSoon

# Returns: 'ns:ListingStatusCodeType'

setMessageID()

An ID that uniquely identifies a message for a given user. <br/> <br/> This value is not the same as the value used for the GetMemberMessages MessageID. Use the GetMemberMessages value (used as the GetMyMessages ExternalID) instead.

# Argument: 'ns:MyMessagesMessageIDType'

getMessageID()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'ns:MyMessagesMessageIDType'

setMessageType()

Specifies the type of message being retrieved through GetMyMessages.

# Argument: 'ns:MessageTypeCodeType'

getMessageType()

  Calls: GetMyMessages
  Returned: Conditionally

# Returns: 'ns:MessageTypeCodeType'

setQuestionType()

Specifies the context of the question and it corresponds to the subject of the message. This is returned only if Messages.Message.MessageType is AskSellerQuestion. <br><br> <span class="tablenote"><b>Note:</b> This tag will be returned with data starting late August 2008. As of early July 2008, this tag is not returned for the Sandbox environment. </span>

# Argument: 'ns:QuestionTypeCodeType'

getQuestionType()

  Calls: GetMyMessages
  Returned: Conditionally
  TagStatus: ComingSoon

# Returns: 'ns:QuestionTypeCodeType'

setRead()

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.

# Argument: 'xs:boolean'

isRead()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'xs:boolean'

setReceiveDate()

The date and time that a message was received by My Messages and stored in a database for the recipient.

# Argument: 'xs:dateTime'

getReceiveDate()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'xs:dateTime'

setRecipientUserID()

The displayable user ID of the recipient.

# Argument: 'xs:string'

getRecipientUserID()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'xs:string'

setResponseDetails()

Details relating to the response to an alert or message.

# Argument: 'ns:MyMessagesResponseDetailsType'

getResponseDetails()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'ns:MyMessagesResponseDetailsType'

setSendToName()

The displayable name of the user or eBay application to which the message is sent. Only returned for M2M, and if a value exists.

# Argument: 'xs:string'

getSendToName()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'xs:string'

setSender()

The display name of the eBay user that sent the message.

# Argument: 'xs:string'

getSender()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'xs:string'

setSubject()

The subject of the message.

# Argument: 'xs:string'

getSubject()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnHeaders, ReturnMessages

# Returns: 'xs:string'

setText()

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.

# Argument: 'xs:string'

getText()

  Calls: GetMyMessages
  Returned: Conditionally
  Details: DetailLevel: ReturnMessages

# Returns: 'xs:string'