libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email
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.PinpointEmail.Types.DomainDeliverabilityCampaign

Description

 
Synopsis

Documentation

data DomainDeliverabilityCampaign Source #

An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

See: newDomainDeliverabilityCampaign smart constructor.

Constructors

DomainDeliverabilityCampaign' 

Fields

  • spamCount :: Maybe Integer

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

  • subject :: Maybe Text

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

  • esps :: Maybe [Text]

    The major email providers who handled the email message.

  • fromAddress :: Maybe Text

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

  • deleteRate :: Maybe Double

    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.

  • campaignId :: Maybe Text

    The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

  • sendingIps :: Maybe [Text]

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

  • firstSeenDateTime :: Maybe POSIX

    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.

  • inboxCount :: Maybe Integer

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

  • readDeleteRate :: Maybe Double

    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.

  • projectedVolume :: Maybe Integer

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

  • imageUrl :: Maybe Text

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

  • readRate :: Maybe Double

    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.

  • lastSeenDateTime :: Maybe POSIX

    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.

Instances

Instances details
Eq DomainDeliverabilityCampaign Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DomainDeliverabilityCampaign

Read DomainDeliverabilityCampaign Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DomainDeliverabilityCampaign

Show DomainDeliverabilityCampaign Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DomainDeliverabilityCampaign

Generic DomainDeliverabilityCampaign Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DomainDeliverabilityCampaign

Associated Types

type Rep DomainDeliverabilityCampaign :: Type -> Type #

NFData DomainDeliverabilityCampaign Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DomainDeliverabilityCampaign

Hashable DomainDeliverabilityCampaign Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DomainDeliverabilityCampaign

FromJSON DomainDeliverabilityCampaign Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DomainDeliverabilityCampaign

type Rep DomainDeliverabilityCampaign Source # 
Instance details

Defined in Amazonka.PinpointEmail.Types.DomainDeliverabilityCampaign

type Rep DomainDeliverabilityCampaign = D1 ('MetaData "DomainDeliverabilityCampaign" "Amazonka.PinpointEmail.Types.DomainDeliverabilityCampaign" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "DomainDeliverabilityCampaign'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "spamCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "esps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "fromAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deleteRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "campaignId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sendingIps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "firstSeenDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "inboxCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "readDeleteRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :*: ((S1 ('MetaSel ('Just "projectedVolume") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "imageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "readRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "lastSeenDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newDomainDeliverabilityCampaign :: DomainDeliverabilityCampaign Source #

Create a value of DomainDeliverabilityCampaign with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:spamCount:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_spamCount - The number of email messages that were delivered to recipients' spam or junk mail folders.

$sel:subject:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_subject - The subject line, or title, of the email message.

$sel:esps:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_esps - The major email providers who handled the email message.

$sel:fromAddress:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_fromAddress - The verified email address that the email message was sent from.

$sel:deleteRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_deleteRate - 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.

$sel:campaignId:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_campaignId - The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

$sel:sendingIps:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_sendingIps - The IP addresses that were used to send the email message.

$sel:firstSeenDateTime:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_firstSeenDateTime - 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.

$sel:inboxCount:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_inboxCount - The number of email messages that were delivered to recipients’ inboxes.

$sel:readDeleteRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_readDeleteRate - 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.

$sel:projectedVolume:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_projectedVolume - The projected number of recipients that the email message was sent to.

$sel:imageUrl:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_imageUrl - The URL of an image that contains a snapshot of the email message that was sent.

$sel:readRate:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_readRate - 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.

$sel:lastSeenDateTime:DomainDeliverabilityCampaign', domainDeliverabilityCampaign_lastSeenDateTime - 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.

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. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

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.