File Coverage

blib/lib/Paws/SES/SetIdentityMailFromDomain.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              
2             package Paws::SES::SetIdentityMailFromDomain;
3 1     1   273 use Moose;
  1         3  
  1         8  
4             has BehaviorOnMXFailure => (is => 'ro', isa => 'Str');
5             has Identity => (is => 'ro', isa => 'Str', required => 1);
6             has MailFromDomain => (is => 'ro', isa => 'Str');
7              
8 1     1   5307 use MooseX::ClassAttribute;
  1         2  
  1         8  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetIdentityMailFromDomain');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SES::SetIdentityMailFromDomainResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro', default => 'SetIdentityMailFromDomainResult');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::SES::SetIdentityMailFromDomain - Arguments for method SetIdentityMailFromDomain on Paws::SES
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method SetIdentityMailFromDomain on the
24             Amazon Simple Email Service service. Use the attributes of this class
25             as arguments to method SetIdentityMailFromDomain.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetIdentityMailFromDomain.
28              
29             As an example:
30              
31             $service_obj->SetIdentityMailFromDomain(Att1 => $value1, Att2 => $value2, ...);
32              
33             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 BehaviorOnMXFailure => Str
39              
40             The action that you want Amazon SES to take if it cannot successfully
41             read the required MX record when you send an email. If you choose
42             C<UseDefaultValue>, Amazon SES will use amazonses.com (or a subdomain
43             of that) as the MAIL FROM domain. If you choose C<RejectMessage>,
44             Amazon SES will return a C<MailFromDomainNotVerified> error and not
45             send the email.
46              
47             The action specified in C<BehaviorOnMXFailure> is taken when the custom
48             MAIL FROM domain setup is in the C<Pending>, C<Failed>, and
49             C<TemporaryFailure> states.
50              
51             Valid values are: C<"UseDefaultValue">, C<"RejectMessage">
52              
53             =head2 B<REQUIRED> Identity => Str
54              
55             The verified identity for which you want to enable or disable the
56             specified custom MAIL FROM domain.
57              
58              
59              
60             =head2 MailFromDomain => Str
61              
62             The custom MAIL FROM domain that you want the verified identity to use.
63             The MAIL FROM domain must 1) be a subdomain of the verified identity,
64             2) not be used in a "From" address if the MAIL FROM domain is the
65             destination of email feedback forwarding (for more information, see the
66             Amazon SES Developer Guide), and 3) not be used to receive emails. A
67             value of C<null> disables the custom MAIL FROM setting for the
68             identity.
69              
70              
71              
72              
73             =head1 SEE ALSO
74              
75             This class forms part of L<Paws>, documenting arguments for method SetIdentityMailFromDomain in L<Paws::SES>
76              
77             =head1 BUGS and CONTRIBUTIONS
78              
79             The source code is located here: https://github.com/pplu/aws-sdk-perl
80              
81             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
82              
83             =cut
84