Skip to content

Get Mail Domain

workmail_get_mail_domain R Documentation

Description

Gets details for a mail domain, including domain records required to configure your domain with recommended security.

Usage

workmail_get_mail_domain(OrganizationId, DomainName)

Arguments

OrganizationId

[required] The WorkMail organization for which the domain is retrieved.

DomainName

[required] The domain from which you want to retrieve details.

Value

A list with the following syntax:

list(
  Records = list(
    list(
      Type = "string",
      Hostname = "string",
      Value = "string"
    )
  ),
  IsTestDomain = TRUE|FALSE,
  IsDefault = TRUE|FALSE,
  OwnershipVerificationStatus = "PENDING"|"VERIFIED"|"FAILED",
  DkimVerificationStatus = "PENDING"|"VERIFIED"|"FAILED"
)

Request syntax

svc$get_mail_domain(
  OrganizationId = "string",
  DomainName = "string"
)