Your favorite animal is {{favoriteanimal}}.
" } } ``` Esse código contém as seguintes propriedades: + **TemplateName**— O nome do `Template` recurso. Quando você enviar o e-mail, consulte este nome. + **TemplateContent**— Um contêiner para os seguintes atributos: + **Assunto**: a linha de assunto do e-mail. Essa propriedade pode conter tags de substituição. Essas tags usam o seguinte formato: `{{tagname}}`. Quando você envia o e-mail, pode especificar um valor para `tagname` de cada destino. + **Html**: o corpo HTML do e-mail. Essa propriedade pode conter tags de substituição. O exemplo anterior inclui duas tags: `{{name}}` e `{{favoriteanimal}}`. + **Text**: o corpo de texto do e-mail. Os destinatários cujos clientes de e-mail não exibem conteúdo HTML verão esta versão do e-mail. Essa propriedade também pode conter tags de substituição. 1. Personalize o exemplo anterior de acordo com as suas necessidades e salve o arquivo como *mytemplate.json*. 1. Na linha de comando, digite o seguinte comando para criar um modelo usando a operação [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_CreateEmailTemplate.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_CreateEmailTemplate.html) da API v2: ``` aws sesv2 create-email-template --cli-input-json file://mytemplate.json ``` ## Parte 3: Enviar os e-mails personalizados Você pode usar as duas operações da API v2 do SES a seguir para enviar e-mails usando *modelos armazenados* ou *modelos em linha*: + A operação [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendEmail.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendEmail.html) é útil para enviar um e-mail personalizado para um único objeto de destino. O [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Destination.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Destination.html)objeto da API v2 pode conter as *BccAddresses*propriedades *ToAddresses*CcAddresses**, e. Elas podem ser usadas em qualquer combinação e podem conter um ou mais endereços de e-mail que receberão o mesmo e-mail. + A operação [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendBulkEmail.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendBulkEmail.html) é útil para envio de e-mails exclusivos a vários objetos de destino em uma única chamada para a API v2. Esta seção fornece exemplos de como usar o AWS CLI para enviar e-mails modelados usando essas duas operações de envio. ### Enviar e-mails com base em modelo a um único objeto de destino Você pode usar a operação [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendEmail.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendEmail.html) para enviar um e-mail a um ou mais destinatários definidos em um único objeto de destino. Todos os destinatários no objeto [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Destination.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Destination.html) receberão o mesmo e-mail. **Como enviar um e-mail com base em modelo a um único objeto de destino** 1. Dependendo se você deseja usar um *modelo armazenado* ou um *modelo em linha*, selecione o exemplo de código respectivo para colar em um editor de texto, personalizando-o conforme necessário. ------ #### [ Stored template code example ] Observe que o modelo que você criou na etapa anterior, *MyTemplate*, está sendo referenciado como o valor do `TemplateName` parâmetro. ``` { "FromEmailAddress": "Mary MajorYour favorite animal is {{favoriteanimal}}.
" }, "TemplateData": "{ \"name\":\"Alejandro\", \"favoriteanimal\": \"alligator\" }" } }, "ConfigurationSetName": "ConfigSet" } ``` Esse código contém as seguintes propriedades: + **FromEmailAddress**— O endereço de e-mail do remetente. + **Destino** — Um objeto contendo os destinatários de e-mail definidos nas *BccAddresses*propriedades *ToAddresses*CcAddresses**, e. Elas podem ser usadas em qualquer combinação e podem conter um ou mais endereços de e-mail que receberão o mesmo e-mail. + **TemplateContent**— Um contêiner para os seguintes atributos: + **Assunto**: a linha de assunto do e-mail. Essa propriedade pode conter tags de substituição. Essas tags usam o seguinte formato: `{{tagname}}`. Quando você envia o e-mail, pode especificar um valor para `tagname` de cada destino. + **Html**: o corpo HTML do e-mail. Essa propriedade pode conter tags de substituição. O exemplo anterior inclui duas tags: `{{name}}` e `{{favoriteanimal}}`. + **Text**: o corpo de texto do e-mail. Os destinatários cujos clientes de e-mail não exibem conteúdo HTML verão esta versão do e-mail. Essa propriedade também pode conter tags de substituição. + **TemplateData**— Uma string JSON com escape que contém pares de valores-chave. As chaves correspondem às variáveis definidas nas propriedades `TemplateContent` desse arquivo, por exemplo, `{{name}}`. Os valores representam o conteúdo que substitui as variáveis. + **ConfigurationSetName**— O nome do conjunto de configurações a ser usado ao enviar o e-mail. **nota** Recomendamos que você use um conjunto de configurações definido para publicar eventos de falha de processamento no Amazon SNS. Para obter mais informações, consulte [(Opcional) Parte 1: Configurar notificações de eventos de falha de renderização](#send-personalized-email-set-up-notifications). ------ 1. Personalize o exemplo anterior de acordo com as suas necessidades e salve o arquivo como *myemail.json*. 1. Na linha de comando, digite o seguinte comando da API v2 para enviar o e-mail: ``` aws sesv2 send-email --cli-input-json file://myemail.json ``` ### Enviar e-mails com base em modelo a vários objetos de destino Você pode usar a operação [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendBulkEmail.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendBulkEmail.html) para enviar um e-mail a vários objetos de destino em uma única chamada para a API v2 do SES. O SES envia um e-mail exclusivo para os destinatários em cada objeto [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Destination.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Destination.html). **Como enviar um e-mail com base em modelo a vários objetos de destino** 1. Dependendo se você deseja usar um *modelo armazenado* ou um *modelo em linha*, selecione o exemplo de código respectivo para colar em um editor de texto, personalizando-o conforme necessário. ------ #### [ Stored template code example ] Observe que o modelo que você criou na etapa anterior, *MyTemplate*, está sendo referenciado como o valor do `TemplateName` parâmetro. ``` { "FromEmailAddress": "Mary MajorYour favorite animal is {{favoriteanimal}}.
" }, "TemplateData": "{ \"name\":\"friend\", \"favoriteanimal\":\"unknown\" }" } }, "BulkEmailEntries": [ { "Destination": { "ToAddresses": [ "anaya.iyengar@example.com" ] }, "ReplacementEmailContent": { "ReplacementTemplate": { "ReplacementTemplateData": "{ \"name\":\"Anaya\", \"favoriteanimal\":\"angelfish\" }" } } }, { "Destination": { "ToAddresses": [ "liu.jie@example.com" ] }, "ReplacementEmailContent": { "ReplacementTemplate": { "ReplacementTemplateData": "{ \"name\":\"Liu\", \"favoriteanimal\":\"lion\" }" } } }, { "Destination": { "ToAddresses": [ "shirley.rodriguez@example.com" ] }, "ReplacementEmailContent": { "ReplacementTemplate": { "ReplacementTemplateData": "{ \"name\":\"Shirley\", \"favoriteanimal\":\"shark\" }" } } }, { "Destination": { "ToAddresses": [ "richard.roe@example.com" ] }, "ReplacementEmailContent": { "ReplacementTemplate": { "ReplacementTemplateData": "{}" } } } ], "ConfigurationSetName": "ConfigSet" } ``` Esse código contém as seguintes propriedades: + **FromEmailAddress**— O endereço de e-mail do remetente. + **DefaultContent**— Um objeto JSON que contém os `TemplateData` objetos `TemplateContent` e. + **TemplateContent**— Um contêiner para os seguintes atributos: + **Assunto**: a linha de assunto do e-mail. Essa propriedade pode conter tags de substituição. Essas tags usam o seguinte formato: `{{tagname}}`. Quando você envia o e-mail, pode especificar um valor para `tagname` de cada destino. + **Html**: o corpo HTML do e-mail. Essa propriedade pode conter tags de substituição. O exemplo anterior inclui duas tags: `{{name}}` e `{{favoriteanimal}}`. + **Text**: o corpo de texto do e-mail. Os destinatários cujos clientes de e-mail não exibem conteúdo HTML verão esta versão do e-mail. Essa propriedade também pode conter tags de substituição. + **TemplateData**— Contém pares de valores-chave que serão usados se o `ReplacementEmailContent` objeto contiver um objeto JSON vazio,`{}`, na propriedade. `ReplacementTemplateData` + **BulkEmailEntries**— Uma matriz que contém um ou mais `Destination` objetos. + **Destino** — Um objeto contendo os destinatários de e-mail definidos nas *BccAddresses*propriedades *ToAddresses*CcAddresses**, e. Elas podem ser usadas em qualquer combinação e podem conter um ou mais endereços de e-mail que receberão o mesmo e-mail. + **ReplacementTemplateData**— Uma string JSON com escape que contém pares de valores-chave. As chaves correspondem às variáveis definidas nas propriedades `TemplateContent` desse arquivo, por exemplo, `{{name}}`. Os valores representam o conteúdo que substitui as variáveis no e-mail. (Se a string JSON aqui estiver vazia, indicada por `{}`, os pares de chave-valor definidos na propriedade `TemplateData` dentro do objeto `DefaultContent` serão usados.) + **ConfigurationSetName**— O nome do conjunto de configurações a ser usado ao enviar o e-mail. **nota** Recomendamos que você use um conjunto de configurações definido para publicar eventos de falha de processamento no Amazon SNS. Para obter mais informações, consulte [(Opcional) Parte 1: Configurar notificações de eventos de falha de renderização](#send-personalized-email-set-up-notifications). ------ 1. Altere os valores no código da etapa anterior de acordo com as suas necessidades e salve o arquivo como *mybulkemail.json*. 1. Na linha de comando, digite o seguinte comando da API v2 para enviar o e-mail em massa: ``` aws sesv2 send-bulk-email --cli-input-json file://mybulkemail.json ``` # Personalização de e-mail avançada Se estiver usando um *modelo armazenado*, ou seja, você criou um recurso [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html) no Amazon SES usando a operação `CreateEmailTemplate` com a API v2 do SES, poderá aproveitar o sistema Handlebars para criar modelos que incluem recursos avançados, como atributos aninhados, iteração de matriz, instruções condicionais básicas e a criação de parciais em linha. Esta seção fornece exemplos desses recursos. O Handlebars inclui recursos adicionais além dos documentados nesta seção. Para obter mais informações, consulte [Auxiliares integrados](https://handlebarsjs.com/guide/builtin-helpers.html) em [handlebarsjs.com](http://handlebarsjs.com). **nota** O SES não escapa de conteúdo HTML ao renderizar o modelo HTML para uma mensagem. Isso significa que, se você estiver incluindo dados inseridos pelo usuário, como de um formulário de contato, precisará escapá-los no lado do cliente. **Topics** + [ ## Analisar atributos aninhados ](#send-personalized-email-advanced-nested) + [ ## Percorrer listas ](#send-personalized-email-advanced-iterating) + [ ## Usar instruções condicionais básicas ](#send-personalized-email-advanced-conditionals) + [ ## Criação de parciais em linha ](#send-personalized-email-advanced-inline-partials) ## Analisar atributos aninhados O Handlebars inclui suporte para caminhos aninhados, o que torna fácil organizar complexos dados do cliente e, em seguida, consultá-los em seus modelos de e-mail. Por exemplo, você pode organizar os dados dos destinatários em diversas categorias gerais. Em cada uma dessas categorias, você pode incluir informações detalhadas. O código de exemplo a seguir mostra um exemplo dessa estrutura para um único destinatário: ``` { "meta":{ "userId":"51806220607" }, "contact":{ "firstName":"Anaya", "lastName":"Iyengar", "city":"Bengaluru", "country":"India", "postalCode":"560052" }, "subscription":[ { "interest":"Sports" }, { "interest":"Travel" }, { "interest":"Cooking" } ] } ``` Em seus modelos de e-mail, você pode consultar atributos aninhados ao fornecer o nome do atributo pai, seguido por um ponto (.) e pelo nome do atributo para os quais você deseja incluir o valor. Por exemplo, se você usar a estrutura de dados mostrada no exemplo anterior e desejar incluir o nome de cada destinatário no modelo de e-mail, inclua o seguinte texto em seu modelo de e-mail: `Hello {{contact.firstName}}!` O Handlebars pode analisar caminhos aninhados em vários níveis de profundidade, o que significa que você tem flexibilidade para escolher como estruturar os dados de seu modelo. ## Percorrer listas A função auxiliar `each` faz a iteração por meio de itens em uma matriz. O código a seguir é um exemplo de um modelo de e-mail que usa a função auxiliar `each` para criar uma lista detalhada dos interesses de cada destinatário. ``` { "Template": { "TemplateName": "Preferences", "SubjectPart": "Subscription Preferences for {{contact.firstName}} {{contact.lastName}}", "HtmlPart": "You have indicated that you are interested in receiving information about the following subjects:
You can change these settings at any time by visiting the Preference Center.
", "TextPart": "Your Preferences\n\nYou have indicated that you are interested in receiving information about the following subjects:\n {{#each subscription}} - {{interest}}\n {{/each}} \nYou can change these settings at any time by visiting the Preference Center at https://www.example.com/prefererences/i.aspx?id={{meta.userId}}" } } ``` **Importante** No código de exemplo anterior, os valores dos atributos `HtmlPart` e `TextPart` incluem quebras de linha para facilitar a leitura do exemplo. O arquivo JSON para seu modelo não pode conter quebras de linha dentro desses valores. Se você copiou e colou esse exemplo em seu próprio arquivo JSON, antes de prosseguir, remova as quebras de linha e os espaços extras das seções `HtmlPart` e `TextPart`. Depois de criar o modelo, você pode usar a operação `SendEmail` ou `SendBulkEmail` para enviar e-mails para destinatários usando esse modelo. Desde que cada destinatário tenha, pelo menos, um valor no objeto `Interests`, eles receberão um e-mail que inclua uma lista detalhada de seus interesses. O exemplo a seguir mostra um arquivo JSON que pode ser usado para enviar e-mails para vários destinatários usando o modelo anterior: ``` { "Source":"Sender NameDear {{contact.firstName}},
{{#if subscription}}You have indicated that you are interested in receiving information about the following subjects:
You can change these settings at any time by visiting the Preference Center.
{{else}}Please update your subscription preferences by visiting
the
Preference Center.
{{/if}}",
"TextPart": "Your Preferences\n\nDear {{contact.firstName}},\n\n
{{#if subscription}}
You have indicated that you are interested in receiving
information about the following subjects:\n
{{#each subscription}}
- {{interest}}\n
{{/each}}
\nYou can change these settings at any time by visiting the
Preference Center at https://www.example.com/prefererences/i.aspx?id={{meta.userId}}.
{{else}}
Please update your subscription preferences by visiting the
Preference Center at https://www.example.com/prefererences/i.aspx?id={{meta.userId}}.
{{/if}}"
}
}
```
**Importante**
No código de exemplo anterior, os valores dos atributos `HtmlPart` e `TextPart` incluem quebras de linha para facilitar a leitura do exemplo. O arquivo JSON para seu modelo não pode conter quebras de linha dentro desses valores. Se você copiou e colou esse exemplo em seu próprio arquivo JSON, antes de prosseguir, remova as quebras de linha e os espaços extras das seções `HtmlPart` e `TextPart`.
O exemplo a seguir mostra um arquivo JSON que pode ser usado para enviar e-mails para vários destinatários usando o modelo anterior:
```
{
"Source":"Sender Name You have listed the following people as your friends: This is the HTML part of the message. This is the HTML part of the message.Hello {{> fullName}}!
{{#each friends}}
",
"TextPart": "{{#* inline \"fullName\"}}
{{firstName}}{{#if lastName}} {{lastName}}{{/if}}
{{/inline~}}\n
Hello {{> fullName}}! You have listed the following people
as your friends:\n
{{#each friends}}
- {{> fullName}}\n
{{/each}}"
}
}
```
**Importante**
No código de exemplo anterior, os valores dos atributos `HtmlPart` e `TextPart` incluem quebras de linha para facilitar a leitura do exemplo. O arquivo JSON para seu modelo não pode conter quebras de linha dentro desses valores. Se você copiou e colou esse exemplo em seu próprio arquivo JSON, remova as quebras de linha e os espaços extras dessas seções.
# Gerenciamento de modelos de e-mail
Além de [criar modelos de e-mail](send-personalized-email-api.md), você também pode usar a API v2 do Amazon SES para atualizar ou excluir modelos existentes, listar todos os modelos existentes ou visualizar o conteúdo de um modelo.
Esta seção contém procedimentos para usar o AWS CLI para realizar tarefas relacionadas aos modelos do SES.
**nota**
Os procedimentos desta seção também pressupõem que você já instalou e configurou a AWS CLI. Para obter mais informações sobre como instalar e configurar o AWS CLI, consulte o [Guia do AWS Command Line Interface usuário](https://docs.aws.amazon.com/cli/latest/userguide/).
## Visualização de uma lista de modelos de e-mail
Você pode usar a operação [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_ListEmailTemplate.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_ListEmailTemplate.html) da API v2 do SES para visualizar uma lista de todos os seus modelos de e-mail existentes.
**Para visualizar uma lista de modelos de e-mail**
+ Na linha de comando, insira o seguinte comando:
```
aws sesv2 list-email-templates
```
Se houver modelos de e-mail existentes na sua conta do SES na região atual, esse comando retornará uma resposta semelhante ao seguinte exemplo:
```
{
"TemplatesMetadata": [
{
"Name": "SpecialOffers",
"CreatedTimestamp": "2020-08-05T16:04:12.640Z"
},
{
"Name": "NewsAndUpdates",
"CreatedTimestamp": "2019-10-03T20:03:34.574Z"
}
]
}
```
Se você ainda não criou nenhum modelo, o comando retorna um objeto `TemplatesMetadata` sem membros.
## Visualização do conteúdo de um modelo de e-mail específico
Você pode usar a operação [https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_GetEmailTemplate.html](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_GetEmailTemplate.html) da API v2 do SES para visualizar o conteúdo de um modelo de e-mail específico.
**Para visualizar o conteúdo de um modelo de e-mail específico**
+ Na linha de comando, insira o seguinte comando:
```
aws sesv2 get-email-template --template-name MyTemplate
```
No comando anterior, *MyTemplate* substitua pelo nome do modelo que você deseja visualizar.
Se o nome do modelo fornecido corresponder a um modelo que existe na sua conta do SES, esse comando retornará uma resposta semelhante ao seguinte exemplo:
```
{
"Template": {
"TemplateName": "TestMessage",
"SubjectPart": "Amazon SES Test Message",
"TextPart": "Hello! This is the text part of the message.",
"HtmlPart": "\n\nHello!
\nHello!
\n