libZSservicesZSamazonka-sesv2ZSamazonka-sesv2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SESV2.Lens

Contents

Description

 
Synopsis

Operations

GetConfigurationSet

getConfigurationSetResponse_sendingOptions :: Lens' GetConfigurationSetResponse (Maybe SendingOptions) Source #

An object that defines whether or not Amazon SES can send email that you send using the configuration set.

getConfigurationSetResponse_deliveryOptions :: Lens' GetConfigurationSetResponse (Maybe DeliveryOptions) Source #

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

getConfigurationSetResponse_trackingOptions :: Lens' GetConfigurationSetResponse (Maybe TrackingOptions) Source #

An object that defines the open and click tracking options for emails that you send using the configuration set.

getConfigurationSetResponse_reputationOptions :: Lens' GetConfigurationSetResponse (Maybe ReputationOptions) Source #

An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

getConfigurationSetResponse_tags :: Lens' GetConfigurationSetResponse (Maybe [Tag]) Source #

An array of objects that define the tags (keys and values) that are associated with the configuration set.

getConfigurationSetResponse_suppressionOptions :: Lens' GetConfigurationSetResponse (Maybe SuppressionOptions) Source #

An object that contains information about the suppression list preferences for your account.

GetImportJob

getImportJob_jobId :: Lens' GetImportJob Text Source #

The ID of the import job.

getImportJobResponse_jobId :: Lens' GetImportJobResponse (Maybe Text) Source #

A string that represents the import job ID.

getImportJobResponse_completedTimestamp :: Lens' GetImportJobResponse (Maybe UTCTime) Source #

The time stamp of when the import job was completed.

getImportJobResponse_failedRecordsCount :: Lens' GetImportJobResponse (Maybe Int) Source #

The number of records that failed processing because of invalid input or other reasons.

getImportJobResponse_createdTimestamp :: Lens' GetImportJobResponse (Maybe UTCTime) Source #

The time stamp of when the import job was created.

PutConfigurationSetTrackingOptions

PutEmailIdentityDkimSigningAttributes

putEmailIdentityDkimSigningAttributes_signingAttributes :: Lens' PutEmailIdentityDkimSigningAttributes (Maybe DkimSigningAttributes) Source #

An object that contains information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.

putEmailIdentityDkimSigningAttributes_signingAttributesOrigin :: Lens' PutEmailIdentityDkimSigningAttributes DkimSigningAttributesOrigin Source #

The method to use to configure DKIM for the identity. There are the following possible values:

  • AWS_SES – Configure DKIM for the identity by using Easy DKIM.
  • EXTERNAL – Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).

putEmailIdentityDkimSigningAttributesResponse_dkimStatus :: Lens' PutEmailIdentityDkimSigningAttributesResponse (Maybe DkimStatus) Source #

The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.

If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that's paired with the private key that you specified in the process of creating the identity.

The status can be one of the following:

  • PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.
  • SUCCESS – The verification process completed successfully.
  • FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.
  • TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.
  • NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.

putEmailIdentityDkimSigningAttributesResponse_dkimTokens :: Lens' PutEmailIdentityDkimSigningAttributesResponse (Maybe [Text]) Source #

If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.

If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector that's associated with your public key.

Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.

PutEmailIdentityDkimAttributes

putEmailIdentityDkimAttributes_signingEnabled :: Lens' PutEmailIdentityDkimAttributes (Maybe Bool) Source #

Sets the DKIM signing configuration for the identity.

When you set this value true, then the messages that are sent from the identity are signed using DKIM. If you set this value to false, your messages are sent without DKIM signing.

PutConfigurationSetDeliveryOptions

putConfigurationSetDeliveryOptions_sendingPoolName :: Lens' PutConfigurationSetDeliveryOptions (Maybe Text) Source #

The name of the dedicated IP pool to associate with the configuration set.

putConfigurationSetDeliveryOptions_tlsPolicy :: Lens' PutConfigurationSetDeliveryOptions (Maybe TlsPolicy) Source #

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

putConfigurationSetDeliveryOptions_configurationSetName :: Lens' PutConfigurationSetDeliveryOptions Text Source #

The name of the configuration set to associate with a dedicated IP pool.

ListDedicatedIpPools

listDedicatedIpPools_nextToken :: Lens' ListDedicatedIpPools (Maybe Text) Source #

A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.

listDedicatedIpPools_pageSize :: Lens' ListDedicatedIpPools (Maybe Int) Source #

The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

listDedicatedIpPoolsResponse_dedicatedIpPools :: Lens' ListDedicatedIpPoolsResponse (Maybe [Text]) Source #

A list of all of the dedicated IP pools that are associated with your Amazon Web Services account in the current Region.

listDedicatedIpPoolsResponse_nextToken :: Lens' ListDedicatedIpPoolsResponse (Maybe Text) Source #

A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools, passing this token in the NextToken parameter.

GetDomainDeliverabilityCampaign

getDomainDeliverabilityCampaign_campaignId :: Lens' GetDomainDeliverabilityCampaign Text Source #

The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.

GetDedicatedIps

getDedicatedIps_poolName :: Lens' GetDedicatedIps (Maybe Text) Source #

The name of the IP pool that the dedicated IP address is associated with.

getDedicatedIps_nextToken :: Lens' GetDedicatedIps (Maybe Text) Source #

A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.

getDedicatedIps_pageSize :: Lens' GetDedicatedIps (Maybe Int) Source #

The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

getDedicatedIpsResponse_nextToken :: Lens' GetDedicatedIpsResponse (Maybe Text) Source #

A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.

getDedicatedIpsResponse_dedicatedIps :: Lens' GetDedicatedIpsResponse (Maybe [DedicatedIp]) Source #

A list of dedicated IP addresses that are associated with your Amazon Web Services account.

PutConfigurationSetSendingOptions

putConfigurationSetSendingOptions_sendingEnabled :: Lens' PutConfigurationSetSendingOptions (Maybe Bool) Source #

If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

putConfigurationSetSendingOptions_configurationSetName :: Lens' PutConfigurationSetSendingOptions Text Source #

The name of the configuration set to enable or disable email sending for.

DeleteCustomVerificationEmailTemplate

deleteCustomVerificationEmailTemplate_templateName :: Lens' DeleteCustomVerificationEmailTemplate Text Source #

The name of the custom verification email template that you want to delete.

UpdateCustomVerificationEmailTemplate

updateCustomVerificationEmailTemplate_templateName :: Lens' UpdateCustomVerificationEmailTemplate Text Source #

The name of the custom verification email template that you want to update.

updateCustomVerificationEmailTemplate_fromEmailAddress :: Lens' UpdateCustomVerificationEmailTemplate Text Source #

The email address that the custom verification email is sent from.

updateCustomVerificationEmailTemplate_templateContent :: Lens' UpdateCustomVerificationEmailTemplate Text Source #

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

updateCustomVerificationEmailTemplate_successRedirectionURL :: Lens' UpdateCustomVerificationEmailTemplate Text Source #

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

updateCustomVerificationEmailTemplate_failureRedirectionURL :: Lens' UpdateCustomVerificationEmailTemplate Text Source #

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

CreateDedicatedIpPool

createDedicatedIpPool_tags :: Lens' CreateDedicatedIpPool (Maybe [Tag]) Source #

An object that defines the tags (keys and values) that you want to associate with the pool.

SendCustomVerificationEmail

sendCustomVerificationEmail_configurationSetName :: Lens' SendCustomVerificationEmail (Maybe Text) Source #

Name of a configuration set to use when sending the verification email.

sendCustomVerificationEmail_templateName :: Lens' SendCustomVerificationEmail Text Source #

The name of the custom verification email template to use when sending the verification email.

sendCustomVerificationEmailResponse_messageId :: Lens' SendCustomVerificationEmailResponse (Maybe Text) Source #

The unique message identifier returned from the SendCustomVerificationEmail operation.

GetSuppressedDestination

getSuppressedDestination_emailAddress :: Lens' GetSuppressedDestination Text Source #

The email address that's on the account suppression list.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse [Tag] Source #

An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (Key) and an associated tag value (Value)

GetEmailTemplate

getEmailTemplateResponse_templateContent :: Lens' GetEmailTemplateResponse EmailTemplateContent Source #

The content of the email template, composed of a subject line, an HTML part, and a text-only part.

ListSuppressedDestinations

listSuppressedDestinations_reasons :: Lens' ListSuppressedDestinations (Maybe [SuppressionListReason]) Source #

The factors that caused the email address to be added to .

listSuppressedDestinations_endDate :: Lens' ListSuppressedDestinations (Maybe UTCTime) Source #

Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date. The date that you specify should be in Unix time format.

listSuppressedDestinations_startDate :: Lens' ListSuppressedDestinations (Maybe UTCTime) Source #

Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date. The date that you specify should be in Unix time format.

listSuppressedDestinations_nextToken :: Lens' ListSuppressedDestinations (Maybe Text) Source #

A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

listSuppressedDestinations_pageSize :: Lens' ListSuppressedDestinations (Maybe Int) Source #

The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

listSuppressedDestinationsResponse_nextToken :: Lens' ListSuppressedDestinationsResponse (Maybe Text) Source #

A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter.

PutEmailIdentityFeedbackAttributes

putEmailIdentityFeedbackAttributes_emailForwardingEnabled :: Lens' PutEmailIdentityFeedbackAttributes (Maybe Bool) Source #

Sets 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 the Return-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).

ListEmailTemplates

listEmailTemplates_nextToken :: Lens' ListEmailTemplates (Maybe Text) Source #

A token returned from a previous call to ListEmailTemplates to indicate the position in the list of email templates.

listEmailTemplates_pageSize :: Lens' ListEmailTemplates (Maybe Int) Source #

The number of results to show in a single call to ListEmailTemplates. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 1, and can be no more than 10.

listEmailTemplatesResponse_templatesMetadata :: Lens' ListEmailTemplatesResponse (Maybe [EmailTemplateMetadata]) Source #

An array the contains the name and creation time stamp for each template in your Amazon SES account.

listEmailTemplatesResponse_nextToken :: Lens' ListEmailTemplatesResponse (Maybe Text) Source #

A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent ListEmailTemplates call to retrieve the next 10 email templates.

PutConfigurationSetReputationOptions

putConfigurationSetReputationOptions_reputationMetricsEnabled :: Lens' PutConfigurationSetReputationOptions (Maybe Bool) Source #

If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

PutDedicatedIpInPool

putDedicatedIpInPool_ip :: Lens' PutDedicatedIpInPool Text Source #

The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Web Services account.

putDedicatedIpInPool_destinationPoolName :: Lens' PutDedicatedIpInPool Text Source #

The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.

CreateEmailTemplate

createEmailTemplate_templateContent :: Lens' CreateEmailTemplate EmailTemplateContent Source #

The content of the email template, composed of a subject line, an HTML part, and a text-only part.

PutAccountSendingAttributes

putAccountSendingAttributes_sendingEnabled :: Lens' PutAccountSendingAttributes (Maybe Bool) Source #

Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending.

If Amazon Web Services paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.

UpdateConfigurationSetEventDestination

updateConfigurationSetEventDestination_configurationSetName :: Lens' UpdateConfigurationSetEventDestination Text Source #

The name of the configuration set that contains the event destination to modify.

DeleteConfigurationSetEventDestination

deleteConfigurationSetEventDestination_configurationSetName :: Lens' DeleteConfigurationSetEventDestination Text Source #

The name of the configuration set that contains the event destination to delete.

ListConfigurationSets

listConfigurationSets_nextToken :: Lens' ListConfigurationSets (Maybe Text) Source #

A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

listConfigurationSets_pageSize :: Lens' ListConfigurationSets (Maybe Int) Source #

The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

listConfigurationSetsResponse_configurationSets :: Lens' ListConfigurationSetsResponse (Maybe [Text]) Source #

An array that contains all of the configuration sets in your Amazon SES account in the current Amazon Web Services Region.

listConfigurationSetsResponse_nextToken :: Lens' ListConfigurationSetsResponse (Maybe Text) Source #

A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.

DeleteEmailIdentity

deleteEmailIdentity_emailIdentity :: Lens' DeleteEmailIdentity Text Source #

The identity (that is, the email address or domain) to delete.

DeleteContactList

UpdateContactList

updateContactList_topics :: Lens' UpdateContactList (Maybe [Topic]) Source #

An interest group, theme, or label within a list. A contact list can have multiple topics.

updateContactList_description :: Lens' UpdateContactList (Maybe Text) Source #

A description of what the contact list is about.

ListImportJobs

listImportJobs_nextToken :: Lens' ListImportJobs (Maybe Text) Source #

A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ListImportJobs with the same parameters to retrieve the next page of import jobs.

listImportJobs_pageSize :: Lens' ListImportJobs (Maybe Int) Source #

Maximum number of import jobs to return at once. Use this parameter to paginate results. If additional import jobs exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional addresses.

listImportJobs_importDestinationType :: Lens' ListImportJobs (Maybe ImportDestinationType) Source #

The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType.

listImportJobsResponse_nextToken :: Lens' ListImportJobsResponse (Maybe Text) Source #

A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ListImportJobs with the same parameters to retrieve the next page of import jobs.

DeleteConfigurationSet

CreateEmailIdentity

createEmailIdentity_configurationSetName :: Lens' CreateEmailIdentity (Maybe Text) Source #

The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.

createEmailIdentity_dkimSigningAttributes :: Lens' CreateEmailIdentity (Maybe DkimSigningAttributes) Source #

If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM.

You can only specify this object if the email identity is a domain, as opposed to an address.

createEmailIdentity_tags :: Lens' CreateEmailIdentity (Maybe [Tag]) Source #

An array of objects that define the tags (keys and values) to associate with the email identity.

createEmailIdentity_emailIdentity :: Lens' CreateEmailIdentity Text Source #

The email address or domain to verify.

createEmailIdentityResponse_dkimAttributes :: Lens' CreateEmailIdentityResponse (Maybe DkimAttributes) Source #

An object that contains information about the DKIM attributes for the identity.

createEmailIdentityResponse_verifiedForSendingStatus :: Lens' CreateEmailIdentityResponse (Maybe Bool) Source #

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.

createEmailIdentityResponse_identityType :: Lens' CreateEmailIdentityResponse (Maybe IdentityType) Source #

The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.

GetBlacklistReports

getBlacklistReports_blacklistItemNames :: Lens' GetBlacklistReports [Text] Source #

A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon SES or Amazon Pinpoint.

getBlacklistReportsResponse_blacklistReport :: Lens' GetBlacklistReportsResponse (HashMap Text [BlacklistEntry]) Source #

An object that contains information about a blacklist that one of your dedicated IP addresses appears on.

CreateContactList

createContactList_topics :: Lens' CreateContactList (Maybe [Topic]) Source #

An interest group, theme, or label within a list. A contact list can have multiple topics.

createContactList_description :: Lens' CreateContactList (Maybe Text) Source #

A description of what the contact list is about.

createContactList_tags :: Lens' CreateContactList (Maybe [Tag]) Source #

The tags associated with a contact list.

ListEmailIdentities

listEmailIdentities_nextToken :: Lens' ListEmailIdentities (Maybe Text) Source #

A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.

listEmailIdentities_pageSize :: Lens' ListEmailIdentities (Maybe Int) Source #

The number of results to show in a single call to ListEmailIdentities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 0, and can be no more than 1000.

listEmailIdentitiesResponse_nextToken :: Lens' ListEmailIdentitiesResponse (Maybe Text) Source #

A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter.

listEmailIdentitiesResponse_emailIdentities :: Lens' ListEmailIdentitiesResponse (Maybe [IdentityInfo]) Source #

An array that includes all of the email identities associated with your Amazon Web Services account.

GetContact

getContact_contactListName :: Lens' GetContact Text Source #

The name of the contact list to which the contact belongs.

getContact_emailAddress :: Lens' GetContact Text Source #

The contact's email addres.

getContactResponse_unsubscribeAll :: Lens' GetContactResponse (Maybe Bool) Source #

A boolean value status noting if the contact is unsubscribed from all contact list topics.

getContactResponse_attributesData :: Lens' GetContactResponse (Maybe Text) Source #

The attribute data attached to a contact.

getContactResponse_topicDefaultPreferences :: Lens' GetContactResponse (Maybe [TopicPreference]) Source #

The default topic preferences applied to the contact.

getContactResponse_contactListName :: Lens' GetContactResponse (Maybe Text) Source #

The name of the contact list to which the contact belongs.

getContactResponse_createdTimestamp :: Lens' GetContactResponse (Maybe UTCTime) Source #

A timestamp noting when the contact was created.

getContactResponse_lastUpdatedTimestamp :: Lens' GetContactResponse (Maybe UTCTime) Source #

A timestamp noting the last time the contact's information was updated.

getContactResponse_topicPreferences :: Lens' GetContactResponse (Maybe [TopicPreference]) Source #

The contact's preference for being opted-in to or opted-out of a topic.>

DeleteContact

deleteContact_contactListName :: Lens' DeleteContact Text Source #

The name of the contact list from which the contact should be removed.

UpdateContact

updateContact_unsubscribeAll :: Lens' UpdateContact (Maybe Bool) Source #

A boolean value status noting if the contact is unsubscribed from all contact list topics.

updateContact_attributesData :: Lens' UpdateContact (Maybe Text) Source #

The attribute data attached to a contact.

updateContact_topicPreferences :: Lens' UpdateContact (Maybe [TopicPreference]) Source #

The contact's preference for being opted-in to or opted-out of a topic.

GetContactList

getContactListResponse_topics :: Lens' GetContactListResponse (Maybe [Topic]) Source #

An interest group, theme, or label within a list. A contact list can have multiple topics.

getContactListResponse_createdTimestamp :: Lens' GetContactListResponse (Maybe UTCTime) Source #

A timestamp noting when the contact list was created.

getContactListResponse_description :: Lens' GetContactListResponse (Maybe Text) Source #

A description of what the contact list is about.

getContactListResponse_tags :: Lens' GetContactListResponse (Maybe [Tag]) Source #

The tags associated with a contact list.

getContactListResponse_lastUpdatedTimestamp :: Lens' GetContactListResponse (Maybe UTCTime) Source #

A timestamp noting the last time the contact list was updated.

GetDedicatedIp

getDedicatedIp_ip :: Lens' GetDedicatedIp Text Source #

The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Web Services account.

getDedicatedIpResponse_dedicatedIp :: Lens' GetDedicatedIpResponse (Maybe DedicatedIp) Source #

An object that contains information about a dedicated IP address.

CreateContact

createContact_unsubscribeAll :: Lens' CreateContact (Maybe Bool) Source #

A boolean value status noting if the contact is unsubscribed from all contact list topics.

createContact_attributesData :: Lens' CreateContact (Maybe Text) Source #

The attribute data attached to a contact.

createContact_topicPreferences :: Lens' CreateContact (Maybe [TopicPreference]) Source #

The contact's preferences for being opted-in to or opted-out of topics.

createContact_contactListName :: Lens' CreateContact Text Source #

The name of the contact list to which the contact should be added.

GetEmailIdentity

getEmailIdentityResponse_dkimAttributes :: Lens' GetEmailIdentityResponse (Maybe DkimAttributes) Source #

An object that contains information about the DKIM attributes for the identity.

getEmailIdentityResponse_verifiedForSendingStatus :: Lens' GetEmailIdentityResponse (Maybe Bool) Source #

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.

getEmailIdentityResponse_configurationSetName :: Lens' GetEmailIdentityResponse (Maybe Text) Source #

The configuration set used by default when sending from this identity.

getEmailIdentityResponse_identityType :: Lens' GetEmailIdentityResponse (Maybe IdentityType) Source #

The email identity type. Note: the MANAGED_DOMAIN identity type is not supported.

getEmailIdentityResponse_mailFromAttributes :: Lens' GetEmailIdentityResponse (Maybe MailFromAttributes) Source #

An object that contains information about the Mail-From attributes for the email identity.

getEmailIdentityResponse_feedbackForwardingStatus :: Lens' GetEmailIdentityResponse (Maybe Bool) Source #

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 the Return-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).

getEmailIdentityResponse_tags :: Lens' GetEmailIdentityResponse (Maybe [Tag]) Source #

An array of objects that define the tags (keys and values) that are associated with the email identity.

GetConfigurationSetEventDestinations

getConfigurationSetEventDestinations_configurationSetName :: Lens' GetConfigurationSetEventDestinations Text Source #

The name of the configuration set that contains the event destination.

getConfigurationSetEventDestinationsResponse_eventDestinations :: Lens' GetConfigurationSetEventDestinationsResponse (Maybe [EventDestination]) Source #

An array that includes all of the events destinations that have been configured for the configuration set.

ListCustomVerificationEmailTemplates

listCustomVerificationEmailTemplates_nextToken :: Lens' ListCustomVerificationEmailTemplates (Maybe Text) Source #

A token returned from a previous call to ListCustomVerificationEmailTemplates to indicate the position in the list of custom verification email templates.

listCustomVerificationEmailTemplates_pageSize :: Lens' ListCustomVerificationEmailTemplates (Maybe Int) Source #

The number of results to show in a single call to ListCustomVerificationEmailTemplates. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 1, and can be no more than 50.

listCustomVerificationEmailTemplatesResponse_nextToken :: Lens' ListCustomVerificationEmailTemplatesResponse (Maybe Text) Source #

A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListCustomVerificationEmailTemplates to retrieve the next 50 custom verification email templates.

GetAccount

getAccountResponse_enforcementStatus :: Lens' GetAccountResponse (Maybe Text) Source #

The reputation status of your Amazon SES account. The status can be one of the following:

  • HEALTHY – There are no reputation-related issues that currently impact your account.
  • PROBATION – We've identified potential issues with your Amazon SES account. We're placing your account under review while you work on correcting these issues.
  • SHUTDOWN – Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed.

getAccountResponse_dedicatedIpAutoWarmupEnabled :: Lens' GetAccountResponse (Maybe Bool) Source #

Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.

getAccountResponse_sendQuota :: Lens' GetAccountResponse (Maybe SendQuota) Source #

An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region.

getAccountResponse_productionAccessEnabled :: Lens' GetAccountResponse (Maybe Bool) Source #

Indicates whether or not your account has production access in the current Amazon Web Services Region.

If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.

If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.

getAccountResponse_details :: Lens' GetAccountResponse (Maybe AccountDetails) Source #

An object that defines your account details.

getAccountResponse_suppressionAttributes :: Lens' GetAccountResponse (Maybe SuppressionAttributes) Source #

An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.

getAccountResponse_sendingEnabled :: Lens' GetAccountResponse (Maybe Bool) Source #

Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region.

DeleteDedicatedIpPool

deleteDedicatedIpPool_poolName :: Lens' DeleteDedicatedIpPool Text Source #

The name of the dedicated IP pool that you want to delete.

GetEmailIdentityPolicies

PutConfigurationSetSuppressionOptions

putConfigurationSetSuppressionOptions_suppressedReasons :: Lens' PutConfigurationSetSuppressionOptions (Maybe [SuppressionListReason]) Source #

A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:

  • COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.
  • BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

putConfigurationSetSuppressionOptions_configurationSetName :: Lens' PutConfigurationSetSuppressionOptions Text Source #

The name of the configuration set to change the suppression list preferences for.

CreateCustomVerificationEmailTemplate

createCustomVerificationEmailTemplate_fromEmailAddress :: Lens' CreateCustomVerificationEmailTemplate Text Source #

The email address that the custom verification email is sent from.

createCustomVerificationEmailTemplate_templateContent :: Lens' CreateCustomVerificationEmailTemplate Text Source #

The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

createCustomVerificationEmailTemplate_successRedirectionURL :: Lens' CreateCustomVerificationEmailTemplate Text Source #

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

createCustomVerificationEmailTemplate_failureRedirectionURL :: Lens' CreateCustomVerificationEmailTemplate Text Source #

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

PutAccountDetails

putAccountDetails_contactLanguage :: Lens' PutAccountDetails (Maybe ContactLanguage) Source #

The language you would prefer to be contacted with.

putAccountDetails_productionAccessEnabled :: Lens' PutAccountDetails (Maybe Bool) Source #

Indicates whether or not your account should have production access in the current Amazon Web Services Region.

If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.

If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.

putAccountDetails_additionalContactEmailAddresses :: Lens' PutAccountDetails (Maybe (NonEmpty Text)) Source #

Additional email addresses that you would like to be notified regarding Amazon SES matters.

putAccountDetails_mailType :: Lens' PutAccountDetails MailType Source #

The type of email your account will send.

putAccountDetails_websiteURL :: Lens' PutAccountDetails Text Source #

The URL of your website. This information helps us better understand the type of content that you plan to send.

putAccountDetails_useCaseDescription :: Lens' PutAccountDetails Text Source #

A description of the types of email that you plan to send.

DeleteSuppressedDestination

deleteSuppressedDestination_emailAddress :: Lens' DeleteSuppressedDestination Text Source #

The suppressed email destination to remove from the account suppression list.

PutSuppressedDestination

putSuppressedDestination_emailAddress :: Lens' PutSuppressedDestination Text Source #

The email address that should be added to the suppression list for your account.

putSuppressedDestination_reason :: Lens' PutSuppressedDestination SuppressionListReason Source #

The factors that should cause the email address to be added to the suppression list for your account.

GetDomainStatisticsReport

getDomainStatisticsReport_domain :: Lens' GetDomainStatisticsReport Text Source #

The domain that you want to obtain deliverability metrics for.

getDomainStatisticsReport_startDate :: Lens' GetDomainStatisticsReport UTCTime Source #

The first day (in Unix time) that you want to obtain domain deliverability metrics for.

getDomainStatisticsReport_endDate :: Lens' GetDomainStatisticsReport UTCTime Source #

The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.

getDomainStatisticsReportResponse_overallVolume :: Lens' GetDomainStatisticsReportResponse OverallVolume Source #

An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate.

getDomainStatisticsReportResponse_dailyVolumes :: Lens' GetDomainStatisticsReportResponse [DailyVolume] Source #

An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate.

DeleteEmailTemplate

deleteEmailTemplate_templateName :: Lens' DeleteEmailTemplate Text Source #

The name of the template to be deleted.

UpdateEmailTemplate

updateEmailTemplate_templateContent :: Lens' UpdateEmailTemplate EmailTemplateContent Source #

The content of the email template, composed of a subject line, an HTML part, and a text-only part.

GetDeliverabilityDashboardOptions

getDeliverabilityDashboardOptionsResponse_accountStatus :: Lens' GetDeliverabilityDashboardOptionsResponse (Maybe DeliverabilityDashboardAccountStatus) Source #

The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

getDeliverabilityDashboardOptionsResponse_subscriptionExpiryDate :: Lens' GetDeliverabilityDashboardOptionsResponse (Maybe UTCTime) Source #

The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.

getDeliverabilityDashboardOptionsResponse_activeSubscribedDomains :: Lens' GetDeliverabilityDashboardOptionsResponse (Maybe [DomainDeliverabilityTrackingOption]) Source #

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.

getDeliverabilityDashboardOptionsResponse_pendingExpirationSubscribedDomains :: Lens' GetDeliverabilityDashboardOptionsResponse (Maybe [DomainDeliverabilityTrackingOption]) Source #

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.

getDeliverabilityDashboardOptionsResponse_dashboardEnabled :: Lens' GetDeliverabilityDashboardOptionsResponse Bool Source #

Specifies whether the Deliverability dashboard is enabled. If this value is true, the dashboard is enabled.

GetCustomVerificationEmailTemplate

getCustomVerificationEmailTemplate_templateName :: Lens' GetCustomVerificationEmailTemplate Text Source #

The name of the custom verification email template that you want to retrieve.

getCustomVerificationEmailTemplateResponse_failureRedirectionURL :: Lens' GetCustomVerificationEmailTemplateResponse (Maybe Text) Source #

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

getCustomVerificationEmailTemplateResponse_successRedirectionURL :: Lens' GetCustomVerificationEmailTemplateResponse (Maybe Text) Source #

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

ListDomainDeliverabilityCampaigns

listDomainDeliverabilityCampaigns_nextToken :: Lens' ListDomainDeliverabilityCampaigns (Maybe Text) Source #

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

listDomainDeliverabilityCampaigns_pageSize :: Lens' ListDomainDeliverabilityCampaigns (Maybe Int) Source #

The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

listDomainDeliverabilityCampaigns_startDate :: Lens' ListDomainDeliverabilityCampaigns UTCTime Source #

The first day, in Unix time format, that you want to obtain deliverability data for.

listDomainDeliverabilityCampaigns_endDate :: Lens' ListDomainDeliverabilityCampaigns UTCTime Source #

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

listDomainDeliverabilityCampaignsResponse_nextToken :: Lens' ListDomainDeliverabilityCampaignsResponse (Maybe Text) Source #

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.

listDomainDeliverabilityCampaignsResponse_domainDeliverabilityCampaigns :: Lens' ListDomainDeliverabilityCampaignsResponse [DomainDeliverabilityCampaign] Source #

An array of responses, one for each campaign that used the domain to send email during the specified time range.

SendBulkEmail

sendBulkEmail_fromEmailAddress :: Lens' SendBulkEmail (Maybe Text) Source #

The email address to use as the "From" address for the email. The address that you specify has to be verified.

sendBulkEmail_fromEmailAddressIdentityArn :: Lens' SendBulkEmail (Maybe Text) Source #

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendBulkEmail_configurationSetName :: Lens' SendBulkEmail (Maybe Text) Source #

The name of the configuration set to use when sending the email.

sendBulkEmail_feedbackForwardingEmailAddress :: Lens' SendBulkEmail (Maybe Text) Source #

The address that you want bounce and complaint notifications to be sent to.

sendBulkEmail_feedbackForwardingEmailAddressIdentityArn :: Lens' SendBulkEmail (Maybe Text) Source #

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendBulkEmail_defaultEmailTags :: Lens' SendBulkEmail (Maybe [MessageTag]) Source #

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

sendBulkEmail_replyToAddresses :: Lens' SendBulkEmail (Maybe [Text]) Source #

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

sendBulkEmail_defaultContent :: Lens' SendBulkEmail BulkEmailContent Source #

An object that contains the body of the message. You can specify a template message.

sendBulkEmail_bulkEmailEntries :: Lens' SendBulkEmail [BulkEmailEntry] Source #

The list of bulk email entry objects.

sendBulkEmailResponse_bulkEmailEntryResults :: Lens' SendBulkEmailResponse [BulkEmailEntryResult] Source #

One object per intended recipient. Check each response object and retry any messages with a failure status.

TestRenderEmailTemplate

testRenderEmailTemplate_templateData :: Lens' TestRenderEmailTemplate Text Source #

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

testRenderEmailTemplateResponse_renderedTemplate :: Lens' TestRenderEmailTemplateResponse Text Source #

The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.

tagResource_tags :: Lens' TagResource [Tag] Source #

A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

SendEmail

sendEmail_fromEmailAddress :: Lens' SendEmail (Maybe Text) Source #

The email address to use as the "From" address for the email. The address that you specify has to be verified.

sendEmail_destination :: Lens' SendEmail (Maybe Destination) Source #

An object that contains the recipients of the email message.

sendEmail_fromEmailAddressIdentityArn :: Lens' SendEmail (Maybe Text) Source #

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FromEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use sender@example.com, then you would specify the FromEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FromEmailAddress to be sender@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

For Raw emails, the FromEmailAddressIdentityArn value overrides the X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email message content.

sendEmail_configurationSetName :: Lens' SendEmail (Maybe Text) Source #

The name of the configuration set to use when sending the email.

sendEmail_listManagementOptions :: Lens' SendEmail (Maybe ListManagementOptions) Source #

An object used to specify a list or topic to which an email belongs, which will be used when a contact chooses to unsubscribe.

sendEmail_emailTags :: Lens' SendEmail (Maybe [MessageTag]) Source #

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

sendEmail_feedbackForwardingEmailAddress :: Lens' SendEmail (Maybe Text) Source #

The address that you want bounce and complaint notifications to be sent to.

sendEmail_feedbackForwardingEmailAddressIdentityArn :: Lens' SendEmail (Maybe Text) Source #

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the FeedbackForwardingEmailAddress parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the FeedbackForwardingEmailAddressIdentityArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the FeedbackForwardingEmailAddress to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

sendEmail_replyToAddresses :: Lens' SendEmail (Maybe [Text]) Source #

The "Reply-to" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

sendEmail_content :: Lens' SendEmail EmailContent Source #

An object that contains the body of the message. You can send either a Simple message Raw message or a template Message.

sendEmailResponse_messageId :: Lens' SendEmailResponse (Maybe Text) Source #

A unique identifier for the message that is generated when the message is accepted.

It's possible for Amazon SES to accept a message without sending it. This can happen when the message that you're trying to send has an attachment contains a virus, or when you send a templated email that contains invalid personalization content, for example.

sendEmailResponse_httpStatus :: Lens' SendEmailResponse Int Source #

The response's http status code.

PutDedicatedIpWarmupAttributes

putDedicatedIpWarmupAttributes_ip :: Lens' PutDedicatedIpWarmupAttributes Text Source #

The dedicated IP address that you want to update the warm-up attributes for.

putDedicatedIpWarmupAttributes_warmupPercentage :: Lens' PutDedicatedIpWarmupAttributes Int Source #

The warm-up percentage that you want to associate with the dedicated IP address.

DeleteEmailIdentityPolicy

deleteEmailIdentityPolicy_policyName :: Lens' DeleteEmailIdentityPolicy Text Source #

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

UpdateEmailIdentityPolicy

updateEmailIdentityPolicy_policyName :: Lens' UpdateEmailIdentityPolicy Text Source #

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

updateEmailIdentityPolicy_policy :: Lens' UpdateEmailIdentityPolicy Text Source #

The text of the policy in JSON format. The policy cannot exceed 4 KB.

For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.

To remove more than one tag from the resource, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand. For example: /v2/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2

CreateDeliverabilityTestReport

createDeliverabilityTestReport_reportName :: Lens' CreateDeliverabilityTestReport (Maybe Text) Source #

A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

createDeliverabilityTestReport_tags :: Lens' CreateDeliverabilityTestReport (Maybe [Tag]) Source #

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

createDeliverabilityTestReport_fromEmailAddress :: Lens' CreateDeliverabilityTestReport Text Source #

The email address that the predictive inbox placement test email was sent from.

createDeliverabilityTestReport_content :: Lens' CreateDeliverabilityTestReport EmailContent Source #

The HTML body of the message that you sent when you performed the predictive inbox placement test.

createDeliverabilityTestReportResponse_reportId :: Lens' CreateDeliverabilityTestReportResponse Text Source #

A unique string that identifies the predictive inbox placement test.

createDeliverabilityTestReportResponse_deliverabilityTestStatus :: Lens' CreateDeliverabilityTestReportResponse DeliverabilityTestStatus Source #

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

PutEmailIdentityMailFromAttributes

putEmailIdentityMailFromAttributes_mailFromDomain :: Lens' PutEmailIdentityMailFromAttributes (Maybe Text) Source #

The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:

  • It has to be a subdomain of the verified identity.
  • It can't be used to receive email.
  • It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails.

putEmailIdentityMailFromAttributes_behaviorOnMxFailure :: Lens' PutEmailIdentityMailFromAttributes (Maybe BehaviorOnMxFailure) Source #

The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

ListContactLists

listContactLists_nextToken :: Lens' ListContactLists (Maybe Text) Source #

A string token indicating that there might be additional contact lists available to be listed. Use the token provided in the Response to use in the subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.

listContactLists_pageSize :: Lens' ListContactLists (Maybe Int) Source #

Maximum number of contact lists to return at once. Use this parameter to paginate results. If additional contact lists exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional lists.

listContactListsResponse_nextToken :: Lens' ListContactListsResponse (Maybe Text) Source #

A string token indicating that there might be additional contact lists available to be listed. Copy this token to a subsequent call to ListContactLists with the same parameters to retrieve the next page of contact lists.

CreateEmailIdentityPolicy

createEmailIdentityPolicy_policyName :: Lens' CreateEmailIdentityPolicy Text Source #

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

createEmailIdentityPolicy_policy :: Lens' CreateEmailIdentityPolicy Text Source #

The text of the policy in JSON format. The policy cannot exceed 4 KB.

For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

CreateConfigurationSetEventDestination

createConfigurationSetEventDestination_eventDestinationName :: Lens' CreateConfigurationSetEventDestination Text Source #

A name that identifies the event destination within the configuration set.

PutEmailIdentityConfigurationSetAttributes

PutAccountSuppressionAttributes

putAccountSuppressionAttributes_suppressedReasons :: Lens' PutAccountSuppressionAttributes (Maybe [SuppressionListReason]) Source #

A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:

  • COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.
  • BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

CreateImportJob

createImportJobResponse_jobId :: Lens' CreateImportJobResponse (Maybe Text) Source #

A string that represents the import job ID.

ListDeliverabilityTestReports

listDeliverabilityTestReports_nextToken :: Lens' ListDeliverabilityTestReports (Maybe Text) Source #

A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.

listDeliverabilityTestReports_pageSize :: Lens' ListDeliverabilityTestReports (Maybe Int) Source #

The number of results to show in a single call to ListDeliverabilityTestReports. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 0, and can be no more than 1000.

listDeliverabilityTestReportsResponse_nextToken :: Lens' ListDeliverabilityTestReportsResponse (Maybe Text) Source #

A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter.

listDeliverabilityTestReportsResponse_deliverabilityTestReports :: Lens' ListDeliverabilityTestReportsResponse [DeliverabilityTestReport] Source #

An object that contains a lists of predictive inbox placement tests that you've performed.

CreateConfigurationSet

createConfigurationSet_sendingOptions :: Lens' CreateConfigurationSet (Maybe SendingOptions) Source #

An object that defines whether or not Amazon SES can send email that you send using the configuration set.

createConfigurationSet_deliveryOptions :: Lens' CreateConfigurationSet (Maybe DeliveryOptions) Source #

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

createConfigurationSet_trackingOptions :: Lens' CreateConfigurationSet (Maybe TrackingOptions) Source #

An object that defines the open and click tracking options for emails that you send using the configuration set.

createConfigurationSet_reputationOptions :: Lens' CreateConfigurationSet (Maybe ReputationOptions) Source #

An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

createConfigurationSet_tags :: Lens' CreateConfigurationSet (Maybe [Tag]) Source #

An array of objects that define the tags (keys and values) to associate with the configuration set.

createConfigurationSet_configurationSetName :: Lens' CreateConfigurationSet Text Source #

The name of the configuration set. The name can contain up to 64 alphanumeric characters, including letters, numbers, hyphens (-) and underscores (_) only.

GetDeliverabilityTestReport

getDeliverabilityTestReport_reportId :: Lens' GetDeliverabilityTestReport Text Source #

A unique string that identifies the predictive inbox placement test.

getDeliverabilityTestReportResponse_message :: Lens' GetDeliverabilityTestReportResponse (Maybe Text) Source #

An object that contains the message that you sent when you performed this predictive inbox placement test.

getDeliverabilityTestReportResponse_tags :: Lens' GetDeliverabilityTestReportResponse (Maybe [Tag]) Source #

An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

getDeliverabilityTestReportResponse_overallPlacement :: Lens' GetDeliverabilityTestReportResponse PlacementStatistics Source #

An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.

getDeliverabilityTestReportResponse_ispPlacements :: Lens' GetDeliverabilityTestReportResponse [IspPlacement] Source #

An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.

PutDeliverabilityDashboardOption

putDeliverabilityDashboardOption_subscribedDomains :: Lens' PutDeliverabilityDashboardOption (Maybe [DomainDeliverabilityTrackingOption]) Source #

An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

putDeliverabilityDashboardOption_dashboardEnabled :: Lens' PutDeliverabilityDashboardOption Bool Source #

Specifies whether to enable the Deliverability dashboard. To enable the dashboard, set this value to true.

PutAccountDedicatedIpWarmupAttributes

putAccountDedicatedIpWarmupAttributes_autoWarmupEnabled :: Lens' PutAccountDedicatedIpWarmupAttributes (Maybe Bool) Source #

Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon SES account in the current Amazon Web Services Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.

ListContacts

listContacts_nextToken :: Lens' ListContacts (Maybe Text) Source #

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

listContacts_filter :: Lens' ListContacts (Maybe ListContactsFilter) Source #

A filter that can be applied to a list of contacts.

listContacts_pageSize :: Lens' ListContacts (Maybe Int) Source #

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

listContactsResponse_nextToken :: Lens' ListContactsResponse (Maybe Text) Source #

A string token indicating that there might be additional contacts available to be listed. Copy this token to a subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

listContactsResponse_contacts :: Lens' ListContactsResponse (Maybe [Contact]) Source #

The contacts present in a specific contact list.

Types

AccountDetails

accountDetails_reviewDetails :: Lens' AccountDetails (Maybe ReviewDetails) Source #

Information about the review of the latest details you submitted.

accountDetails_mailType :: Lens' AccountDetails (Maybe MailType) Source #

The type of email your account is sending. The mail type can be one of the following:

  • MARKETING – Most of your sending traffic is to keep your customers informed of your latest offering.
  • TRANSACTIONAL – Most of your sending traffic is to communicate during a transaction with a customer.

accountDetails_useCaseDescription :: Lens' AccountDetails (Maybe Text) Source #

A description of the types of email that you plan to send.

accountDetails_contactLanguage :: Lens' AccountDetails (Maybe ContactLanguage) Source #

The language you would prefer for the case. The contact language can be one of ENGLISH or JAPANESE.

accountDetails_additionalContactEmailAddresses :: Lens' AccountDetails (Maybe (NonEmpty Text)) Source #

Additional email addresses where updates are sent about your account review process.

accountDetails_websiteURL :: Lens' AccountDetails (Maybe Text) Source #

The URL of your website. This information helps us better understand the type of content that you plan to send.

BlacklistEntry

blacklistEntry_listingTime :: Lens' BlacklistEntry (Maybe UTCTime) Source #

The time when the blacklisting event occurred, shown in Unix time format.

blacklistEntry_rblName :: Lens' BlacklistEntry (Maybe Text) Source #

The name of the blacklist that the IP address appears on.

blacklistEntry_description :: Lens' BlacklistEntry (Maybe Text) Source #

Additional information about the blacklisting event, as provided by the blacklist maintainer.

Body

body_text :: Lens' Body (Maybe Content) Source #

An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.

body_html :: Lens' Body (Maybe Content) Source #

An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.

BulkEmailContent

bulkEmailContent_template :: Lens' BulkEmailContent (Maybe Template) Source #

The template to use for the bulk email message.

BulkEmailEntry

bulkEmailEntry_replacementEmailContent :: Lens' BulkEmailEntry (Maybe ReplacementEmailContent) Source #

The ReplacementEmailContent associated with a BulkEmailEntry.

bulkEmailEntry_replacementTags :: Lens' BulkEmailEntry (Maybe [MessageTag]) Source #

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendBulkTemplatedEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

bulkEmailEntry_destination :: Lens' BulkEmailEntry Destination Source #

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.

BulkEmailEntryResult

bulkEmailEntryResult_status :: Lens' BulkEmailEntryResult (Maybe BulkEmailStatus) Source #

The status of a message sent using the SendBulkTemplatedEmail operation.

Possible values for this parameter include:

  • SUCCESS: Amazon SES accepted the message, and will attempt to deliver it to the recipients.
  • MESSAGE_REJECTED: The message was rejected because it contained a virus.
  • MAIL_FROM_DOMAIN_NOT_VERIFIED: The sender's email address or domain was not verified.
  • CONFIGURATION_SET_DOES_NOT_EXIST: The configuration set you specified does not exist.
  • TEMPLATE_DOES_NOT_EXIST: The template you specified does not exist.
  • ACCOUNT_SUSPENDED: Your account has been shut down because of issues related to your email sending practices.
  • ACCOUNT_THROTTLED: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.
  • ACCOUNT_DAILY_QUOTA_EXCEEDED: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.
  • INVALID_SENDING_POOL_NAME: The configuration set you specified refers to an IP pool that does not exist.
  • ACCOUNT_SENDING_PAUSED: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.
  • CONFIGURATION_SET_SENDING_PAUSED: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.
  • INVALID_PARAMETER_VALUE: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.
  • TRANSIENT_FAILURE: Amazon SES was unable to process your request because of a temporary issue.
  • FAILED: Amazon SES was unable to process your request. See the error message for additional information.

bulkEmailEntryResult_error :: Lens' BulkEmailEntryResult (Maybe Text) Source #

A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.

bulkEmailEntryResult_messageId :: Lens' BulkEmailEntryResult (Maybe Text) Source #

The unique message identifier returned from the SendBulkTemplatedEmail operation.

CloudWatchDestination

cloudWatchDestination_dimensionConfigurations :: Lens' CloudWatchDestination [CloudWatchDimensionConfiguration] Source #

An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

CloudWatchDimensionConfiguration

cloudWatchDimensionConfiguration_dimensionName :: Lens' CloudWatchDimensionConfiguration Text Source #

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
  • It can contain no more than 256 characters.

cloudWatchDimensionConfiguration_dimensionValueSource :: Lens' CloudWatchDimensionConfiguration DimensionValueSource Source #

The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail or SendRawEmail API, choose messageTag. To use your own email headers, choose emailHeader. To use link tags, choose linkTags.

cloudWatchDimensionConfiguration_defaultDimensionValue :: Lens' CloudWatchDimensionConfiguration Text Source #

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
  • It can contain no more than 256 characters.

Contact

contact_unsubscribeAll :: Lens' Contact (Maybe Bool) Source #

A boolean value status noting if the contact is unsubscribed from all contact list topics.

contact_topicDefaultPreferences :: Lens' Contact (Maybe [TopicPreference]) Source #

The default topic preferences applied to the contact.

contact_emailAddress :: Lens' Contact (Maybe Text) Source #

The contact's email address.

contact_lastUpdatedTimestamp :: Lens' Contact (Maybe UTCTime) Source #

A timestamp noting the last time the contact's information was updated.

contact_topicPreferences :: Lens' Contact (Maybe [TopicPreference]) Source #

The contact's preference for being opted-in to or opted-out of a topic.

ContactList

contactList_contactListName :: Lens' ContactList (Maybe Text) Source #

The name of the contact list.

contactList_lastUpdatedTimestamp :: Lens' ContactList (Maybe UTCTime) Source #

A timestamp noting the last time the contact list was updated.

ContactListDestination

contactListDestination_contactListImportAction :: Lens' ContactListDestination ContactListImportAction Source #

The type of action to perform on the addresses. The following are the

possible values:

  • PUT: add the addresses to the contact list. If the record already exists, it will override it with the new value.
  • DELETE: remove the addresses from the contact list.

Content

content_charset :: Lens' Content (Maybe Text) Source #

The character set for the content. Because of the constraints of the SMTP protocol, Amazon SES uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

content_data :: Lens' Content Text Source #

The content of the message itself.

CustomVerificationEmailTemplateMetadata

customVerificationEmailTemplateMetadata_failureRedirectionURL :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text) Source #

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

customVerificationEmailTemplateMetadata_successRedirectionURL :: Lens' CustomVerificationEmailTemplateMetadata (Maybe Text) Source #

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

DailyVolume

dailyVolume_domainIspPlacements :: Lens' DailyVolume (Maybe [DomainIspPlacement]) Source #

An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.

dailyVolume_startDate :: Lens' DailyVolume (Maybe UTCTime) Source #

The date that the DailyVolume metrics apply to, in Unix time.

dailyVolume_volumeStatistics :: Lens' DailyVolume (Maybe VolumeStatistics) Source #

An object that contains inbox placement metrics for a specific day in the analysis period.

DedicatedIp

dedicatedIp_poolName :: Lens' DedicatedIp (Maybe Text) Source #

The name of the dedicated IP pool that the IP address is associated with.

dedicatedIp_warmupStatus :: Lens' DedicatedIp WarmupStatus Source #

The warm-up status of a dedicated IP address. The status can have one of the following values:

  • IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.
  • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

dedicatedIp_warmupPercentage :: Lens' DedicatedIp Int Source #

Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

DeliverabilityTestReport

deliverabilityTestReport_subject :: Lens' DeliverabilityTestReport (Maybe Text) Source #

The subject line for an email that you submitted in a predictive inbox placement test.

deliverabilityTestReport_fromEmailAddress :: Lens' DeliverabilityTestReport (Maybe Text) Source #

The sender address that you specified for the predictive inbox placement test.

deliverabilityTestReport_createDate :: Lens' DeliverabilityTestReport (Maybe UTCTime) Source #

The date and time when the predictive inbox placement test was created, in Unix time format.

deliverabilityTestReport_reportId :: Lens' DeliverabilityTestReport (Maybe Text) Source #

A unique string that identifies the predictive inbox placement test.

deliverabilityTestReport_reportName :: Lens' DeliverabilityTestReport (Maybe Text) Source #

A name that helps you identify a predictive inbox placement test report.

deliverabilityTestReport_deliverabilityTestStatus :: Lens' DeliverabilityTestReport (Maybe DeliverabilityTestStatus) Source #

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

DeliveryOptions

deliveryOptions_sendingPoolName :: Lens' DeliveryOptions (Maybe Text) Source #

The name of the dedicated IP pool to associate with the configuration set.

deliveryOptions_tlsPolicy :: Lens' DeliveryOptions (Maybe TlsPolicy) Source #

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

Destination

destination_bccAddresses :: Lens' Destination (Maybe [Text]) Source #

An array that contains the email addresses of the "BCC" (blind carbon copy) recipients for the email.

destination_ccAddresses :: Lens' Destination (Maybe [Text]) Source #

An array that contains the email addresses of the "CC" (carbon copy) recipients for the email.

destination_toAddresses :: Lens' Destination (Maybe [Text]) Source #

An array that contains the email addresses of the "To" recipients for the email.

DkimAttributes

dkimAttributes_status :: Lens' DkimAttributes (Maybe DkimStatus) Source #

Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

  • PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.
  • SUCCESS – The verification process completed successfully.
  • FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.
  • TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.
  • NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.

dkimAttributes_nextSigningKeyLength :: Lens' DkimAttributes (Maybe DkimSigningKeyLength) Source #

Easy DKIM
The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

dkimAttributes_tokens :: Lens' DkimAttributes (Maybe [Text]) Source #

If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.

If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.

Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.

dkimAttributes_signingEnabled :: Lens' DkimAttributes (Maybe Bool) Source #

If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.

dkimAttributes_currentSigningKeyLength :: Lens' DkimAttributes (Maybe DkimSigningKeyLength) Source #

Easy DKIM
The key length of the DKIM key pair in use.

dkimAttributes_lastKeyGenerationTimestamp :: Lens' DkimAttributes (Maybe UTCTime) Source #

Easy DKIM
The last time a key pair was generated for this identity.

dkimAttributes_signingAttributesOrigin :: Lens' DkimAttributes (Maybe DkimSigningAttributesOrigin) Source #

A string that indicates how DKIM was configured for the identity. These are the possible values:

  • AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.
  • EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).

DkimSigningAttributes

dkimSigningAttributes_nextSigningKeyLength :: Lens' DkimSigningAttributes (Maybe DkimSigningKeyLength) Source #

Easy DKIM
The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

dkimSigningAttributes_domainSigningPrivateKey :: Lens' DkimSigningAttributes (Maybe Text) Source #

Bring Your Own DKIM
A private key that's used to generate a DKIM signature.

The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.

dkimSigningAttributes_domainSigningSelector :: Lens' DkimSigningAttributes (Maybe Text) Source #

Bring Your Own DKIM
A string that's used to identify a public key in the DNS configuration for a domain.

DomainDeliverabilityCampaign

domainDeliverabilityCampaign_spamCount :: Lens' DomainDeliverabilityCampaign (Maybe Integer) Source #

The number of email messages that were delivered to recipients' spam or junk mail folders.

domainDeliverabilityCampaign_subject :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #

The subject line, or title, of the email message.

domainDeliverabilityCampaign_esps :: Lens' DomainDeliverabilityCampaign (Maybe [Text]) Source #

The major email providers who handled the email message.

domainDeliverabilityCampaign_fromAddress :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #

The verified email address that the email message was sent from.

domainDeliverabilityCampaign_deleteRate :: Lens' DomainDeliverabilityCampaign (Maybe Double) Source #

The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

domainDeliverabilityCampaign_campaignId :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #

The unique identifier for the campaign. The Deliverability dashboard automatically generates and assigns this identifier to a campaign.

