| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SESv2::EmailContent; | ||
| 3 | use Moose; | ||
| 4 | has Raw => (is => 'ro', isa => 'Paws::SESv2::RawMessage'); | ||
| 5 | has Simple => (is => 'ro', isa => 'Paws::SESv2::Message'); | ||
| 6 | has Template => (is => 'ro', isa => 'Paws::SESv2::Template'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::SESv2::EmailContent | ||
| 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::SESv2::EmailContent object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Raw => $value, ..., Template => $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::SESv2::EmailContent object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Raw | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | An object that defines the entire content of the email, including the | ||
| 39 | message headers and the body content. You can create a simple email | ||
| 40 | message, in which you specify the subject and the text and HTML | ||
| 41 | versions of the message body. You can also create raw messages, in | ||
| 42 | which you specify a complete MIME-formatted message. Raw messages can | ||
| 43 | include attachments and custom headers. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 Raw => L<Paws::SESv2::RawMessage> | ||
| 49 | |||
| 50 | The raw email message. The message has to meet the following criteria: | ||
| 51 | |||
| 52 | =over | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | The message has to contain a header and a body, separated by one blank | ||
| 57 | line. | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | All of the required header fields must be present in the message. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | Each part of a multipart MIME message must be formatted properly. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | If you include attachments, they must be in a file format that the | ||
| 70 | Amazon SES API v2 supports. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | The entire message must be Base64 encoded. | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | If any of the MIME parts in your message contain content that is | ||
| 79 | outside of the 7-bit ASCII character range, you should encode that | ||
| 80 | content to ensure that recipients' email clients render the message | ||
| 81 | properly. | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | The length of any single line of text in the message can't exceed 1,000 | ||
| 86 | characters. This restriction is defined in RFC 5321 | ||
| 87 | (https://tools.ietf.org/html/rfc5321). | ||
| 88 | |||
| 89 | =back | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 Simple => L<Paws::SESv2::Message> | ||
| 94 | |||
| 95 | The simple email message. The message consists of a subject and a | ||
| 96 | message body. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 Template => L<Paws::SESv2::Template> | ||
| 100 | |||
| 101 | The template to use for the email message. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, describing an object used in L<Paws::SESv2> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |