File Coverage

blib/lib/Paws/SES/IdentityDkimAttributes.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Paws::SES::IdentityDkimAttributes;
2 1     1   437 use Moose;
  1     1   2  
  1         9  
  1         299  
  1         1  
  1         6  
3             has DkimEnabled => (is => 'ro', isa => 'Bool', required => 1);
4             has DkimTokens => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has DkimVerificationStatus => (is => 'ro', isa => 'Str', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::SES::IdentityDkimAttributes
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::SES::IdentityDkimAttributes object:
24              
25             $service_obj->Method(Att1 => { DkimEnabled => $value, ..., DkimVerificationStatus => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::SES::IdentityDkimAttributes object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->DkimEnabled
33              
34             =head1 DESCRIPTION
35              
36             Represents the DKIM attributes of a verified email address or a domain.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 B<REQUIRED> DkimEnabled => Bool
42              
43             True if DKIM signing is enabled for email sent from the identity; false
44             otherwise. The default value is true.
45              
46              
47             =head2 DkimTokens => ArrayRef[Str|Undef]
48              
49             A set of character strings that represent the domain's identity. Using
50             these tokens, you will need to create DNS CNAME records that point to
51             DKIM public keys hosted by Amazon SES. Amazon Web Services will
52             eventually detect that you have updated your DNS records; this
53             detection process may take up to 72 hours. Upon successful detection,
54             Amazon SES will be able to DKIM-sign email originating from that
55             domain. (This only applies to domain identities, not email address
56             identities.)
57              
58             For more information about creating DNS records using DKIM tokens, go
59             to the Amazon SES Developer Guide.
60              
61              
62             =head2 B<REQUIRED> DkimVerificationStatus => Str
63              
64             Describes whether Amazon SES has successfully verified the DKIM DNS
65             records (tokens) published in the domain name's DNS. (This only applies
66             to domain identities, not email address identities.)
67              
68              
69              
70             =head1 SEE ALSO
71              
72             This class forms part of L<Paws>, describing an object used in L<Paws::SES>
73              
74             =head1 BUGS and CONTRIBUTIONS
75              
76             The source code is located here: https://github.com/pplu/aws-sdk-perl
77              
78             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
79              
80             =cut
81