« blib/lib/Paws/SESv2/SendCustomVerificationEmailResponse.pm
↑ Summary
blib/lib/Paws/SESv2/SendEmailResponse.pm »
| 1 | |||
| 2 | package Paws::SESv2::SendEmail; | ||
| 3 | use Moose; | ||
| 4 | has ConfigurationSetName => (is => 'ro', isa => 'Str'); | ||
| 5 | has Content => (is => 'ro', isa => 'Paws::SESv2::EmailContent', required => 1); | ||
| 6 | has Destination => (is => 'ro', isa => 'Paws::SESv2::Destination'); | ||
| 7 | has EmailTags => (is => 'ro', isa => 'ArrayRef[Paws::SESv2::MessageTag]'); | ||
| 8 | has FeedbackForwardingEmailAddress => (is => 'ro', isa => 'Str'); | ||
| 9 | has FeedbackForwardingEmailAddressIdentityArn => (is => 'ro', isa => 'Str'); | ||
| 10 | has FromEmailAddress => (is => 'ro', isa => 'Str'); | ||
| 11 | has FromEmailAddressIdentityArn => (is => 'ro', isa => 'Str'); | ||
| 12 | has ListManagementOptions => (is => 'ro', isa => 'Paws::SESv2::ListManagementOptions'); | ||
| 13 | has ReplyToAddresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendEmail'); | ||
| 18 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v2/email/outbound-emails'); | ||
| 19 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SESv2::SendEmailResponse'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::SESv2::SendEmail - Arguments for method SendEmail on L<Paws::SESv2> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method SendEmail on the | ||
| 32 | L<Amazon Simple Email Service|Paws::SESv2> service. Use the attributes of this class | ||
| 33 | as arguments to method SendEmail. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendEmail. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $email = Paws->service('SESv2'); | ||
| 40 | my $SendEmailResponse = $email->SendEmail( | ||
| 41 | Content => { | ||
| 42 | Raw => { | ||
| 43 | Data => 'BlobRawMessageData', | ||
| 44 | |||
| 45 | }, # OPTIONAL | ||
| 46 | Simple => { | ||
| 47 | Body => { | ||
| 48 | Html => { | ||
| 49 | Data => 'MyMessageData', | ||
| 50 | Charset => 'MyCharset', # OPTIONAL | ||
| 51 | }, # OPTIONAL | ||
| 52 | Text => { | ||
| 53 | Data => 'MyMessageData', | ||
| 54 | Charset => 'MyCharset', # OPTIONAL | ||
| 55 | }, # OPTIONAL | ||
| 56 | }, | ||
| 57 | Subject => { | ||
| 58 | Data => 'MyMessageData', | ||
| 59 | Charset => 'MyCharset', # OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | |||
| 62 | }, # OPTIONAL | ||
| 63 | Template => { | ||
| 64 | TemplateArn => 'MyAmazonResourceName', # OPTIONAL | ||
| 65 | TemplateData => 'MyEmailTemplateData', # max: 262144; OPTIONAL | ||
| 66 | TemplateName => 'MyEmailTemplateName', # min: 1; OPTIONAL | ||
| 67 | }, # OPTIONAL | ||
| 68 | }, | ||
| 69 | ConfigurationSetName => 'MyConfigurationSetName', # OPTIONAL | ||
| 70 | Destination => { | ||
| 71 | BccAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL | ||
| 72 | CcAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL | ||
| 73 | ToAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL | ||
| 74 | }, # OPTIONAL | ||
| 75 | EmailTags => [ | ||
| 76 | { | ||
| 77 | Name => 'MyMessageTagName', | ||
| 78 | Value => 'MyMessageTagValue', | ||
| 79 | |||
| 80 | }, | ||
| 81 | ... | ||
| 82 | ], # OPTIONAL | ||
| 83 | FeedbackForwardingEmailAddress => 'MyEmailAddress', # OPTIONAL | ||
| 84 | FeedbackForwardingEmailAddressIdentityArn => | ||
| 85 | 'MyAmazonResourceName', # OPTIONAL | ||
| 86 | FromEmailAddress => 'MyEmailAddress', # OPTIONAL | ||
| 87 | FromEmailAddressIdentityArn => 'MyAmazonResourceName', # OPTIONAL | ||
| 88 | ListManagementOptions => { | ||
| 89 | ContactListName => 'MyContactListName', | ||
| 90 | TopicName => 'MyTopicName', # OPTIONAL | ||
| 91 | }, # OPTIONAL | ||
| 92 | ReplyToAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL | ||
| 93 | ); | ||
| 94 | |||
| 95 | # Results: | ||
| 96 | my $MessageId = $SendEmailResponse->MessageId; | ||
| 97 | |||
| 98 | # Returns a L<Paws::SESv2::SendEmailResponse> object. | ||
| 99 | |||
| 100 | 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. | ||
| 101 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/SendEmail> | ||
| 102 | |||
| 103 | =head1 ATTRIBUTES | ||
| 104 | |||
| 105 | |||
| 106 | =head2 ConfigurationSetName => Str | ||
| 107 | |||
| 108 | The name of the configuration set that you want to use when sending the | ||
| 109 | email. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> Content => L<Paws::SESv2::EmailContent> | ||
| 114 | |||
| 115 | An object that contains the body of the message. You can send either a | ||
| 116 | Simple message Raw message or a template Message. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 Destination => L<Paws::SESv2::Destination> | ||
| 121 | |||
| 122 | An object that contains the recipients of the email message. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 EmailTags => ArrayRef[L<Paws::SESv2::MessageTag>] | ||
| 127 | |||
| 128 | A list of tags, in the form of name/value pairs, to apply to an email | ||
| 129 | that you send using the C<SendEmail> operation. Tags correspond to | ||
| 130 | characteristics of the email that you define, so that you can publish | ||
| 131 | email sending events. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 FeedbackForwardingEmailAddress => Str | ||
| 136 | |||
| 137 | The address that you want bounce and complaint notifications to be sent | ||
| 138 | to. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 FeedbackForwardingEmailAddressIdentityArn => Str | ||
| 143 | |||
| 144 | This parameter is used only for sending authorization. It is the ARN of | ||
| 145 | the identity that is associated with the sending authorization policy | ||
| 146 | that permits you to use the email address specified in the | ||
| 147 | C<FeedbackForwardingEmailAddress> parameter. | ||
| 148 | |||
| 149 | For example, if the owner of example.com (which has ARN | ||
| 150 | arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a | ||
| 151 | policy to it that authorizes you to use feedback@example.com, then you | ||
| 152 | would specify the C<FeedbackForwardingEmailAddressIdentityArn> to be | ||
| 153 | arn:aws:ses:us-east-1:123456789012:identity/example.com, and the | ||
| 154 | C<FeedbackForwardingEmailAddress> to be feedback@example.com. | ||
| 155 | |||
| 156 | For more information about sending authorization, see the Amazon SES | ||
| 157 | Developer Guide | ||
| 158 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head2 FromEmailAddress => Str | ||
| 163 | |||
| 164 | The email address that you want to use as the "From" address for the | ||
| 165 | email. The address that you specify has to be verified. | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head2 FromEmailAddressIdentityArn => Str | ||
| 170 | |||
| 171 | This parameter is used only for sending authorization. It is the ARN of | ||
| 172 | the identity that is associated with the sending authorization policy | ||
| 173 | that permits you to use the email address specified in the | ||
| 174 | C<FromEmailAddress> parameter. | ||
| 175 | |||
| 176 | For example, if the owner of example.com (which has ARN | ||
| 177 | arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a | ||
| 178 | policy to it that authorizes you to use sender@example.com, then you | ||
| 179 | would specify the C<FromEmailAddressIdentityArn> to be | ||
| 180 | arn:aws:ses:us-east-1:123456789012:identity/example.com, and the | ||
| 181 | C<FromEmailAddress> to be sender@example.com. | ||
| 182 | |||
| 183 | For more information about sending authorization, see the Amazon SES | ||
| 184 | Developer Guide | ||
| 185 | (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html). | ||
| 186 | |||
| 187 | For Raw emails, the C<FromEmailAddressIdentityArn> value overrides the | ||
| 188 | X-SES-SOURCE-ARN and X-SES-FROM-ARN headers specified in raw email | ||
| 189 | message content. | ||
| 190 | |||
| 191 | |||
| 192 | |||
| 193 | =head2 ListManagementOptions => L<Paws::SESv2::ListManagementOptions> | ||
| 194 | |||
| 195 | An object used to specify a list or topic to which an email belongs, | ||
| 196 | which will be used when a contact chooses to unsubscribe. | ||
| 197 | |||
| 198 | |||
| 199 | |||
| 200 | =head2 ReplyToAddresses => ArrayRef[Str|Undef] | ||
| 201 | |||
| 202 | The "Reply-to" email addresses for the message. When the recipient | ||
| 203 | replies to the message, each Reply-to address receives the reply. | ||
| 204 | |||
| 205 | |||
| 206 | |||
| 207 | |||
| 208 | =head1 SEE ALSO | ||
| 209 | |||
| 210 | This class forms part of L<Paws>, documenting arguments for method SendEmail in L<Paws::SESv2> | ||
| 211 | |||
| 212 | =head1 BUGS and CONTRIBUTIONS | ||
| 213 | |||
| 214 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 215 | |||
| 216 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 217 | |||
| 218 | =cut | ||
| 219 |