@mxraven/admin - v2.1.0
    Preparing search index...

    Class Domain

    A tenant domain and its DNS verification state.

    A domain must be verified and then granted to a submission listener through its sending-domain policy before it can send. Reads return a snapshot; call Domain.reload for fresh state.

    const domain = await ws.domains().create("example.com");
    if (!domain.dkimVerified) {
      await domain.replace("dmarc@example.com");
    }
    for await (const grant of await domain.listenerGrants()) {
      console.log(grant.listenerDisplayName);
    }

    Hierarchy (View Summary)

    Index
    constructor
    client path
    data dkimActiveSelector dkimVerified dmarcReportAddress dmarcVerified dnsLastCheckedAt domainName id isDeleted requiredCustomerRecords sendingEnabled spfVerified status tenantId verificationToken
    delete listenerGrants reload replace
    client: AdminClient

    The client used to issue requests for this entity.

    path: string

    The client-relative path of this resource.

    • get data(): D

      The raw wire record backing this entity.

      Returns D

    • get dkimActiveSelector(): string

      The active DKIM selector.

      Returns string

    • get dkimVerified(): boolean

      Whether DKIM is verified.

      Returns boolean

    • get dmarcReportAddress(): string | null | undefined

      The optional DMARC aggregate report mailbox.

      Returns string | null | undefined

    • get dmarcVerified(): boolean

      Whether DMARC is verified.

      Returns boolean

    • get dnsLastCheckedAt(): string | null | undefined

      The timestamp of the last DNS check.

      Returns string | null | undefined

    • get isDeleted(): boolean

      Whether this entity has been deleted through this instance.

      Local state only; not authoritative server state.

      Returns boolean

    • get sendingEnabled(): boolean

      Whether outbound sending is enabled.

      Returns boolean

    • get spfVerified(): boolean

      Whether SPF is verified.

      Returns boolean

    • get tenantId(): string

      The owning tenant identifier.

      Returns string

    • get verificationToken(): string

      The DNS ownership verification token.

      Returns string

    • Deletes this resource.

      Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

      Returns Promise<boolean>

      true once the resource has been deleted through this instance.

      ApiException When the control plane returns a non-success status.

    • Re-fetches this domain and returns a fresh snapshot.

      Parameters

      Returns Promise<Domain>

      A fresh domain snapshot.

      NotFoundException When the domain is no longer visible.

    • Replaces the writable domain configuration.

      Parameters

      • dmarcReportAddress: string | null

        The DMARC report address, or null to clear it.

      • Optionaloptions: RequestOptions

        Optional cancellation signal.

      Returns Promise<Domain>

      The updated domain.

      ValidationException When the address is invalid.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods