Chapter 1. Getting Started

This section will help you to quickly get your application set up for using the Yahoo! Mail APIs.

In order to use the Yahoo! Mail Web Service[YMWS] APIs, the first step is to register your application with YDN. Click "Get an App Key" to get the Consumer and Secret keys. These keys are used to get the necessary access to your user's data using OAuth. You can also select scopes when registering your project. This guide assumes you already know how to get started with OAuth. See the Yahoo! OAuth Quick Start Guide for more information.

Prerequisites

Before you start developing your application, you will need the following:

  • An OAuth library for your preferred language. Refer to the OAuth site for more information.
  • PHP with cURL support from the command-line. The cURL library must be compiled with SSL.
  • A JSON or SOAP library for your preferred language. We recommend using JSON. SOAP endpoint has been deprecated and will be supported till April 2012. All applications using Yahoo Mail Webservices should use its JSON endpoint.
  • OAuth Consumer and Secret Keys from https://developer.apps.yahoo.com/dashboard/createKey.html.

Note

Yahoo! Business Mail or Yahoo! Japan Mail accounts are not supported.

BBAuth will be supported for existing users. Developers are advised to port their application to support OAuth.

Table of Contents