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

load ./chilkat.dll

set success 0

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

set oauth2 [new_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
CkOAuth2_put_AppCallbackUrl $oauth2 "https://yourwebserver.com/oauth_redirect"
CkOAuth2_put_ListenPort $oauth2 3017

CkOAuth2_put_AuthorizationEndpoint $oauth2 "https://api.login.yahoo.com/oauth2/request_auth"
CkOAuth2_put_TokenEndpoint $oauth2 "https://api.login.yahoo.com/oauth2/get_token"

#  Replace these with actual values.
CkOAuth2_put_ClientId $oauth2 "CLIENT_ID"
CkOAuth2_put_ClientSecret $oauth2 "CLIENT_SECRET"

#  Do not send the "scope" query param for Yahoo OAuth2.
CkOAuth2_put_UncommonOptions $oauth2 "NO_OAUTH2_SCOPE"

#  Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
set url [CkOAuth2_startAuth $oauth2]
if {[CkOAuth2_get_LastMethodSuccess $oauth2] == 0} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

puts "url = $url"

#  Launch the default browser on the system and navigate to the url.
#  The LaunchBrowser method was added in Chilkat v10.1.2.
set success [CkOAuth2_LaunchBrowser $oauth2 $url]
if {$success == 0} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

#  Wait for the user to approve or deny authorization in the browser.
set numMsWaited 0
while {expr [$numMsWaited < 90000]  &&  [[CkOAuth2_get_AuthFlowState $oauth2] < 3]} {
    CkOAuth2_SleepMs $oauth2 100
    set numMsWaited [expr $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 {[CkOAuth2_get_AuthFlowState $oauth2] < 3} then {
    CkOAuth2_Cancel $oauth2
    puts "No response from the browser!"
    delete_CkOAuth2 $oauth2
    exit
}

#  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 {[CkOAuth2_get_AuthFlowState $oauth2] == 5} then {
    puts "OAuth2 failed to complete."
    puts [CkOAuth2_failureInfo $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

if {[CkOAuth2_get_AuthFlowState $oauth2] == 4} then {
    puts "OAuth2 authorization was denied."
    puts [CkOAuth2_accessTokenResponse $oauth2]
    delete_CkOAuth2 $oauth2
    exit
}

if {[CkOAuth2_get_AuthFlowState $oauth2] != 3} then {
    puts "Unexpected AuthFlowState:[CkOAuth2_get_AuthFlowState $oauth2]"
    delete_CkOAuth2 $oauth2
    exit
}

#  Save the full JSON access token response to a file.
set sbJson [new_CkStringBuilder]

CkStringBuilder_Append $sbJson [CkOAuth2_accessTokenResponse $oauth2]
CkStringBuilder_WriteFile $sbJson "qa_data/tokens/yahooMail.json" "utf-8" 0

#  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"
#  }

puts "OAuth2 authorization granted!"
puts "Access Token: [CkOAuth2_accessToken $oauth2]"

delete_CkOAuth2 $oauth2
delete_CkStringBuilder $sbJson