« blib/lib/Paws/PinpointEmail/ReputationOptions.pm
↑ Summary
blib/lib/Paws/PinpointEmail/SendEmailResponse.pm »
| 1 | |||
| 2 | package Paws::PinpointEmail::SendEmail; | ||
| 3 | use Moose; | ||
| 4 | has ConfigurationSetName => (is => 'ro', isa => 'Str'); | ||
| 5 | has Content => (is => 'ro', isa => 'Paws::PinpointEmail::EmailContent', required => 1); | ||
| 6 | has Destination => (is => 'ro', isa => 'Paws::PinpointEmail::Destination', required => 1); | ||
| 7 | has EmailTags => (is => 'ro', isa => 'ArrayRef[Paws::PinpointEmail::MessageTag]'); | ||
| 8 | has FeedbackForwardingEmailAddress => (is => 'ro', isa => 'Str'); | ||
| 9 | has FromEmailAddress => (is => 'ro', isa => 'Str'); | ||
| 10 | has ReplyToAddresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendEmail'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/email/outbound-emails'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PinpointEmail::SendEmailResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::PinpointEmail::SendEmail - Arguments for method SendEmail on L<Paws::PinpointEmail> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method SendEmail on the | ||
| 29 | L<Amazon Pinpoint Email Service|Paws::PinpointEmail> service. Use the attributes of this class | ||
| 30 | as arguments to method SendEmail. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendEmail. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $email = Paws->service('PinpointEmail'); | ||
| 37 | my $SendEmailResponse = $email->SendEmail( | ||
| 38 | Content => { | ||
| 39 | Raw => { | ||
| 40 | Data => 'BlobRawMessageData', | ||
| 41 | |||
| 42 | }, # OPTIONAL | ||
| 43 | Simple => { | ||
| 44 | Body => { | ||
| 45 | Html => { | ||
| 46 | Data => 'MyMessageData', | ||
| 47 | Charset => 'MyCharset', # OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | Text => { | ||
| 50 | Data => 'MyMessageData', | ||
| 51 | Charset => 'MyCharset', # OPTIONAL | ||
| 52 | }, # OPTIONAL | ||
| 53 | }, | ||
| 54 | Subject => { | ||
| 55 | Data => 'MyMessageData', | ||
| 56 | Charset => 'MyCharset', # OPTIONAL | ||
| 57 | }, # OPTIONAL | ||
| 58 | |||
| 59 | }, # OPTIONAL | ||
| 60 | Template => { | ||
| 61 | TemplateArn => 'MyTemplateArn', # OPTIONAL | ||
| 62 | TemplateData => 'MyTemplateData', # max: 262144; OPTIONAL | ||
| 63 | }, # OPTIONAL | ||
| 64 | }, | ||
| 65 | Destination => { | ||
| 66 | BccAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL | ||
| 67 | CcAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL | ||
| 68 | ToAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL | ||
| 69 | }, | ||
| 70 | ConfigurationSetName => 'MyConfigurationSetName', # OPTIONAL | ||
| 71 | EmailTags => [ | ||
| 72 | { | ||
| 73 | Name => 'MyMessageTagName', | ||
| 74 | Value => 'MyMessageTagValue', | ||
| 75 | |||
| 76 | }, | ||
| 77 | ... | ||
| 78 | ], # OPTIONAL | ||
| 79 | FeedbackForwardingEmailAddress => 'MyEmailAddress', # OPTIONAL | ||
| 80 | FromEmailAddress => 'MyEmailAddress', # OPTIONAL | ||
| 81 | ReplyToAddresses => [ 'MyEmailAddress', ... ], # OPTIONAL | ||
| 82 | ); | ||
| 83 | |||
| 84 | # Results: | ||
| 85 | my $MessageId = $SendEmailResponse->MessageId; | ||
| 86 | |||
| 87 | # Returns a L<Paws::PinpointEmail::SendEmailResponse> object. | ||
| 88 | |||
| 89 | 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. | ||
| 90 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/email/SendEmail> | ||
| 91 | |||
| 92 | =head1 ATTRIBUTES | ||
| 93 | |||
| 94 | |||
| 95 | =head2 ConfigurationSetName => Str | ||
| 96 | |||
| 97 | The name of the configuration set that you want to use when sending the | ||
| 98 | email. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> Content => L<Paws::PinpointEmail::EmailContent> | ||
| 103 | |||
| 104 | An object that contains the body of the message. You can send either a | ||
| 105 | Simple message or a Raw message. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 B<REQUIRED> Destination => L<Paws::PinpointEmail::Destination> | ||
| 110 | |||
| 111 | An object that contains the recipients of the email message. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 EmailTags => ArrayRef[L<Paws::PinpointEmail::MessageTag>] | ||
| 116 | |||
| 117 | A list of tags, in the form of name/value pairs, to apply to an email | ||
| 118 | that you send using the C<SendEmail> operation. Tags correspond to | ||
| 119 | characteristics of the email that you define, so that you can publish | ||
| 120 | email sending events. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 FeedbackForwardingEmailAddress => Str | ||
| 125 | |||
| 126 | The address that Amazon Pinpoint should send bounce and complaint | ||
| 127 | notifications to. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 FromEmailAddress => Str | ||
| 132 | |||
| 133 | The email address that you want to use as the "From" address for the | ||
| 134 | email. The address that you specify has to be verified. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 ReplyToAddresses => ArrayRef[Str|Undef] | ||
| 139 | |||
| 140 | The "Reply-to" email addresses for the message. When the recipient | ||
| 141 | replies to the message, each Reply-to address receives the reply. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head1 SEE ALSO | ||
| 147 | |||
| 148 | This class forms part of L<Paws>, documenting arguments for method SendEmail in L<Paws::PinpointEmail> | ||
| 149 | |||
| 150 | =head1 BUGS and CONTRIBUTIONS | ||
| 151 | |||
| 152 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 153 | |||
| 154 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 155 | |||
| 156 | =cut | ||
| 157 |