GmailPostmasterTools

import { GmailPostmasterTools } from "https://googleapis.deno.dev/v1/gmailpostmastertools:v2.ts";

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.

class GmailPostmasterTools {

constructor(client?: CredentialsClient, baseUrl?: string);

async domainsDomainStatsQuery(parent: string, req: QueryDomainStatsRequest): Promise<QueryDomainStatsResponse>;

async domainsGet(name: string): Promise<Domain>;

async domainsGetComplianceStatus(name: string): Promise<DomainComplianceStatus>;

async domainsList(opts?: DomainsListOptions): Promise<ListDomainsResponse>;

async domainStatsBatchQuery(req: BatchQueryDomainStatsRequest): Promise<BatchQueryDomainStatsResponse>;

}

§Constructors

new GmailPostmasterTools(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

domainsDomainStatsQuery(parent: string, req: QueryDomainStatsRequest): Promise<QueryDomainStatsResponse>

[src]

Retrieves a list of domain statistics for a given domain and time period. Returns statistics only for dates where data is available. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for the domain.

@param parent

Required. The parent resource name where the stats are queried. Format: domains/{domain}

domainsGet(name: string): Promise<Domain>

[src]

Retrieves detailed information about a domain registered by you. Returns NOT_FOUND if the domain is not registered by you. Domain represents the metadata of a domain that has been registered within the system and linked to a user.

@param name

Required. The resource name of the domain. Format: domains/{domain_name}, where domain_name is the fully qualified domain name (i.e., mymail.mydomain.com).

domainsGetComplianceStatus(name: string): Promise<DomainComplianceStatus>

[src]

Retrieves the compliance status for a given domain. Returns PERMISSION_DENIED if you don't have permission to access compliance status for the domain.

@param name

Required. The resource name of the domain's compliance status to retrieve. Format: domains/{domain_id}/complianceStatus.

domainsList(opts?: DomainsListOptions): Promise<ListDomainsResponse>

[src]

Retrieves a list of all domains registered by you, along with their corresponding metadata. The order of domains in the response is unspecified and non-deterministic. Newly registered domains will not necessarily be added to the end of this list.

domainStatsBatchQuery(req: BatchQueryDomainStatsRequest): Promise<BatchQueryDomainStatsResponse>

[src]

Executes a batch of QueryDomainStats requests for multiple domains. Returns PERMISSION_DENIED if you don't have permission to access DomainStats for any of the requested domains.