Product
Introducing Ruby Support in Socket
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
@maxim_mazurok/gapi.client.gmailpostmastertools-v1beta1
Advanced tools
TypeScript typings for Gmail Postmaster Tools API v1beta1
The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently. For detailed description please check documentation.
Install typings for Gmail Postmaster Tools API:
npm install @types/gapi.client.gmailpostmastertools-v1beta1 --save-dev
You need to initialize Google API client in your code:
gapi.load('client', () => {
// now we can use gapi.client
// ...
});
Then load api client wrapper:
gapi.client.load(
'https://gmailpostmastertools.googleapis.com/$discovery/rest?version=v1beta1',
() => {
// now we can use:
// gapi.client.gmailpostmastertools
}
);
// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('gmailpostmastertools', 'v1beta1', () => {
// now we can use:
// gapi.client.gmailpostmastertools
});
Don't forget to authenticate your client before sending any request to resources:
// declare client_id registered in Google Developers Console
var client_id = '',
scope = [
// See email traffic metrics for the domains you have registered in Gmail Postmaster Tools
'https://www.googleapis.com/auth/postmaster.readonly',
],
immediate = true;
// ...
gapi.auth.authorize(
{client_id: client_id, scope: scope, immediate: immediate},
authResult => {
if (authResult && !authResult.error) {
/* handle successful authorization */
} else {
/* handle authorization error */
}
}
);
After that you can use Gmail Postmaster Tools API resources:
/*
Gets a specific domain registered by the client. Returns NOT_FOUND if the domain does not exist.
*/
await gapi.client.gmailpostmastertools.domains.get({name: 'name'});
/*
Lists the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list.
*/
await gapi.client.gmailpostmastertools.domains.list({});
FAQs
TypeScript typings for Gmail Postmaster Tools API v1beta1
We found that @maxim_mazurok/gapi.client.gmailpostmastertools-v1beta1 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.