Java Requires Chilkat v10.1.2+

Yahoo Mail OAuth2 Access Token for Desktop App

See more Yahoo Mail Examples

Demonstrates how to get a Yahoo Email OAuth2 access token from a desktop application or script. Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.OAuth2;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // First, you must define your app in Yahoo Developer (https://developer.yahoo.com/apps/) like this:

        // 

        // This example requires the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        OAuth2 oauth2 = new OAuth2();

        // Your applicaton must use your own public web server as an intermediate
        // to receive and forward the redirect to localhost.
        // See Using Your Web Server as an Intermediary for OAuth2 Redirect to localhost
        oauth2.setAppCallbackUrl("https://yourwebserver.com/oauth_redirect");
        oauth2.setListenPort(3017);

        oauth2.setAuthorizationEndpoint("https://api.login.yahoo.com/oauth2/request_auth");
        oauth2.setTokenEndpoint("https://api.login.yahoo.com/oauth2/get_token");

        // Replace these with actual values.
        oauth2.setClientId("CLIENT_ID");
        oauth2.setClientSecret("CLIENT_SECRET");

        // Do not send the "scope" query param for Yahoo OAuth2.
        oauth2.setUncommonOptions("NO_OAUTH2_SCOPE");

        // Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
        String url;
        try {
            url = oauth2.startAuth();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        System.out.println("url = " + url);

        // Launch the default browser on the system and navigate to the url.
        // The LaunchBrowser method was added in Chilkat v10.1.2.
        try {
            oauth2.launchBrowser(url);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Wait for the user to approve or deny authorization in the browser.
        int numMsWaited = 0;
        while ((numMsWaited < 90000) && (oauth2.getAuthFlowState() < 3)) {
            oauth2.sleepMs(100);
            numMsWaited = numMsWaited + 100;
        }

        // If the browser does not respond within the specified time, AuthFlowState will be:
        //
        // 1: Waiting for Redirect - The OAuth2 background thread is waiting for the browser's redirect request.
        // 2: Waiting for Final Response - The thread is awaiting the final access token response.
        // In either case, cancel the background task initiated by StartAuth.

        if (oauth2.getAuthFlowState() < 3) {
            oauth2.cancel();
            System.out.println("No response from the browser!");
            return;
        }

        // Check AuthFlowState to determine if authorization was granted, denied, or failed:
        //
        // 3: Success - OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
        // 4: Access Denied - OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
        // 5: Failure - OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.

        if (oauth2.getAuthFlowState() == 5) {
            System.out.println("OAuth2 failed to complete.");
            System.out.println(oauth2.getFailureInfo());
            return;
        }

        if (oauth2.getAuthFlowState() == 4) {
            System.out.println("OAuth2 authorization was denied.");
            System.out.println(oauth2.getAccessTokenResponse());
            return;
        }

        if (oauth2.getAuthFlowState() != 3) {
            System.out.println("Unexpected AuthFlowState:" + oauth2.getAuthFlowState());
            return;
        }

        // Save the full JSON access token response to a file.
        StringBuilder sbJson = new StringBuilder();
        sbJson.append(oauth2.getAccessTokenResponse());
        sbJson.writeFile("qa_data/tokens/yahooMail.json", "utf-8", false);

        // The saved JSON response looks like this:

        // {
        //   "access_token": "kCVQdnOdul...LHucA--",
        //   "refresh_token": "AIenVXETSo0jklFBVkPS8vVm8E.Ej9ToRG.xDbDYmZ65WIs5t6CZhDrD",
        //   "expires_in": 3600,
        //   "token_type": "bearer",
        //   "xoauth_yahoo_guid": "HGDQCVF5JB4YDOWHITQJFBHCWA"
        // }

        System.out.println("OAuth2 authorization granted!");
        System.out.println("Access Token: " + oauth2.getAccessToken());
    }
}