/AWS1/CL_SE2GETEMAILIDRESPONSE¶
Details about an email identity.
CONSTRUCTOR
¶
IMPORTING¶
Optional arguments:¶
iv_identitytype
TYPE /AWS1/SE2IDENTITYTYPE
/AWS1/SE2IDENTITYTYPE
¶
The email identity type. Note: the
MANAGED_DOMAIN
identity type is not supported.
iv_feedbackforwardingstatus
TYPE /AWS1/SE2ENABLED
/AWS1/SE2ENABLED
¶
The feedback forwarding configuration for the identity.
If the value is
true
, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in theReturn-Path
header of the original email.You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
iv_verifiedforsendingstatus
TYPE /AWS1/SE2ENABLED
/AWS1/SE2ENABLED
¶
Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
io_dkimattributes
TYPE REF TO /AWS1/CL_SE2DKIMATTRIBUTES
/AWS1/CL_SE2DKIMATTRIBUTES
¶
An object that contains information about the DKIM attributes for the identity.
io_mailfromattributes
TYPE REF TO /AWS1/CL_SE2MAILFROMATTRIBUTES
/AWS1/CL_SE2MAILFROMATTRIBUTES
¶
An object that contains information about the Mail-From attributes for the email identity.
it_policies
TYPE /AWS1/CL_SE2POLICYMAP_W=>TT_POLICYMAP
TT_POLICYMAP
¶
A map of policy names to policies.
it_tags
TYPE /AWS1/CL_SE2TAG=>TT_TAGLIST
TT_TAGLIST
¶
An array of objects that define the tags (keys and values) that are associated with the email identity.
iv_configurationsetname
TYPE /AWS1/SE2CONFIGURATIONSETNAME
/AWS1/SE2CONFIGURATIONSETNAME
¶
The configuration set used by default when sending from this identity.
iv_verificationstatus
TYPE /AWS1/SE2VERIFICATIONSTATUS
/AWS1/SE2VERIFICATIONSTATUS
¶
The verification status of the identity. The status can be one of the following:
PENDING
– The verification process was initiated, but Amazon SES hasn't yet been able to verify the identity.
SUCCESS
– The verification process completed successfully.
FAILED
– The verification process failed.
TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES from determining the verification status of the identity.
NOT_STARTED
– The verification process hasn't been initiated for the identity.
io_verificationinfo
TYPE REF TO /AWS1/CL_SE2VERIFICATIONINFO
/AWS1/CL_SE2VERIFICATIONINFO
¶
An object that contains additional information about the verification status for the identity.
Queryable Attributes¶
IdentityType¶
The email identity type. Note: the
MANAGED_DOMAIN
identity type is not supported.
Accessible with the following methods¶
Method | Description |
---|---|
GET_IDENTITYTYPE() |
Getter for IDENTITYTYPE, with configurable default |
ASK_IDENTITYTYPE() |
Getter for IDENTITYTYPE w/ exceptions if field has no value |
HAS_IDENTITYTYPE() |
Determine if IDENTITYTYPE has a value |
FeedbackForwardingStatus¶
The feedback forwarding configuration for the identity.
If the value is
true
, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in theReturn-Path
header of the original email.You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
Accessible with the following methods¶
Method | Description |
---|---|
GET_FEEDBACKFORWARDINGSTATUS() |
Getter for FEEDBACKFORWARDINGSTATUS |
VerifiedForSendingStatus¶
Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.
Accessible with the following methods¶
Method | Description |
---|---|
GET_VERIFIEDFORSENDINGSTATUS() |
Getter for VERIFIEDFORSENDINGSTATUS |
DkimAttributes¶
An object that contains information about the DKIM attributes for the identity.
Accessible with the following methods¶
Method | Description |
---|---|
GET_DKIMATTRIBUTES() |
Getter for DKIMATTRIBUTES |
MailFromAttributes¶
An object that contains information about the Mail-From attributes for the email identity.
Accessible with the following methods¶
Method | Description |
---|---|
GET_MAILFROMATTRIBUTES() |
Getter for MAILFROMATTRIBUTES |
Policies¶
A map of policy names to policies.
Accessible with the following methods¶
Method | Description |
---|---|
GET_POLICIES() |
Getter for POLICIES, with configurable default |
ASK_POLICIES() |
Getter for POLICIES w/ exceptions if field has no value |
HAS_POLICIES() |
Determine if POLICIES has a value |
Tags¶
An array of objects that define the tags (keys and values) that are associated with the email identity.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
ConfigurationSetName¶
The configuration set used by default when sending from this identity.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CONFIGURATIONSETNAME() |
Getter for CONFIGURATIONSETNAME, with configurable default |
ASK_CONFIGURATIONSETNAME() |
Getter for CONFIGURATIONSETNAME w/ exceptions if field has n |
HAS_CONFIGURATIONSETNAME() |
Determine if CONFIGURATIONSETNAME has a value |
VerificationStatus¶
The verification status of the identity. The status can be one of the following:
PENDING
– The verification process was initiated, but Amazon SES hasn't yet been able to verify the identity.
SUCCESS
– The verification process completed successfully.
FAILED
– The verification process failed.
TEMPORARY_FAILURE
– A temporary issue is preventing Amazon SES from determining the verification status of the identity.
NOT_STARTED
– The verification process hasn't been initiated for the identity.
Accessible with the following methods¶
Method | Description |
---|---|
GET_VERIFICATIONSTATUS() |
Getter for VERIFICATIONSTATUS, with configurable default |
ASK_VERIFICATIONSTATUS() |
Getter for VERIFICATIONSTATUS w/ exceptions if field has no |
HAS_VERIFICATIONSTATUS() |
Determine if VERIFICATIONSTATUS has a value |
VerificationInfo¶
An object that contains additional information about the verification status for the identity.
Accessible with the following methods¶
Method | Description |
---|---|
GET_VERIFICATIONINFO() |
Getter for VERIFICATIONINFO |