domainDeliverabilityCampaign_sendingIps :: Lens' DomainDeliverabilityCampaign (Maybe [Text]) Source #

The IP addresses that were used to send the email message.

domainDeliverabilityCampaign_firstSeenDateTime :: Lens' DomainDeliverabilityCampaign (Maybe UTCTime) Source #

The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

domainDeliverabilityCampaign_inboxCount :: Lens' DomainDeliverabilityCampaign (Maybe Integer) Source #

The number of email messages that were delivered to recipients’ inboxes.

domainDeliverabilityCampaign_readDeleteRate :: Lens' DomainDeliverabilityCampaign (Maybe Double) Source #

The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

domainDeliverabilityCampaign_projectedVolume :: Lens' DomainDeliverabilityCampaign (Maybe Integer) Source #

The projected number of recipients that the email message was sent to.

domainDeliverabilityCampaign_imageUrl :: Lens' DomainDeliverabilityCampaign (Maybe Text) Source #

The URL of an image that contains a snapshot of the email message that was sent.

domainDeliverabilityCampaign_readRate :: Lens' DomainDeliverabilityCampaign (Maybe Double) Source #

The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

domainDeliverabilityCampaign_lastSeenDateTime :: Lens' DomainDeliverabilityCampaign (Maybe UTCTime) Source #

The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

DomainDeliverabilityTrackingOption

domainDeliverabilityTrackingOption_domain :: Lens' DomainDeliverabilityTrackingOption (Maybe Text) Source #

A verified domain that’s associated with your Amazon Web Services account and currently has an active Deliverability dashboard subscription.

domainDeliverabilityTrackingOption_subscriptionStartDate :: Lens' DomainDeliverabilityTrackingOption (Maybe UTCTime) Source #

The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.

domainDeliverabilityTrackingOption_inboxPlacementTrackingOption :: Lens' DomainDeliverabilityTrackingOption (Maybe InboxPlacementTrackingOption) Source #

An object that contains information about the inbox placement data settings for the domain.

DomainIspPlacement

domainIspPlacement_spamPercentage :: Lens' DomainIspPlacement (Maybe Double) Source #

The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

domainIspPlacement_inboxRawCount :: Lens' DomainIspPlacement (Maybe Integer) Source #

The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

domainIspPlacement_ispName :: Lens' DomainIspPlacement (Maybe Text) Source #

The name of the email provider that the inbox placement data applies to.

domainIspPlacement_inboxPercentage :: Lens' DomainIspPlacement (Maybe Double) Source #

The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

domainIspPlacement_spamRawCount :: Lens' DomainIspPlacement (Maybe Integer) Source #

The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

EmailContent

emailContent_raw :: Lens' EmailContent (Maybe RawMessage) Source #

The raw email message. The message has to meet the following criteria:

  • The message has to contain a header and a body, separated by one blank line.
  • All of the required header fields must be present in the message.
  • Each part of a multipart MIME message must be formatted properly.
  • If you include attachments, they must be in a file format that the Amazon SES API v2 supports.
  • The entire message must be Base64 encoded.
  • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
  • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

emailContent_simple :: Lens' EmailContent (Maybe Message) Source #

The simple email message. The message consists of a subject and a message body.

emailContent_template :: Lens' EmailContent (Maybe Template) Source #

The template to use for the email message.

EmailTemplateContent

emailTemplateContent_text :: Lens' EmailTemplateContent (Maybe Text) Source #

The email body that will be visible to recipients whose email clients do not display HTML.

EmailTemplateMetadata

EventDestination

eventDestination_pinpointDestination :: Lens' EventDestination (Maybe PinpointDestination) Source #

An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.

eventDestination_enabled :: Lens' EventDestination (Maybe Bool) Source #

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination) Source #

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

eventDestination_cloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination) Source #

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination) Source #

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

eventDestination_name :: Lens' EventDestination Text Source #

A name that identifies the event destination.

eventDestination_matchingEventTypes :: Lens' EventDestination [EventType] Source #

The types of events that Amazon SES sends to the specified event destinations.

EventDestinationDefinition

eventDestinationDefinition_matchingEventTypes :: Lens' EventDestinationDefinition (Maybe [EventType]) Source #

An array that specifies which events the Amazon SES API v2 should send to the destinations in this EventDestinationDefinition.

eventDestinationDefinition_pinpointDestination :: Lens' EventDestinationDefinition (Maybe PinpointDestination) Source #

An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.

eventDestinationDefinition_enabled :: Lens' EventDestinationDefinition (Maybe Bool) Source #

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

eventDestinationDefinition_kinesisFirehoseDestination :: Lens' EventDestinationDefinition (Maybe KinesisFirehoseDestination) Source #

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

eventDestinationDefinition_cloudWatchDestination :: Lens' EventDestinationDefinition (Maybe CloudWatchDestination) Source #

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

eventDestinationDefinition_snsDestination :: Lens' EventDestinationDefinition (Maybe SnsDestination) Source #

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

FailureInfo

failureInfo_failedRecordsS3Url :: Lens' FailureInfo (Maybe Text) Source #

An Amazon S3 presigned URL that contains all the failed records and related information.

failureInfo_errorMessage :: Lens' FailureInfo (Maybe Text) Source #

A message about why the import job failed.

IdentityInfo

identityInfo_identityType :: Lens' IdentityInfo (Maybe IdentityType) Source #

The email identity type. Note: the MANAGED_DOMAIN type is not supported for email identity types.

identityInfo_identityName :: Lens' IdentityInfo (Maybe Text) Source #

The address or domain of the identity.

identityInfo_sendingEnabled :: Lens' IdentityInfo (Maybe Bool) Source #

Indicates whether or not you can send email from the identity.

An identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon SES to send email from that identity.

ImportDataSource

importDataSource_s3Url :: Lens' ImportDataSource Text Source #

An Amazon S3 URL in the format s3://<bucket_name>/<object>.

importDataSource_dataFormat :: Lens' ImportDataSource DataFormat Source #

The data format of the import job's data source.

ImportDestination

importDestination_suppressionListDestination :: Lens' ImportDestination (Maybe SuppressionListDestination) Source #

An object that contains the action of the import job towards suppression list.

importDestination_contactListDestination :: Lens' ImportDestination (Maybe ContactListDestination) Source #

An object that contains the action of the import job towards a contact list.

ImportJobSummary

importJobSummary_createdTimestamp :: Lens' ImportJobSummary (Maybe UTCTime) Source #

The date and time when the import job was created.

InboxPlacementTrackingOption

inboxPlacementTrackingOption_trackedIsps :: Lens' InboxPlacementTrackingOption (Maybe [Text]) Source #

An array of strings, one for each major email provider that the inbox placement data applies to.

inboxPlacementTrackingOption_global :: Lens' InboxPlacementTrackingOption (Maybe Bool) Source #

Specifies whether inbox placement data is being tracked for the domain.

IspPlacement

ispPlacement_placementStatistics :: Lens' IspPlacement (Maybe PlacementStatistics) Source #

An object that contains inbox placement metrics for a specific email provider.

ispPlacement_ispName :: Lens' IspPlacement (Maybe Text) Source #

The name of the email provider that the inbox placement data applies to.

KinesisFirehoseDestination

kinesisFirehoseDestination_iamRoleArn :: Lens' KinesisFirehoseDestination Text Source #

The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.

kinesisFirehoseDestination_deliveryStreamArn :: Lens' KinesisFirehoseDestination Text Source #

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that the Amazon SES API v2 sends email events to.

ListContactsFilter

listContactsFilter_filteredStatus :: Lens' ListContactsFilter (Maybe SubscriptionStatus) Source #

The status by which you are filtering: OPT_IN or OPT_OUT.

listContactsFilter_topicFilter :: Lens' ListContactsFilter (Maybe TopicFilter) Source #

Used for filtering by a specific topic preference.

ListManagementOptions

MailFromAttributes

mailFromAttributes_mailFromDomain :: Lens' MailFromAttributes Text Source #

The name of a domain that an email identity uses as a custom MAIL FROM domain.

mailFromAttributes_mailFromDomainStatus :: Lens' MailFromAttributes MailFromDomainStatus Source #

The status of the MAIL FROM domain. This status can have the following values:

  • PENDING – Amazon SES hasn't started searching for the MX record yet.
  • SUCCESS – Amazon SES detected the required MX record for the MAIL FROM domain.
  • FAILED – Amazon SES can't find the required MX record, or the record no longer exists.
  • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon SES from determining the status of the MAIL FROM domain.

mailFromAttributes_behaviorOnMxFailure :: Lens' MailFromAttributes BehaviorOnMxFailure Source #

The action to take if the required MX record can't be found when you send an email. When you set this value to UseDefaultValue, the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

Message

message_subject :: Lens' Message Content Source #

The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.

message_body :: Lens' Message Body Source #

The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.

MessageTag

messageTag_name :: Lens' MessageTag Text Source #

The name of the message tag. The message tag name has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
  • It can contain no more than 256 characters.

messageTag_value :: Lens' MessageTag Text Source #

The value of the message tag. The message tag value has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
  • It can contain no more than 256 characters.

OverallVolume

overallVolume_domainIspPlacements :: Lens' OverallVolume (Maybe [DomainIspPlacement]) Source #

An object that contains inbox and junk mail placement metrics for individual email providers.

overallVolume_volumeStatistics :: Lens' OverallVolume (Maybe VolumeStatistics) Source #

An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.

overallVolume_readRatePercent :: Lens' OverallVolume (Maybe Double) Source #

The percentage of emails that were sent from the domain that were read by their recipients.

PinpointDestination

pinpointDestination_applicationArn :: Lens' PinpointDestination (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Pinpoint project to send email events to.

PlacementStatistics

placementStatistics_missingPercentage :: Lens' PlacementStatistics (Maybe Double) Source #

The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.

placementStatistics_spamPercentage :: Lens' PlacementStatistics (Maybe Double) Source #

The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.

placementStatistics_spfPercentage :: Lens' PlacementStatistics (Maybe Double) Source #

The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.

placementStatistics_dkimPercentage :: Lens' PlacementStatistics (Maybe Double) Source #

The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.

placementStatistics_inboxPercentage :: Lens' PlacementStatistics (Maybe Double) Source #

The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

RawMessage

rawMessage_data :: Lens' RawMessage ByteString Source #

The raw email message. The message has to meet the following criteria:

  • The message has to contain a header and a body, separated by one blank line.
  • All of the required header fields must be present in the message.
  • Each part of a multipart MIME message must be formatted properly.
  • Attachments must be in a file format that the Amazon SES supports.
  • The entire message must be Base64 encoded.
  • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.
  • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.--
  • - Note: This Lens automatically encodes and decodes Base64 data.
  • - The underlying isomorphism will encode to Base64 representation during
  • - serialisation, and decode from Base64 representation during deserialisation.
  • - This Lens accepts and returns only raw unencoded data.

ReplacementEmailContent

replacementEmailContent_replacementTemplate :: Lens' ReplacementEmailContent (Maybe ReplacementTemplate) Source #

The ReplacementTemplate associated with ReplacementEmailContent.

ReplacementTemplate

replacementTemplate_replacementTemplateData :: Lens' ReplacementTemplate (Maybe Text) Source #

A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

ReputationOptions

reputationOptions_lastFreshStart :: Lens' ReputationOptions (Maybe UTCTime) Source #

The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.

reputationOptions_reputationMetricsEnabled :: Lens' ReputationOptions (Maybe Bool) Source #

If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

ReviewDetails

reviewDetails_status :: Lens' ReviewDetails (Maybe ReviewStatus) Source #

The status of the latest review of your account. The status can be one of the following:

  • PENDING – We have received your appeal and are in the process of reviewing it.
  • GRANTED – Your appeal has been reviewed and your production access has been granted.
  • DENIED – Your appeal has been reviewed and your production access has been denied.
  • FAILED – An internal error occurred and we didn't receive your appeal. You can submit your appeal again.

reviewDetails_caseId :: Lens' ReviewDetails (Maybe Text) Source #

The associated support center case ID (if any).

SendQuota

sendQuota_maxSendRate :: Lens' SendQuota (Maybe Double) Source #

The maximum number of emails that you can send per second in the current Amazon Web Services Region. This value is also called your /maximum sending rate or your maximum TPS (transactions per second) rate/.

sendQuota_sentLast24Hours :: Lens' SendQuota (Maybe Double) Source #

The number of emails sent from your Amazon SES account in the current Amazon Web Services Region over the past 24 hours.

sendQuota_max24HourSend :: Lens' SendQuota (Maybe Double) Source #

The maximum number of emails that you can send in the current Amazon Web Services Region over a 24-hour period. This value is also called your sending quota.

SendingOptions

sendingOptions_sendingEnabled :: Lens' SendingOptions (Maybe Bool) Source #

If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

SnsDestination

snsDestination_topicArn :: Lens' SnsDestination Text Source #

The Amazon Resource Name (ARN) of the Amazon SNS topic to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

SuppressedDestination

suppressedDestination_attributes :: Lens' SuppressedDestination (Maybe SuppressedDestinationAttributes) Source #

An optional value that can contain additional information about the reasons that the address was added to the suppression list for your account.

suppressedDestination_emailAddress :: Lens' SuppressedDestination Text Source #

The email address that is on the suppression list for your account.

suppressedDestination_reason :: Lens' SuppressedDestination SuppressionListReason Source #

The reason that the address was added to the suppression list for your account.

suppressedDestination_lastUpdateTime :: Lens' SuppressedDestination UTCTime Source #

The date and time when the suppressed destination was last updated, shown in Unix time format.

SuppressedDestinationAttributes

suppressedDestinationAttributes_feedbackId :: Lens' SuppressedDestinationAttributes (Maybe Text) Source #

A unique identifier that's generated when an email address is added to the suppression list for your account.

suppressedDestinationAttributes_messageId :: Lens' SuppressedDestinationAttributes (Maybe Text) Source #

The unique identifier of the email message that caused the email address to be added to the suppression list for your account.

SuppressedDestinationSummary

suppressedDestinationSummary_emailAddress :: Lens' SuppressedDestinationSummary Text Source #

The email address that's on the suppression list for your account.

suppressedDestinationSummary_reason :: Lens' SuppressedDestinationSummary SuppressionListReason Source #

The reason that the address was added to the suppression list for your account.

suppressedDestinationSummary_lastUpdateTime :: Lens' SuppressedDestinationSummary UTCTime Source #

The date and time when the suppressed destination was last updated, shown in Unix time format.

SuppressionAttributes

suppressionAttributes_suppressedReasons :: Lens' SuppressionAttributes (Maybe [SuppressionListReason]) Source #

A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. This list can contain any or all of the following:

  • COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.
  • BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

SuppressionListDestination

suppressionListDestination_suppressionListImportAction :: Lens' SuppressionListDestination SuppressionListImportAction Source #

The type of action to perform on the address. The following are possible values:

  • PUT: add the addresses to the suppression list. If the record already exists, it will override it with the new value.
  • DELETE: remove the addresses from the suppression list.

SuppressionOptions

suppressionOptions_suppressedReasons :: Lens' SuppressionOptions (Maybe [SuppressionListReason]) Source #

A list that contains the reasons that email addresses are automatically added to the suppression list for your account. This list can contain any or all of the following:

  • COMPLAINT – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a complaint.
  • BOUNCE – Amazon SES adds an email address to the suppression list for your account when a message sent to that address results in a hard bounce.

Tag

tag_key :: Lens' Tag Text Source #

One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

tag_value :: Lens' Tag Text Source #

The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want a resource to have a specific tag value, don't specify a value for this parameter. If you don't specify a value, Amazon SES sets the value to an empty string.

Template

template_templateName :: Lens' Template (Maybe Text) Source #

The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

template_templateArn :: Lens' Template (Maybe Text) Source #

The Amazon Resource Name (ARN) of the template.

template_templateData :: Lens' Template (Maybe Text) Source #

An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.

Topic

topic_description :: Lens' Topic (Maybe Text) Source #

A description of what the topic is about, which the contact will see.

topic_topicName :: Lens' Topic Text Source #

The name of the topic.

topic_displayName :: Lens' Topic Text Source #

The name of the topic the contact will see.

topic_defaultSubscriptionStatus :: Lens' Topic SubscriptionStatus Source #

The default subscription status to be applied to a contact if the contact has not noted their preference for subscribing to a topic.

TopicFilter

topicFilter_topicName :: Lens' TopicFilter (Maybe Text) Source #

The name of a topic on which you wish to apply the filter.

topicFilter_useDefaultIfPreferenceUnavailable :: Lens' TopicFilter (Maybe Bool) Source #

Notes that the default subscription status should be applied to a contact because the contact has not noted their preference for subscribing to a topic.

TopicPreference

topicPreference_subscriptionStatus :: Lens' TopicPreference SubscriptionStatus Source #

The contact's subscription status to a topic which is either OPT_IN or OPT_OUT.

TrackingOptions

trackingOptions_customRedirectDomain :: Lens' TrackingOptions Text Source #

The domain to use for tracking open and click events.

VolumeStatistics

volumeStatistics_inboxRawCount :: Lens' VolumeStatistics (Maybe Integer) Source #

The total number of emails that arrived in recipients' inboxes.

volumeStatistics_projectedSpam :: Lens' VolumeStatistics (Maybe Integer) Source #

An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.

volumeStatistics_projectedInbox :: Lens' VolumeStatistics (Maybe Integer) Source #

An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.

volumeStatistics_spamRawCount :: Lens' VolumeStatistics (Maybe Integer) Source #

The total number of emails that arrived in recipients' spam or junk mail folders.