Dart 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. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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.

  final oauth2 = CkOAuth2();

  // 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.appCallbackUrl = 'https://yourwebserver.com/oauth_redirect';
  oauth2.listenPort = 3017;

  oauth2.authorizationEndpoint = 'https://api.login.yahoo.com/oauth2/request_auth';
  oauth2.tokenEndpoint = 'https://api.login.yahoo.com/oauth2/get_token';

  // Replace these with actual values.
  oauth2.clientId = 'CLIENT_ID';
  oauth2.clientSecret = 'CLIENT_SECRET';

  // Do not send the "scope" query param for Yahoo OAuth2.
  oauth2.uncommonOptions = 'NO_OAUTH2_SCOPE';

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

  print('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);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Wait for the user to approve or deny authorization in the browser.
  var numMsWaited = 0;
  while ((numMsWaited < 90000) && (oauth2.authFlowState < 3)) {
    oauth2.sleepMs(100);
    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.authFlowState < 3) {
    oauth2.cancel();
    print('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.authFlowState == 5) {
    print('OAuth2 failed to complete.');
    print(oauth2.failureInfo);
    return;
  }

  if (oauth2.authFlowState == 4) {
    print('OAuth2 authorization was denied.');
    print(oauth2.accessTokenResponse);
    return;
  }

  if (oauth2.authFlowState != 3) {
    print('Unexpected AuthFlowState:${oauth2.authFlowState}');
    return;
  }

  // Save the full JSON access token response to a file.
  final sbJson = CkStringBuilder();
  sbJson.append(oauth2.accessTokenResponse);
  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"
  // }

  print('OAuth2 authorization granted!');
  print('Access Token: ${oauth2.accessToken}');
}