GCP.GmailPostmasterTools reference

Domain

Source: src/GCP/GmailPostmasterTools/Domain.ts

A Gmail Postmaster Tools domain.

Domains have no labels or description, so identity is the FQDN and list / nuke returns names whose first label starts with alchemy-. There is nothing mutable beyond identity except optional DNS verification. Changing domainId replaces the domain.

Domain: Creating a Domain

Generated domain

const domain = yield* GCP.GmailPostmasterTools.Domain("Mail", {});

Explicit domain

const domain = yield* GCP.GmailPostmasterTools.Domain("Mail", {
  domainId: "mail.example.com",
});

Domain: Verifying a Domain

const domain = yield* GCP.GmailPostmasterTools.Domain("Mail", {
  domainId: "mail.example.com",
  verificationMethod: "TXT",
});

DomainsUser

Source: src/GCP/GmailPostmasterTools/DomainsUser.ts

A Gmail Postmaster Tools domain user.

Users have no labels or description, so identity is (parent, userId) and list / nuke returns rows whose email local-part starts with alchemy-. Permission updates in place (READER / ADMIN). Changing parent or email replaces the user.

DomainsUser: Creating a User

Generated email

const user = yield* GCP.GmailPostmasterTools.DomainsUser("Ada", {
  parent: domain.name,
});

Explicit email and permission

const user = yield* GCP.GmailPostmasterTools.DomainsUser("Ada", {
  parent: domain.name,
  userId: "ada@example.com",
  permission: "ADMIN",
});

DomainsUser: Updating a User

Change props on the same logical id; the engine keeps the physical id.

const user = yield* GCP.GmailPostmasterTools.DomainsUser("Ada", {
  parent: domain.name,
  userId: "ada@example.com",
  permission: "READER",
});