« blib/lib/Paws/PinpointEmail/PutEmailIdentityFeedbackAttributesResponse.pm
↑ Summary
blib/lib/Paws/PinpointEmail/PutEmailIdentityMailFromAttributesResponse.pm »
| 1 | |||
| 2 | package Paws::PinpointEmail::PutEmailIdentityMailFromAttributes; | ||
| 3 | use Moose; | ||
| 4 | has BehaviorOnMxFailure => (is => 'ro', isa => 'Str'); | ||
| 5 | has EmailIdentity => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'EmailIdentity', 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 => 'PutEmailIdentityMailFromAttributes'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/email/identities/{EmailIdentity}/mail-from'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PinpointEmail::PutEmailIdentityMailFromAttributesResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::PinpointEmail::PutEmailIdentityMailFromAttributes - Arguments for method PutEmailIdentityMailFromAttributes on L<Paws::PinpointEmail> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method PutEmailIdentityMailFromAttributes on the | ||
| 25 | L<Amazon Pinpoint Email Service|Paws::PinpointEmail> service. Use the attributes of this class | ||
| 26 | as arguments to method PutEmailIdentityMailFromAttributes. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutEmailIdentityMailFromAttributes. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $email = Paws->service('PinpointEmail'); | ||
| 33 | my $PutEmailIdentityMailFromAttributesResponse = | ||
| 34 | $email->PutEmailIdentityMailFromAttributes( | ||
| 35 | EmailIdentity => 'MyIdentity', | ||
| 36 | BehaviorOnMxFailure => 'USE_DEFAULT_VALUE', # OPTIONAL | ||
| 37 | MailFromDomain => 'MyMailFromDomainName', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/PutEmailIdentityMailFromAttributes> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 BehaviorOnMxFailure => Str | ||
| 47 | |||
| 48 | The action that you want Amazon Pinpoint to take if it can't read the | ||
| 49 | required MX record when you send an email. When you set this value to | ||
| 50 | C<UseDefaultValue>, Amazon Pinpoint uses I<amazonses.com> as the MAIL | ||
| 51 | FROM domain. When you set this value to C<RejectMessage>, Amazon | ||
| 52 | Pinpoint returns a C<MailFromDomainNotVerified> error, and doesn't | ||
| 53 | attempt to deliver the email. | ||
| 54 | |||
| 55 | These behaviors are taken when the custom MAIL FROM domain | ||
| 56 | configuration is in the C<Pending>, C<Failed>, and C<TemporaryFailure> | ||
| 57 | states. | ||
| 58 | |||
| 59 | Valid values are: C<"USE_DEFAULT_VALUE">, C<"REJECT_MESSAGE"> | ||
| 60 | |||
| 61 | =head2 B<REQUIRED> EmailIdentity => Str | ||
| 62 | |||
| 63 | The verified email identity that you want to set up the custom MAIL | ||
| 64 | FROM domain for. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 MailFromDomain => Str | ||
| 69 | |||
| 70 | The custom MAIL FROM domain that you want the verified identity to use. | ||
| 71 | The MAIL FROM domain must meet the following criteria: | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | It has to be a subdomain of the verified identity. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | It can't be used to receive email. | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | It can't be used in a "From" address if the MAIL FROM domain is a | ||
| 86 | destination for feedback forwarding emails. | ||
| 87 | |||
| 88 | =back | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method PutEmailIdentityMailFromAttributes in L<Paws::PinpointEmail> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |