View a markdown version of this page

Gerenciamento de modelos de e-mail - Amazon Simple Email Service
Visualização de uma lista de modelos de e-mailVisualização do conteúdo de um modelo de e-mail específicoExclusão de um modelo de e-mailAtualização de um modelo de e-mail

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Gerenciamento de modelos de e-mail

Além de criar modelos de e-mail, 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.

Visualização de uma lista de modelos de e-mail

Você pode usar a operação ListEmailTemplate 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 GetEmailTemplate 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": "<html>\n<body>\n<h2>Hello!</h2>\n<p>This is the HTML part of the message.</p></body>\n</html>"
    }
}

    Se o nome do modelo fornecido não corresponder a um modelo existente na sua conta do SES, o comando retornará um erro de NotFoundException.

Exclusão de um modelo de e-mail

Você pode usar a operação DeleteEmailTemplate da API v2 do SES para excluir um modelo de e-mail específico.

Para excluir um modelo de e-mail

  • Na linha de comando, insira o seguinte comando:

    aws sesv2 delete-email-template --template-name MyTemplate

    No comando anterior, MyTemplate substitua pelo nome do modelo que você deseja excluir.

    Esse comando não fornece nenhuma saída. Você pode verificar se o modelo foi excluído usando a GetTemplateoperação.

Atualização de um modelo de e-mail

Você pode usar a operação UpdateEmailTemplate da API v2 do SES para atualizar um modelo de e-mail existente. Por exemplo, essa operação é útil se você quiser alterar a linha de assunto do modelo de email ou se precisar modificar o corpo da mensagem em si.

Para atualizar um modelo de e-mail

  1. Use o comando GetEmailTemplate para recuperar o modelo existente inserindo o seguinte comando na linha de comandos:

    aws sesv2 get-email-template --template-name MyTemplate

    No comando anterior, MyTemplate substitua pelo nome do modelo que você deseja atualizar.

    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": "<html>\n<body>\n<h2>Hello!</h2>\n<p>This is the HTML part of the message.</p></body>\n</html>"
    }
}

  2. Em um editor de texto, crie um novo arquivo. Cole a saída do comando anterior no arquivo.

  3. Modifique o template conforme necessário. Todas as linhas que você omitir são removidas do modelo. Por exemplo, se você quiser alterar apenas o SubjectPart do modelo, você ainda precisa incluir as propriedades TextPart e HtmlPart.

    Ao concluir, salve o arquivo como update_template.json.

  4. Na linha de comando, insira o seguinte comando:

    aws sesv2 update-email-template --cli-input-json file://path/to/update_template.json

    No comando anterior, path/to/update_template.json substitua pelo caminho para o update_template.json arquivo que você criou na etapa anterior.

    Se o modelo for atualizado com êxito, esse comando não fornece nenhuma saída. Você pode verificar se o modelo foi atualizado usando a operação GetEmailTemplate.

    Se o modelo especificado não existir, esse comando retornará um erro de TemplateDoesNotExist. Se o modelo não contiver a propriedade TextPart nem a propriedade HtmlPart, este comando retornará um erro InvalidParameterValue.