« blib/lib/Paws/SES/SetIdentityHeadersInNotificationsEnabledResponse.pm
↑ Summary
blib/lib/Paws/SES/SetIdentityMailFromDomainResponse.pm »
| 1 | |||
| 2 | package Paws::SES::SetIdentityMailFromDomain; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::SES> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method SetIdentityMailFromDomain on the | ||
| 24 | L<Amazon Simple Email Service|Paws::SES> 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 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $email = Paws->service('SES'); | ||
| 32 | # SetIdentityMailFromDomain | ||
| 33 | # The following example configures Amazon SES to use a custom MAIL FROM domain | ||
| 34 | # for an identity: | ||
| 35 | my $SetIdentityMailFromDomainResponse = $email->SetIdentityMailFromDomain( | ||
| 36 | 'BehaviorOnMXFailure' => 'UseDefaultValue', | ||
| 37 | 'Identity' => 'user@example.com', | ||
| 38 | 'MailFromDomain' => 'bounces.example.com' | ||
| 39 | ); | ||
| 40 | |||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/SetIdentityMailFromDomain> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 BehaviorOnMXFailure => Str | ||
| 49 | |||
| 50 | The action that you want Amazon SES to take if it cannot successfully | ||
| 51 | read the required MX record when you send an email. If you choose | ||
| 52 | C<UseDefaultValue>, Amazon SES will use amazonses.com (or a subdomain | ||
| 53 | of that) as the MAIL FROM domain. If you choose C<RejectMessage>, | ||
| 54 | Amazon SES will return a C<MailFromDomainNotVerified> error and not | ||
| 55 | send the email. | ||
| 56 | |||
| 57 | The action specified in C<BehaviorOnMXFailure> is taken when the custom | ||
| 58 | MAIL FROM domain setup is in the C<Pending>, C<Failed>, and | ||
| 59 | C<TemporaryFailure> states. | ||
| 60 | |||
| 61 | Valid values are: C<"UseDefaultValue">, C<"RejectMessage"> | ||
| 62 | |||
| 63 | =head2 B<REQUIRED> Identity => Str | ||
| 64 | |||
| 65 | The verified identity for which you want to enable or disable the | ||
| 66 | specified custom MAIL FROM domain. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 MailFromDomain => Str | ||
| 71 | |||
| 72 | The custom MAIL FROM domain that you want the verified identity to use. | ||
| 73 | The MAIL FROM domain must 1) be a subdomain of the verified identity, | ||
| 74 | 2) not be used in a "From" address if the MAIL FROM domain is the | ||
| 75 | destination of email feedback forwarding (for more information, see the | ||
| 76 | Amazon SES Developer Guide | ||
| 77 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from.html)), | ||
| 78 | and 3) not be used to receive emails. A value of C<null> disables the | ||
| 79 | custom MAIL FROM setting for the identity. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method SetIdentityMailFromDomain in L<Paws::SES> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |