« blib/lib/Paws/PinpointEmail/ListTagsForResourceResponse.pm
↑ Summary
blib/lib/Paws/PinpointEmail/Message.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::PinpointEmail::MailFromAttributes; | ||
| 3 | use Moose; | ||
| 4 | has BehaviorOnMxFailure => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has MailFromDomain => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has MailFromDomainStatus => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::PinpointEmail::MailFromAttributes | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::PinpointEmail::MailFromAttributes object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { BehaviorOnMxFailure => $value, ..., MailFromDomainStatus => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::PinpointEmail::MailFromAttributes object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->BehaviorOnMxFailure | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | A list of attributes that are associated with a MAIL FROM domain. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 B<REQUIRED> BehaviorOnMxFailure => Str | ||
| 44 | |||
| 45 | The action that Amazon Pinpoint to takes if it can't read the required | ||
| 46 | MX record for a custom MAIL FROM domain. When you set this value to | ||
| 47 | C<UseDefaultValue>, Amazon Pinpoint uses I<amazonses.com> as the MAIL | ||
| 48 | FROM domain. When you set this value to C<RejectMessage>, Amazon | ||
| 49 | Pinpoint returns a C<MailFromDomainNotVerified> error, and doesn't | ||
| 50 | attempt to deliver the email. | ||
| 51 | |||
| 52 | These behaviors are taken when the custom MAIL FROM domain | ||
| 53 | configuration is in the C<Pending>, C<Failed>, and C<TemporaryFailure> | ||
| 54 | states. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> MailFromDomain => Str | ||
| 58 | |||
| 59 | The name of a domain that an email identity uses as a custom MAIL FROM | ||
| 60 | domain. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> MailFromDomainStatus => Str | ||
| 64 | |||
| 65 | The status of the MAIL FROM domain. This status can have the following | ||
| 66 | values: | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<PENDING> E<ndash> Amazon Pinpoint hasn't started searching for the MX | ||
| 73 | record yet. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<SUCCESS> E<ndash> Amazon Pinpoint detected the required MX record for | ||
| 78 | the MAIL FROM domain. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<FAILED> E<ndash> Amazon Pinpoint can't find the required MX record, | ||
| 83 | or the record no longer exists. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<TEMPORARY_FAILURE> E<ndash> A temporary issue occurred, which | ||
| 88 | prevented Amazon Pinpoint from determining the status of the MAIL FROM | ||
| 89 | domain. | ||
| 90 | |||
| 91 | =back | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, describing an object used in L<Paws::PinpointEmail> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |