Home | Index

Yahoo! Mail Web Service User Guide and API Reference

Yahoo! Mail Web Service User Guide and API Reference

  1. You must use the Browser Based Authentication API to enable access to the user's Yahoo! account through your Application.

  2. You may not use the Yahoo! Mail Web Service API to mine or scrape user data from the user's Yahoo! account.

  3. You may not use the Yahoo! Mail Web Service API to recreate a mimicked version of Yahoo! Mail on your site.

  4. You may not use the Yahoo! Mail Web Service API to display the user's Yahoo! account information in a third party email client.

Abstract

The Yahoo! Mail Web Service gives developers access to APIs for Yahoo! Mail. With the Yahoo! Mail Web Service APIs, you can build Web applications to perform tasks such as listing messages, displaying folders, and composing and sending messages.


Table of Contents

1. Getting Started
Credential the User
Construct the SOAP Client
Determine the User's Account Capabilities
Account Types
Calling GetUserData
Make Subsequent Calls
Link Directly to a Message
Composing a New Message
Going Directly to a Message
Batch Calls
Batch Call Chaining
Passing Data
2. Endpoints
SOAP Endpoint
SOAP Sample Request
SOAP Sample Response
JSON-RPC Endpoint
JSON-RPC Sample Request
JSON-RPC Sample Response
3. Methods
BatchExecute
Parameters
Returns
Examples
Request
Sample Response
CreateFolder
Parameters
Returns
Examples
Request
Response
DeleteMessages
Parameters
Returns
Examples
Request
Response
DownloadAttachment
Endpoints
Parameters
Error Codes
Examples
Request
Response HTTP header
EmptyFolder
Parameters
Returns
Examples
Request
Response
FetchExternalMail
Parameters
Returns
Examples
Request
Response
FlagMessages
Parameters
Returns
Example
Request
Response
GetMessage
Parameters
Returns
Example
Request
Response
GetMessageRawHeader
Parameters
Returns
Example
Request
Response
GetUserData
Returns
Example
Request
Response
ListFolders
Parameters
Returns
Example
Request
Response
ListMessages
Parameters
Returns
Example
Request
Response
ListMessagesFromIds
Parameters
Returns
MoveMessages
Parameters
Returns
Example
Request
Response
RemoveFolder
Parameters
Returns
Example
Request
Response
RenameFolder
Parameters
Returns
ResetSpamFilter
Parameters
Returns
SaveMessage
Parameters
Returns
Example
Request
Response
SaveRawMessage
Parameters
Returns
SearchMessages
Parameters
Returns
Example
Request
Response
SendMessage
Parameters
Returns
Example
Request
Response
SetUserData
Parameters
UploadAttachment
Endpoint
Parameters
Returns
Error Codes (Upload related)
Error Codes (Virus related)
Example
Example Output
Example XML Response
4. Data Types
Address
Alias
AllAliases
AllDisposableAddress
AllExternalAccounts
AttachmentInfo
BatchCall
BatchResponse
BlockedAddresses
ComposeAddress
ComposeMessage
ComposeMessagePart
DisposableAddress
ErrorCode
ErrorResponse
ExternalAccount
ExternalAccountAlias
FetchResult
Fid
Flag
FolderData
Header
InboxServices
MessageInfo
Message
MessagePart
MidRequest
SaveMessageDestination
SaveMessagePart
SearchInfo
SearchAttachmentInfo
SearchQuery
SetBlockedAddresses
SetData
SetFeaturePref
SetFlag
SetUIPref
SetSendPref
SetSpamPref
SetSwitches
SetVacationPref
SimpleMessagePart
SimpleMessageBody
Switches
UserData
UserFeaturePref
UserPopPref
UserSendPref
UserSpamPref
UserUIPref
UserVacationPref
5. Enumerations
DateType
FetchStatus
GroupBy
ImageBlockOption (Security Option)
IncludeMsgOnReply
MidLocationRes
OffsetType
RichTextSignature
SearchAttachmentType
SearchDateCheck
SortKey
SearchMatchMode
SortOrder
SearchSizeCheck
SearchRcptMode
SearchType
SearchWordBounds
ShowCcBcc
UseRichText
UnknownContactAction