Mail Web Service

Prev — FlagMessages

GetMessageRawHeader — Next

GetMessage

GetMessage fetches the content of the specified messages and puts them in the appropriate folder.

Scopes

Read Full: Yahoo! Mail
Read/Write: Yahoo! Mail

Parameters

Name	Description
`truncateAt`	Number of bytes to begin truncation of message.
`fid`	Fid. Folder ID.
`mid`	List of message ids (deprecated).
`message`	List of MidRequest objects which includes message ID and security parameters.
`charsetHint`	Specifies the character set of the message

Returns

Name	Description
`total`	Total number of messages fetched.
`folder`	FolderData
`message`	List of Message. Only text/plain/HTML parts are populated with full message content (text).
`code`	ErrorCode

Example

Request

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
                   xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" 
                   xmlns:xsd="http://www.w3.org/1999/XMLSchema" 
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <SOAP-ENV:Body>
    <m:GetMessage xmlns:m="urn:yahoo:ymws">
      <fid>Inbox</fid>
      <message>
        <mid>1_326196_AIzJjkQAALMcRQlr7QE89VmzZIQ</mid>
        <enableWarnings>true</enableWarnings>
        <expandCIDReferences>true</expandCIDReferences>
      </message>
      <message>
        <mid>1_10615_AHPPjkQAANyjROs4vQW+byTLSnY</mid>
        <enableWarnings>true</enableWarnings>
        <expandCIDReferences>true</expandCIDReferences>
      </message>
      <message>
        <mid>1_12161_AH/PjkQAATjCROKQ3A3FGSkEl+U</mid>
        <enableWarnings>true</enableWarnings>
        <expandCIDReferences>true</expandCIDReferences>
      </message>
      <truncateAt>1024000</truncateAt>
      <transform-markup>remove-javascript</transform-markup>
    </m:GetMessage>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Body>
      <GetMessageResponse>
        <total>1</total>
        <folder unread="441" total="492" size="10101880" isSystem="true">
          <folderInfo fid="Inbox" name="Inbox"/>
        </folder>
        <message>
          <mid>1_326196_AIzJjkQAALMcRQlr7QE89VmzZIQ</mid>
          <receivedDate>1158245354</receivedDate>
          <subject>AAdvantage eSummary for Sept 06</subject>
          <from>
            <name>AADVANTAGE</name>
            <email>esummary@aadvantage.info.aa.com</email>
          </from>
          <replyto>
            <name>AADVANTAGE</name>
            <email>esummary@aadvantage.info.aa.com</email>
          </replyto>
          <to>
            <name></name>
            <email>SMITH@YAHOO.COM</email>
          </to>
          <domainkey>false</domainkey>
          <part partId="HEADER" 
                type="X-unknown" 
                subtype="" 
                typeParams=""
                disposition="" 
                dispParams="" 
                encoding="7bit" 
                filename=""         
                size="1174" 
                isTruncated="true" 
                contentId=""         
                referencedInline="false"/>
          <part partId="TEXT" 
                type="text" 
                subtype="html"         
                typeParams="charset=ISO-8859-1" 
                disposition="" 
                dispParams=""         
                encoding="7bit" 
                filename="" 
                size="34474" 
                isTruncated="true"         
                contentId="" 
                referencedInline="false">
          <text>incoming mail message text</text>
        </part>
        </message>
      </GetMessageResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>