JavaScript

OAuth2 for a GMail using a P12 Service Account Key

See more GMail REST API Examples

Demonstrates how to use GMail with OAuth2 for a service account within a Google Workspace Account where your email domain is custom (e.g., @yourcompany.com).

Note: This example does not work for Personal Google Accounts where the email domain is @gmail.com

JavaScript

var success = false;

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

var http = new CkHttp();

// --------------------------------------------------------------------------------
// For a step-by-step guide for setting up your Google Workspace service account,
// see Setup Google Workspace Account for Sending SMTP GMail from a Service Account
// --------------------------------------------------------------------------------
// Begin by loading your Google service account key (.p12)
var cert = new CkCert();
success = cert.LoadPfxFile("c:/someDirectory/keys/chilkat25-cbd7b42afbd8.p12","notasecret");
if (success !== true) {
    console.log(cert.LastErrorText);
    return;
}

// The ISS is your service account email address ending in gserviceaccount.com.
var iss = "chilkatsvc@chilkat25.iam.gserviceaccount.com";

// The scope is always the following string:
var scope = "https://mail.google.com/";

// The sub is your company email address
var oauth_sub = "bob@yourcompany.com";

// The access token is valid for this number of seconds.
var numSec = 3600;

var accessToken = http.G_SvcOauthAccessToken(iss,scope,oauth_sub,numSec,cert);
if (http.LastMethodSuccess !== true) {
    console.log(http.LastErrorText);
    return;
}
else {
    console.log("access token: " + accessToken);
}

// The access token allows us to send unlimited emails while it's valid. Once it expires, we must obtain and use a new one.

// -----------------------------------------------------------------------
var mailman = new CkMailMan();

// Set the properties for the GMail SMTP server:
mailman.SmtpHost = "smtp.gmail.com";
mailman.SmtpPort = 587;
mailman.StartTLS = true;

mailman.SmtpUsername = "bob@yourcompany.com";
mailman.OAuth2AccessToken = accessToken;

// Create a new email object
var email = new CkEmail();

email.Subject = "This is a test";
email.Body = "This is a test";
email.From = "Bob <bob@yourcompany.com>";
success = email.AddTo("Recipient","recipient@example.com");
// To add more recipients, call AddTo, AddCC, or AddBcc once per recipient.

success = mailman.SendEmail(email);
if (success !== true) {
    console.log(mailman.LastErrorText);
    return;
}

success = mailman.CloseSmtpConnection();
if (success !== true) {
    console.log("Connection to SMTP server not closed cleanly.");
}

console.log("Successfully sent email using Gmail with a service account key.");