Get Email Identity

pinpointemail_get_email_identity

R Documentation

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings

Description

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

Usage

pinpointemail_get_email_identity(EmailIdentity)

Arguments

EmailIdentity

[required] The email identity that you want to retrieve details for.

Value

A list with the following syntax:

list(
  IdentityType = "EMAIL_ADDRESS"|"DOMAIN"|"MANAGED_DOMAIN",
  FeedbackForwardingStatus = TRUE|FALSE,
  VerifiedForSendingStatus = TRUE|FALSE,
  DkimAttributes = list(
    SigningEnabled = TRUE|FALSE,
    Status = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE"|"NOT_STARTED",
    Tokens = list(
      "string"
    )
  ),
  MailFromAttributes = list(
    MailFromDomain = "string",
    MailFromDomainStatus = "PENDING"|"SUCCESS"|"FAILED"|"TEMPORARY_FAILURE",
    BehaviorOnMxFailure = "USE_DEFAULT_VALUE"|"REJECT_MESSAGE"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Request syntax

svc$get_email_identity(
  EmailIdentity = "string"
)