| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SESv2::DkimAttributes; | ||
| 3 | use Moose; | ||
| 4 | has SigningAttributesOrigin => (is => 'ro', isa => 'Str'); | ||
| 5 | has SigningEnabled => (is => 'ro', isa => 'Bool'); | ||
| 6 | has Status => (is => 'ro', isa => 'Str'); | ||
| 7 | has Tokens => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::SESv2::DkimAttributes | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::SESv2::DkimAttributes object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { SigningAttributesOrigin => $value, ..., Tokens => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::SESv2::DkimAttributes object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->SigningAttributesOrigin | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | An object that contains information about the DKIM authentication | ||
| 40 | status for an email identity. | ||
| 41 | |||
| 42 | Amazon SES determines the authentication status by searching for | ||
| 43 | specific records in the DNS configuration for the domain. If you used | ||
| 44 | Easy DKIM | ||
| 45 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) | ||
| 46 | to set up DKIM authentication, Amazon SES tries to find three unique | ||
| 47 | CNAME records in the DNS configuration for your domain. If you provided | ||
| 48 | a public key to perform DKIM authentication, Amazon SES tries to find a | ||
| 49 | TXT record that uses the selector that you specified. The value of the | ||
| 50 | TXT record must be a public key that's paired with the private key that | ||
| 51 | you specified in the process of creating the identity | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 SigningAttributesOrigin => Str | ||
| 57 | |||
| 58 | A string that indicates how DKIM was configured for the identity. There | ||
| 59 | are two possible values: | ||
| 60 | |||
| 61 | =over | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | C<AWS_SES> E<ndash> Indicates that DKIM was configured for the identity | ||
| 66 | by using Easy DKIM | ||
| 67 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html). | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | C<EXTERNAL> E<ndash> Indicates that DKIM was configured for the | ||
| 72 | identity by using Bring Your Own DKIM (BYODKIM). | ||
| 73 | |||
| 74 | =back | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 SigningEnabled => Bool | ||
| 79 | |||
| 80 | If the value is C<true>, then the messages that you send from the | ||
| 81 | identity are signed using DKIM. If the value is C<false>, then the | ||
| 82 | messages that you send from the identity aren't DKIM-signed. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 Status => Str | ||
| 86 | |||
| 87 | Describes whether or not Amazon SES has successfully located the DKIM | ||
| 88 | records in the DNS records for the domain. The status can be one of the | ||
| 89 | following: | ||
| 90 | |||
| 91 | =over | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<PENDING> E<ndash> The verification process was initiated, but Amazon | ||
| 96 | SES hasn't yet detected the DKIM records in the DNS configuration for | ||
| 97 | the domain. | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | C<SUCCESS> E<ndash> The verification process completed successfully. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<FAILED> E<ndash> The verification process failed. This typically | ||
| 106 | occurs when Amazon SES fails to find the DKIM records in the DNS | ||
| 107 | configuration of the domain. | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | C<TEMPORARY_FAILURE> E<ndash> A temporary issue is preventing Amazon | ||
| 112 | SES from determining the DKIM authentication status of the domain. | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | C<NOT_STARTED> E<ndash> The DKIM verification process hasn't been | ||
| 117 | initiated for the domain. | ||
| 118 | |||
| 119 | =back | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 Tokens => ArrayRef[Str|Undef] | ||
| 124 | |||
| 125 | If you used Easy DKIM | ||
| 126 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html) | ||
| 127 | to configure DKIM authentication for the domain, then this object | ||
| 128 | contains a set of unique strings that you use to create a set of CNAME | ||
| 129 | records that you add to the DNS configuration for your domain. When | ||
| 130 | Amazon SES detects these records in the DNS configuration for your | ||
| 131 | domain, the DKIM authentication process is complete. | ||
| 132 | |||
| 133 | If you configured DKIM authentication for the domain by providing your | ||
| 134 | own public-private key pair, then this object contains the selector for | ||
| 135 | the public key. | ||
| 136 | |||
| 137 | Regardless of the DKIM authentication method you use, Amazon SES | ||
| 138 | searches for the appropriate records in the DNS configuration of the | ||
| 139 | domain for up to 72 hours. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, describing an object used in L<Paws::SESv2> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |