File Coverage

blib/lib/Paws/SES/IdentityMailFromDomainAttributes.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::SES::IdentityMailFromDomainAttributes;
2 1     1   493 use Moose;
  1         2  
  1         11  
3             has BehaviorOnMXFailure => (is => 'ro', isa => 'Str', required => 1);
4             has MailFromDomain => (is => 'ro', isa => 'Str', required => 1);
5             has MailFromDomainStatus => (is => 'ro', isa => 'Str', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::SES::IdentityMailFromDomainAttributes
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::IdentityMailFromDomainAttributes object:
24              
25             $service_obj->Method(Att1 => { BehaviorOnMXFailure => $value, ..., MailFromDomainStatus => $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::IdentityMailFromDomainAttributes object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->BehaviorOnMXFailure
33              
34             =head1 DESCRIPTION
35              
36             Represents the custom MAIL FROM domain attributes of a verified
37             identity (email address or domain).
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 B<REQUIRED> BehaviorOnMXFailure => Str
43              
44             The action that Amazon SES takes if it cannot successfully read the
45             required MX record when you send an email. A value of
46             C<UseDefaultValue> indicates that if Amazon SES cannot read the
47             required MX record, it uses amazonses.com (or a subdomain of that) as
48             the MAIL FROM domain. A value of C<RejectMessage> indicates that if
49             Amazon SES cannot read the required MX record, Amazon SES returns a
50             C<MailFromDomainNotVerified> error and does not send the email.
51              
52             The custom MAIL FROM setup states that result in this behavior are
53             C<Pending>, C<Failed>, and C<TemporaryFailure>.
54              
55              
56             =head2 B<REQUIRED> MailFromDomain => Str
57              
58             The custom MAIL FROM domain that the identity is configured to use.
59              
60              
61             =head2 B<REQUIRED> MailFromDomainStatus => Str
62              
63             The state that indicates whether Amazon SES has successfully read the
64             MX record required for custom MAIL FROM domain setup. If the state is
65             C<Success>, Amazon SES uses the specified custom MAIL FROM domain when
66             the verified identity sends an email. All other states indicate that
67             Amazon SES takes the action described by C<BehaviorOnMXFailure>.
68              
69              
70              
71             =head1 SEE ALSO
72              
73             This class forms part of L<Paws>, describing an object used in L<Paws::SES>
74              
75             =head1 BUGS and CONTRIBUTIONS
76              
77             The source code is located here: https://github.com/pplu/aws-sdk-perl
78              
79             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
80              
81             =cut
82