Gmail IMAP: Refresh an OAuth2 Token
See more GMail SMTP/IMAP/POP Examples
Refresh a Gmail access token without opening a browser. Use the same OAuth client and the offline refresh token saved during initial authorization. A refreshed token can authenticate SMTP, IMAP, or POP3 for the authorized mailbox.
Google normally does not return another refresh token. The example retains the saved refresh token when omitted, accepts a replacement when provided, preserves the granted scope when omitted, and records the new access token's issue time and lifetime. A failed exchange leaves the old cache untouched. File writes are checked; production applications should use protected storage and serialize/atomically commit updates.
Access tokens normally last about an hour. Refresh ahead of expiry and reconnect long-lived protocol sessions when necessary. Refresh does not add scopes or restore a revoked grant. An invalid_grant response can require fresh user authorization; do not retry it indefinitely. External apps in Testing normally receive seven-day refresh tokens for this scope.
Gmail SMTP, IMAP, and POP3 use the https://mail.google.com/ OAuth scope. Narrower Gmail REST scopes such as gmail.send or gmail.readonly do not authorize these protocols. Public applications using this restricted scope must meet Google's verification requirements. See Gmail OAuth scopes and XOAUTH2.
Chilkat Objective-C Downloads
#import <CkoJsonObject.h>
#import <CkoOAuth2.h>
#import <CkoDateTime.h>
BOOL success = NO;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
CkoJsonObject *token = [[CkoJsonObject alloc] init];
success = [token LoadFile: @"gmail-mail-token.json"];
if (success != YES) {
NSLog(@"%@",@"Could not read gmail-mail-token.json from the private working directory.");
return;
}
if (([[token JsonTypeOf: @"refresh_token"] intValue] != 1) || ([token StringOfEquals: @"refresh_token" value: @"" caseSensitive: YES] == YES)) {
NSLog(@"%@",@"Authorize the account for offline access first.");
return;
}
CkoOAuth2 *oauth = [[CkoOAuth2 alloc] init];
oauth.TokenEndpoint = @"https://oauth2.googleapis.com/token";
oauth.ClientId = @"YOUR_DESKTOP_CLIENT_ID";
oauth.ClientSecret = @"YOUR_DESKTOP_CLIENT_SECRET";
oauth.RefreshToken = [token StringOf: @"refresh_token"];
success = [oauth RefreshAccessToken];
if (success != YES) {
NSLog(@"%@",@"Refresh failed. Check the OAuth client and grant. A revoked or expired grant requires fresh consent.");
return;
}
CkoJsonObject *fresh = [[CkoJsonObject alloc] init];
success = [fresh Load: oauth.AccessTokenResponse];
if (success != YES) {
NSLog(@"%@",@"Could not parse the refresh response.");
return;
}
if (([[fresh JsonTypeOf: @"access_token"] intValue] != 1) || ([fresh StringOfEquals: @"access_token" value: @"" caseSensitive: YES] == YES)) {
NSLog(@"%@",@"The refresh response did not contain an access token.");
return;
}
if (([[fresh JsonTypeOf: @"refresh_token"] intValue] != 1) || ([fresh StringOfEquals: @"refresh_token" value: @"" caseSensitive: YES] == YES)) {
[fresh UpdateString: @"refresh_token" value: [token StringOf: @"refresh_token"]];
}
if (([fresh HasMember: @"scope"] != YES) && ([[token JsonTypeOf: @"scope"] intValue] == 1)) {
[fresh UpdateString: @"scope" value: [token StringOf: @"scope"]];
}
// Google normally omits refresh_token on refresh. Keep the previous one in that case.
// Use the new expires_in, not the old response's expiration information.
CkoDateTime *obtained = [[CkoDateTime alloc] init];
[obtained SetFromCurrentSystemTime];
[fresh UpdateString: @"obtained_at" value: [obtained GetAsTimestamp: NO]];
success = [fresh WriteFile: @"gmail-mail-token.json"];
if (success != YES) {
NSLog(@"%@",@"Could not save the refreshed credentials.");
return;
}
NSLog(@"%@",@"Refreshed the access token.");