« blib/lib/Paws/PinpointEmail/DkimAttributes.pm
↑ Summary
blib/lib/Paws/PinpointEmail/DomainDeliverabilityTrackingOption.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::PinpointEmail::DomainDeliverabilityCampaign; | ||
| 3 | use Moose; | ||
| 4 | has CampaignId => (is => 'ro', isa => 'Str'); | ||
| 5 | has DeleteRate => (is => 'ro', isa => 'Num'); | ||
| 6 | has Esps => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has FirstSeenDateTime => (is => 'ro', isa => 'Str'); | ||
| 8 | has FromAddress => (is => 'ro', isa => 'Str'); | ||
| 9 | has ImageUrl => (is => 'ro', isa => 'Str'); | ||
| 10 | has InboxCount => (is => 'ro', isa => 'Int'); | ||
| 11 | has LastSeenDateTime => (is => 'ro', isa => 'Str'); | ||
| 12 | has ProjectedVolume => (is => 'ro', isa => 'Int'); | ||
| 13 | has ReadDeleteRate => (is => 'ro', isa => 'Num'); | ||
| 14 | has ReadRate => (is => 'ro', isa => 'Num'); | ||
| 15 | has SendingIps => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 16 | has SpamCount => (is => 'ro', isa => 'Int'); | ||
| 17 | has Subject => (is => 'ro', isa => 'Str'); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::PinpointEmail::DomainDeliverabilityCampaign | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::PinpointEmail::DomainDeliverabilityCampaign object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { CampaignId => $value, ..., Subject => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::PinpointEmail::DomainDeliverabilityCampaign object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->CampaignId | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | An object that contains the deliverability data for a specific | ||
| 50 | campaign. This data is available for a campaign only if the campaign | ||
| 51 | sent email by using a domain that the Deliverability dashboard is | ||
| 52 | enabled for (C<PutDeliverabilityDashboardOption> operation). | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 CampaignId => Str | ||
| 58 | |||
| 59 | The unique identifier for the campaign. Amazon Pinpoint automatically | ||
| 60 | generates and assigns this identifier to a campaign. This value is not | ||
| 61 | the same as the campaign identifier that Amazon Pinpoint assigns to | ||
| 62 | campaigns that you create and manage by using the Amazon Pinpoint API | ||
| 63 | or the Amazon Pinpoint console. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 DeleteRate => Num | ||
| 67 | |||
| 68 | The percentage of email messages that were deleted by recipients, | ||
| 69 | without being opened first. Due to technical limitations, this value | ||
| 70 | only includes recipients who opened the message by using an email | ||
| 71 | client that supports images. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 Esps => ArrayRef[Str|Undef] | ||
| 75 | |||
| 76 | The major email providers who handled the email message. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 FirstSeenDateTime => Str | ||
| 80 | |||
| 81 | The first time, in Unix time format, when the email message was | ||
| 82 | delivered to any recipient's inbox. This value can help you determine | ||
| 83 | how long it took for a campaign to deliver an email message. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 FromAddress => Str | ||
| 87 | |||
| 88 | The verified email address that the email message was sent from. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 ImageUrl => Str | ||
| 92 | |||
| 93 | The URL of an image that contains a snapshot of the email message that | ||
| 94 | was sent. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 InboxCount => Int | ||
| 98 | |||
| 99 | The number of email messages that were delivered to recipientsE<rsquo> | ||
| 100 | inboxes. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 LastSeenDateTime => Str | ||
| 104 | |||
| 105 | The last time, in Unix time format, when the email message was | ||
| 106 | delivered to any recipient's inbox. This value can help you determine | ||
| 107 | how long it took for a campaign to deliver an email message. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 ProjectedVolume => Int | ||
| 111 | |||
| 112 | The projected number of recipients that the email message was sent to. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 ReadDeleteRate => Num | ||
| 116 | |||
| 117 | The percentage of email messages that were opened and then deleted by | ||
| 118 | recipients. Due to technical limitations, this value only includes | ||
| 119 | recipients who opened the message by using an email client that | ||
| 120 | supports images. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 ReadRate => Num | ||
| 124 | |||
| 125 | The percentage of email messages that were opened by recipients. Due to | ||
| 126 | technical limitations, this value only includes recipients who opened | ||
| 127 | the message by using an email client that supports images. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 SendingIps => ArrayRef[Str|Undef] | ||
| 131 | |||
| 132 | The IP addresses that were used to send the email message. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 SpamCount => Int | ||
| 136 | |||
| 137 | The number of email messages that were delivered to recipients' spam or | ||
| 138 | junk mail folders. | ||
| 139 | |||
| 140 | |||
| 141 | =head2 Subject => Str | ||
| 142 | |||
| 143 | The subject line, or title, of the email message. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head1 SEE ALSO | ||
| 148 | |||
| 149 | This class forms part of L<Paws>, describing an object used in L<Paws::PinpointEmail> | ||
| 150 | |||
| 151 | =head1 BUGS and CONTRIBUTIONS | ||
| 152 | |||
| 153 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 154 | |||
| 155 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 156 | |||
| 157 | =cut | ||
| 158 |