MailSlurp logo

Connect Google Postmaster to domain monitoring

Documentation navigation
Search documentation

Authorize Google Postmaster access and inspect domain snapshots and traffic statistics alongside domain checks.

View MarkdownAgent setup

Google Postmaster data adds available Gmail sender signals to your domain-monitoring investigation. Connect a Google account that can access the sending domain in Postmaster Tools, then review its available snapshots alongside DNS checks and inbox placement.

Connect your account

  1. Open the Google Postmaster connection in MailSlurp's domain-monitoring area.
  2. Start the Google authorization flow with the account that has access to your domain.
  3. Complete the authorization and return to MailSlurp.
  4. Check connection status and synchronize the domains.
  5. Select the domain and synchronize its traffic statistics for the period you are investigating.

For a custom integration, create a connection URL, follow the returned OAuth flow and exchange the authorization code using the documented redirect configuration. Keep OAuth credentials and tokens on your server.

POST /domain-monitor/postmaster/connect

Create Postmaster OAuth connection URL

Request, parameters, and responses

Request body (required)

FieldTypeRequiredDescription
redirectBasestringNo
redirectUristringNo
emailAddressstringNo
statestringNo
Request example
{
  "redirectBase": "value",
  "redirectUri": "value",
  "emailAddress": "user@example.com",
  "state": "value"
}

Responses

StatusSchemaDescription
201CreatePostmasterConnectionResultCreated
HTTP and SDK snippets

HTTP

HTTP
POST /domain-monitor/postmaster/connect HTTP/1.1
Host: api.mailslurp.com
x-api-key: YOUR_API_KEY
Accept: application/json
Content-Type: application/json

{
  "redirectBase": "value",
  "redirectUri": "value",
  "emailAddress": "user@example.com",
  "state": "value"
}

cURL

cURL
curl -X POST "https://api.mailslurp.com/domain-monitor/postmaster/connect" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{"redirectBase":"value","redirectUri":"value","emailAddress":"user@example.com","state":"value"}'

JavaScript SDK

JavaScript SDK
import { Configuration, DomainMonitorPostmasterControllerApi } from "mailslurp-client";

const config = new Configuration({ apiKey: "YOUR_API_KEY" });
const domainMonitorPostmasterController = new DomainMonitorPostmasterControllerApi(config);
const request = {
  "createPostmasterConnectionOptions": {
    "redirectBase": "value",
    "redirectUri": "value",
    "emailAddress": "user@example.com",
    "state": "value"
  }
};

const result = await domainMonitorPostmasterController.createDomainMonitorPostmasterConnection(request);

Python SDK

Python SDK
import mailslurp_client
from mailslurp_client.api.domain_monitor_postmaster_controller_api import DomainMonitorPostmasterControllerApi

configuration = mailslurp_client.Configuration()
configuration.api_key["x-api-key"] = "YOUR_API_KEY"

with mailslurp_client.ApiClient(configuration) as api_client:
    domainMonitorPostmasterController = DomainMonitorPostmasterControllerApi(api_client)
    create_postmaster_connection_options = {
      "redirectBase": "value",
      "redirectUri": "value",
      "emailAddress": "user@example.com",
      "state": "value"
    }
    result = domainMonitorPostmasterController.create_domain_monitor_postmaster_connection(create_postmaster_connection_options)
POST /domain-monitor/postmaster/oauth-exchange

Exchange Postmaster OAuth authorization code

Request, parameters, and responses

Request body (required)

FieldTypeRequiredDescription
authorizationCodestringYes
redirectUristringYes
statestringYes
Request example
{
  "authorizationCode": "value",
  "redirectUri": "value",
  "state": "value"
}

Responses

StatusSchemaDescription
201PostmasterConnectionDtoCreated
HTTP and SDK snippets

HTTP

HTTP
POST /domain-monitor/postmaster/oauth-exchange HTTP/1.1
Host: api.mailslurp.com
x-api-key: YOUR_API_KEY
Accept: application/json
Content-Type: application/json

{
  "authorizationCode": "value",
  "redirectUri": "value",
  "state": "value"
}

cURL

cURL
curl -X POST "https://api.mailslurp.com/domain-monitor/postmaster/oauth-exchange" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{"authorizationCode":"value","redirectUri":"value","state":"value"}'

JavaScript SDK

JavaScript SDK
import { Configuration, DomainMonitorPostmasterControllerApi } from "mailslurp-client";

const config = new Configuration({ apiKey: "YOUR_API_KEY" });
const domainMonitorPostmasterController = new DomainMonitorPostmasterControllerApi(config);
const request = {
  "exchangePostmasterCodeOptions": {
    "authorizationCode": "value",
    "redirectUri": "value",
    "state": "value"
  }
};

const result = await domainMonitorPostmasterController.exchangeDomainMonitorPostmasterCode(request);

Python SDK

Python SDK
import mailslurp_client
from mailslurp_client.api.domain_monitor_postmaster_controller_api import DomainMonitorPostmasterControllerApi

configuration = mailslurp_client.Configuration()
configuration.api_key["x-api-key"] = "YOUR_API_KEY"

with mailslurp_client.ApiClient(configuration) as api_client:
    domainMonitorPostmasterController = DomainMonitorPostmasterControllerApi(api_client)
    exchange_postmaster_code_options = {
      "authorizationCode": "value",
      "redirectUri": "value",
      "state": "value"
    }
    result = domainMonitorPostmasterController.exchange_domain_monitor_postmaster_code(exchange_postmaster_code_options)
GET /domain-monitor/postmaster/connection

Get Postmaster connection status

Request, parameters, and responses

Responses

StatusSchemaDescription
200PostmasterConnectionStatusDtoOK
HTTP and SDK snippets

HTTP

HTTP
GET /domain-monitor/postmaster/connection HTTP/1.1
Host: api.mailslurp.com
x-api-key: YOUR_API_KEY
Accept: application/json

cURL

cURL
curl -X GET "https://api.mailslurp.com/domain-monitor/postmaster/connection" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

JavaScript SDK

JavaScript SDK
import { Configuration, DomainMonitorPostmasterControllerApi } from "mailslurp-client";

const config = new Configuration({ apiKey: "YOUR_API_KEY" });
const domainMonitorPostmasterController = new DomainMonitorPostmasterControllerApi(config);

const result = await domainMonitorPostmasterController.getDomainMonitorPostmasterConnection();

Python SDK

Python SDK
import mailslurp_client
from mailslurp_client.api.domain_monitor_postmaster_controller_api import DomainMonitorPostmasterControllerApi

configuration = mailslurp_client.Configuration()
configuration.api_key["x-api-key"] = "YOUR_API_KEY"

with mailslurp_client.ApiClient(configuration) as api_client:
    domainMonitorPostmasterController = DomainMonitorPostmasterControllerApi(api_client)
    result = domainMonitorPostmasterController.get_domain_monitor_postmaster_connection()

Synchronize and read statistics

Synchronization and reading are separate operations: the read endpoints return local snapshots. Check timestamps before treating a result as current.

POST /domain-monitor/postmaster/domains/sync

Sync Postmaster domains

Request, parameters, and responses

Responses

StatusSchemaDescription
200PostmasterDomainDto[]OK
HTTP and SDK snippets

HTTP

HTTP
POST /domain-monitor/postmaster/domains/sync HTTP/1.1
Host: api.mailslurp.com
x-api-key: YOUR_API_KEY
Accept: application/json

cURL

cURL
curl -X POST "https://api.mailslurp.com/domain-monitor/postmaster/domains/sync" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

JavaScript SDK

JavaScript SDK
import { Configuration, DomainMonitorPostmasterControllerApi } from "mailslurp-client";

const config = new Configuration({ apiKey: "YOUR_API_KEY" });
const domainMonitorPostmasterController = new DomainMonitorPostmasterControllerApi(config);

const result = await domainMonitorPostmasterController.syncDomainMonitorPostmasterDomains();

Python SDK

Python SDK
import mailslurp_client
from mailslurp_client.api.domain_monitor_postmaster_controller_api import DomainMonitorPostmasterControllerApi

configuration = mailslurp_client.Configuration()
configuration.api_key["x-api-key"] = "YOUR_API_KEY"

with mailslurp_client.ApiClient(configuration) as api_client:
    domainMonitorPostmasterController = DomainMonitorPostmasterControllerApi(api_client)
    result = domainMonitorPostmasterController.sync_domain_monitor_postmaster_domains()
GET /domain-monitor/postmaster/domains

List local Postmaster domain snapshots

Request, parameters, and responses

Responses

StatusSchemaDescription
200PostmasterDomainDto[]OK
HTTP and SDK snippets

HTTP

HTTP
GET /domain-monitor/postmaster/domains HTTP/1.1
Host: api.mailslurp.com
x-api-key: YOUR_API_KEY
Accept: application/json

cURL

cURL
curl -X GET "https://api.mailslurp.com/domain-monitor/postmaster/domains" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

JavaScript SDK

JavaScript SDK
import { Configuration, DomainMonitorPostmasterControllerApi } from "mailslurp-client";

const config = new Configuration({ apiKey: "YOUR_API_KEY" });
const domainMonitorPostmasterController = new DomainMonitorPostmasterControllerApi(config);

const result = await domainMonitorPostmasterController.getDomainMonitorPostmasterDomains();

Python SDK

Python SDK
import mailslurp_client
from mailslurp_client.api.domain_monitor_postmaster_controller_api import DomainMonitorPostmasterControllerApi

configuration = mailslurp_client.Configuration()
configuration.api_key["x-api-key"] = "YOUR_API_KEY"

with mailslurp_client.ApiClient(configuration) as api_client:
    domainMonitorPostmasterController = DomainMonitorPostmasterControllerApi(api_client)
    result = domainMonitorPostmasterController.get_domain_monitor_postmaster_domains()
POST /domain-monitor/postmaster/domains/{domain}/traffic-stats/sync

Sync Postmaster traffic stats

Request, parameters, and responses

Path parameters

NameTypeRequiredDescription
domainstringYes

Query parameters

NameTypeRequiredDescription
startDatestring:dateNo
endDatestring:dateNo

Responses

StatusSchemaDescription
200PostmasterTrafficStatsListDtoOK
HTTP and SDK snippets

HTTP

HTTP
POST /domain-monitor/postmaster/domains/value/traffic-stats/sync?startDate=value&endDate=value HTTP/1.1
Host: api.mailslurp.com
x-api-key: YOUR_API_KEY
Accept: application/json

cURL

cURL
curl -X POST "https://api.mailslurp.com/domain-monitor/postmaster/domains/value/traffic-stats/sync?startDate=value&endDate=value" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

JavaScript SDK

JavaScript SDK
import { Configuration, DomainMonitorPostmasterControllerApi } from "mailslurp-client";

const config = new Configuration({ apiKey: "YOUR_API_KEY" });
const domainMonitorPostmasterController = new DomainMonitorPostmasterControllerApi(config);
const request = {
  "domain": "value",
  "startDate": "value",
  "endDate": "value"
};

const result = await domainMonitorPostmasterController.syncDomainMonitorPostmasterTrafficStats(request);

Python SDK

Python SDK
import mailslurp_client
from mailslurp_client.api.domain_monitor_postmaster_controller_api import DomainMonitorPostmasterControllerApi

configuration = mailslurp_client.Configuration()
configuration.api_key["x-api-key"] = "YOUR_API_KEY"

with mailslurp_client.ApiClient(configuration) as api_client:
    domainMonitorPostmasterController = DomainMonitorPostmasterControllerApi(api_client)
    result = domainMonitorPostmasterController.sync_domain_monitor_postmaster_traffic_stats("value", start_date="value", end_date="value")
GET /domain-monitor/postmaster/domains/{domain}/traffic-stats

Get local Postmaster traffic stats

Request, parameters, and responses

Path parameters

NameTypeRequiredDescription
domainstringYes

Query parameters

NameTypeRequiredDescription
startDatestring:dateNo
endDatestring:dateNo

Responses

StatusSchemaDescription
200PostmasterTrafficStatsListDtoOK
HTTP and SDK snippets

HTTP

HTTP
GET /domain-monitor/postmaster/domains/value/traffic-stats?startDate=value&endDate=value HTTP/1.1
Host: api.mailslurp.com
x-api-key: YOUR_API_KEY
Accept: application/json

cURL

cURL
curl -X GET "https://api.mailslurp.com/domain-monitor/postmaster/domains/value/traffic-stats?startDate=value&endDate=value" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

JavaScript SDK

JavaScript SDK
import { Configuration, DomainMonitorPostmasterControllerApi } from "mailslurp-client";

const config = new Configuration({ apiKey: "YOUR_API_KEY" });
const domainMonitorPostmasterController = new DomainMonitorPostmasterControllerApi(config);
const request = {
  "domain": "value",
  "startDate": "value",
  "endDate": "value"
};

const result = await domainMonitorPostmasterController.getDomainMonitorPostmasterTrafficStats(request);

Python SDK

Python SDK
import mailslurp_client
from mailslurp_client.api.domain_monitor_postmaster_controller_api import DomainMonitorPostmasterControllerApi

configuration = mailslurp_client.Configuration()
configuration.api_key["x-api-key"] = "YOUR_API_KEY"

with mailslurp_client.ApiClient(configuration) as api_client:
    domainMonitorPostmasterController = DomainMonitorPostmasterControllerApi(api_client)
    result = domainMonitorPostmasterController.get_domain_monitor_postmaster_traffic_stats("value", start_date="value", end_date="value")

An empty domain list or missing day is not a healthy-sender verdict. Confirm the authorized account's domain access, connection state, requested period and last synchronization. Reporting availability can differ by domain and date; retain missing data as unknown.

Use the findings

Compare the same period across domain runs, placement tests and warmup activity. Change one sender variable at a time where practical and repeat the relevant test after a correction.

Disconnect the integration when the Google account should no longer provide data. Reconnect with an authorized account if credentials or access change.

DELETE /domain-monitor/postmaster/connection

Disconnect Postmaster OAuth

Request, parameters, and responses

Responses

StatusSchemaDescription
204ResponseNo Content
HTTP and SDK snippets

HTTP

HTTP
DELETE /domain-monitor/postmaster/connection HTTP/1.1
Host: api.mailslurp.com
x-api-key: YOUR_API_KEY
Accept: application/json

cURL

cURL
curl -X DELETE "https://api.mailslurp.com/domain-monitor/postmaster/connection" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

JavaScript SDK

JavaScript SDK
import { Configuration, DomainMonitorPostmasterControllerApi } from "mailslurp-client";

const config = new Configuration({ apiKey: "YOUR_API_KEY" });
const domainMonitorPostmasterController = new DomainMonitorPostmasterControllerApi(config);

const result = await domainMonitorPostmasterController.deleteDomainMonitorPostmasterConnection();

Python SDK

Python SDK
import mailslurp_client
from mailslurp_client.api.domain_monitor_postmaster_controller_api import DomainMonitorPostmasterControllerApi

configuration = mailslurp_client.Configuration()
configuration.api_key["x-api-key"] = "YOUR_API_KEY"

with mailslurp_client.ApiClient(configuration) as api_client:
    domainMonitorPostmasterController = DomainMonitorPostmasterControllerApi(api_client)
    result = domainMonitorPostmasterController.delete_domain_monitor_postmaster_connection()