« blib/lib/Paws/Pinpoint/EmailMessageActivity.pm
↑ Summary
blib/lib/Paws/Pinpoint/EmailTemplateResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::EmailTemplateRequest; | ||
| 3 | use Moose; | ||
| 4 | has DefaultSubstitutions => (is => 'ro', isa => 'Str'); | ||
| 5 | has HtmlPart => (is => 'ro', isa => 'Str'); | ||
| 6 | has RecommenderId => (is => 'ro', isa => 'Str'); | ||
| 7 | has Subject => (is => 'ro', isa => 'Str'); | ||
| 8 | has Tags => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 9 | has TemplateDescription => (is => 'ro', isa => 'Str'); | ||
| 10 | has TextPart => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Pinpoint::EmailTemplateRequest | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::Pinpoint::EmailTemplateRequest object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { DefaultSubstitutions => $value, ..., TextPart => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::EmailTemplateRequest object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->DefaultSubstitutions | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Specifies the content and settings for a message template that can be | ||
| 43 | used in messages that are sent through the email channel. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 DefaultSubstitutions => Str | ||
| 49 | |||
| 50 | A JSON object that specifies the default values to use for message | ||
| 51 | variables in the message template. This object is a set of key-value | ||
| 52 | pairs. Each key defines a message variable in the template. The | ||
| 53 | corresponding value defines the default value for that variable. When | ||
| 54 | you create a message that's based on the template, you can override | ||
| 55 | these defaults with message-specific and address-specific variables and | ||
| 56 | values. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 HtmlPart => Str | ||
| 60 | |||
| 61 | The message body, in HTML format, to use in email messages that are | ||
| 62 | based on the message template. We recommend using HTML format for email | ||
| 63 | clients that render HTML content. You can include links, formatted | ||
| 64 | text, and more in an HTML message. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 RecommenderId => Str | ||
| 68 | |||
| 69 | The unique identifier for the recommender model to use for the message | ||
| 70 | template. Amazon Pinpoint uses this value to determine how to retrieve | ||
| 71 | and process data from a recommender model when it sends messages that | ||
| 72 | use the template, if the template contains message variables for | ||
| 73 | recommendation data. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 Subject => Str | ||
| 77 | |||
| 78 | The subject line, or title, to use in email messages that are based on | ||
| 79 | the message template. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 Tags => L<Paws::Pinpoint::MapOf__string> | ||
| 83 | |||
| 84 | A string-to-string map of key-value pairs that defines the tags to | ||
| 85 | associate with the message template. Each tag consists of a required | ||
| 86 | tag key and an associated tag value. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 TemplateDescription => Str | ||
| 90 | |||
| 91 | A custom description of the message template. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 TextPart => Str | ||
| 95 | |||
| 96 | The message body, in plain text format, to use in email messages that | ||
| 97 | are based on the message template. We recommend using plain text format | ||
| 98 | for email clients that don't render HTML content and clients that are | ||
| 99 | connected to high-latency networks, such as mobile devices. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |