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á.
Uso do gerenciamento de listas
O Amazon SES oferece recursos de gerenciamento de listas, o que significa que os clientes podem gerenciar suas próprias listas de correspondência, conhecidas como listas de contatos. A lista de contatos é uma lista que permite armazenar todos os contatos que se inscreveram em um determinado tópico ou tópicos. Um contato é um usuário final que está recebendo seus e-mails. Um tópico é um grupo de interesse, tema ou rótulo dentro de uma lista. As listas podem ter vários tópicos.
Usando a operação ListContacts na API v2 do Amazon SES, você pode recuperar uma lista de todos os seus contatos que assinaram um tópico específico, para quem você pode enviar e-mails usando a operação SendEmail.
Para obter informações sobre ogerenciamento de assinaturas, consulte Uso de o gerenciamento de assinaturas.
Visão geral de gerenciamento de listas
Você deve considerar os seguintes fatores ao usar o gerenciamento de listas:
-
Você pode especificar os tópicos da lista ao criá-la.
-
Somente uma lista de contatos é permitida por Conta da AWS.
-
Uma lista pode ter um máximo de 20 tópicos.
-
Você pode atualizar uma lista de contatos existente, inclusive adicionar novos tópicos à lista, adicionar ou excluir contatos de uma lista e atualizar preferências de contato para uma lista ou tópico.
-
Você pode atualizar metadados do tópico, como o nome de exibição ou a descrição do tópico.
-
Você pode obter uma lista dos contatos de uma lista de contatos, contatos que assinaram um tópico, contatos que cancelaram a assinatura de um tópico e contatos que cancelaram todos os tópicos da lista.
-
Você pode importar suas listas de contatos existentes para o SES usando a
CreateImportJobAPI. -
A SES emitirá um evento de rejeição para uma mensagem enviada a um contato não inscrito em sua lista de contatos. Para obter mais informações, consulte Uso de o gerenciamento de assinaturas.
-
Cada contato pode ter atributos associados, que você pode usar para armazenar informações sobre ele.
Configuração de gerenciamento de listas
Você pode usar as seguintes operações para configurar os recursos de gerenciamento de listas. Para obter a lista completa da lista de contatos e operações de contato, consulte a Referência da API v2 do Amazon SES.
Criar uma lista de contatos
Você pode usar a CreateContactListoperação na API SES v2 para criar uma lista de contatos. É possível definir essa configuração de forma rápida e fácil usando 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.
Para criar uma lista de contatos usando o AWS CLI
-
Na linha de comando, insira o seguinte comando:
aws sesv2 create-contact-list --cli-input-json file://CONTACT-LIST-JSONNo comando anterior,
CONTACT-LIST-JSONsubstitua pelo caminho para o arquivo JSON da suaCreateContactListsolicitação.Um exemplo de arquivo JSON de entrada
CreateContactListpara a solicitação é o seguinte:{ "ContactListName": "ExampleContactListName", "Description": "Creating a contact list example", "Topics": [ { "TopicName": "Sports", "DisplayName": "Sports Newsletter", "Description": "Sign up for our free newsletter to receive updates on all sports.", "DefaultSubscriptionStatus": "OPT_OUT" }, { "TopicName": "Cycling", "DisplayName": "Cycling newsletter", "Description": "Never miss a cycling update by subscribing to our newsletter.", "DefaultSubscriptionStatus": "OPT_IN" }, { "TopicName": "NewProducts", "DisplayName": "New products", "Description": "Hear about new products by subscribing to this mailing list.", "DefaultSubscriptionStatus": "OPT_IN" }, { "TopicName": "DailyUpdates", "DisplayName": "Daily updates", "Description": "Start your day with sport updates, Monday through Friday.", "DefaultSubscriptionStatus": "OPT_OUT" } ] }
Criar um contato
Você pode usar a CreateContactoperação na API SES v2 para criar um contato. É possível definir essa configuração de forma rápida e fácil usando 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.
Para criar um contato usando o AWS CLI
-
Na linha de comando, insira o seguinte comando:
aws sesv2 create-contact --cli-input-json file://CONTACT-JSONNo comando anterior,
CONTACT-JSONsubstitua pelo caminho para o arquivo JSON da suaCreateContactsolicitação.Um exemplo de arquivo JSON de entrada
CreateContactpara a solicitação é o seguinte:{ "ContactListName": "ExampleContactListName", "EmailAddress": "example@amazon.com", "UnsubscribeAll": false, "TopicPreferences": [ { "TopicName": "Sports", "SubscriptionStatus": "OPT_IN" } ], "AttributesData": "{\"Name\": \"John\", \"Location\": \"Seattle\"}" }No exemplo acima, um valor
UnsubscribeAlldefalsemostra que o contato não cancelou a assinatura de todos os tópicos. Já um valor detruesignificaria que o contato cancelou a assinatura de todos os tópicos.TopicPreferencesinclui informações sobre o status de assinatura de tópicos do contato. No exemplo anterior, o contato optou pelo tópico “Esportes” e receberá todos os e-mails do tópico “Esportes”.O
AttributesDataé um campo JSON onde você pode colocar qualquer metadado sobre o nosso contato. Ele deve ser um objeto JSON válido.
Importação de contatos em massa para sua lista de contatos
Você pode adicionar endereços manualmente em massa fazendo primeiro o upload de seus contatos em um objeto do Amazon S3 e, em seguida, usando CreateImportJoba operação na API do SES v2 ou usando o console do SES. Para obter mais informações, consulte Adicionar endereços de e-mail em massa à lista de supressão no nível da conta.
Você deve criar uma lista de contatos antes de importar seus contatos.
nota
Você pode adicionar até 1 milhão de contatos a uma lista de contatos por ImportJob.
Para adicionar contatos em massa à sua lista de contatos, realize as etapas a seguir.
-
Carregue seus contatos em um objeto do Amazon S3 no formato CSV ou JSON.
Formato CSV
A primeira linha do arquivo carregado para o Amazon S3 deve ser uma linha de cabeçalho.
O objeto
topicPreferencesprecisa ser simplificado para o formato CSV. Cada tópico notopicPreferencesterá um campo de cabeçalho separado.Exemplo de formato CSV para adicionar contatos em lote a uma lista de contatos:
emailAddress,unsubscribeAll,attributesData,topicPreferences.Sports,topicPreferences.Cycling example1@amazon.com,false,{"Name": "John"},OPT_IN,OPT_OUT example2@amazon.com,true,,OPT_OUT,OPT_OUTFormato JSON
Somente arquivos JSON delimitados por nova linha são aceitos. Nesse formato, cada linha é um objeto JSON completo que contém as informações de um contato.
Exemplo de formato JSON para adicionar contatos em lote a uma lista de contatos:
{ "emailAddress": "example1@amazon.com", "unsubscribeAll": false, "attributesData": "{\"Name\":\"John\"}", "topicPreferences": [ { "topicName": "Sports", "subscriptionStatus": "OPT_IN" }, { "topicName": "Cycling", "subscriptionStatus": "OPT_OUT" } ] } { "emailAddress": "example2@amazon.com", "unsubscribeAll": true, "topicPreferences": [ { "topicName": "Sports", "subscriptionStatus": "OPT_OUT" }, { "topicName": "Cycling", "subscriptionStatus": "OPT_OUT" } ] }Nos exemplos anteriores, substitua
example1@amazon.come pelosexample2@amazon.comendereços de e-mail que você deseja adicionar à lista de contatos. Substitua os valores deattributesDatapelos valores específicos do contato. Além disso, substituaSportseCyclingpelotopicNameque se aplica ao seu contato. Os aceitáveistopicPreferencessãoOPT_INOPT_OUTe.Os atributos a seguir são suportados ao carregar seus contatos em um objeto do Amazon S3 no formato CSV ou JSON:
Atributo Descrição emailAddressO endereço de e-mail do contato. Este é um campo obrigatório. unsubscribeAllO status de um valor booleano informando se o contato foi excluído de todos os tópicos da lista de contatos. topicPreferencesAs preferências do contato por sua inclusão ou exclusão em tópicos. attributesDataOs dados de atributo anexados a um contato. -
Conceda permissão ao SES para ler o objeto do Amazon S3.
Quando aplicada a um bucket do Amazon S3, a seguinte política concede ao SES permissão de leitura desse bucket. Para obter mais informações sobre como anexar políticas aos buckets do Amazon S3, consulte Uso de políticas de bucket e políticas de usuário no Guia do usuário do Amazon Simple Storage Service.
-
Dê permissão ao SES para usar sua AWS KMS chave.
Se o objeto do Amazon S3 estiver criptografado com uma AWS KMS chave, você precisará dar permissão ao Amazon SES para usar a chave KMS. O SES só pode obter permissão de uma chave gerenciada pelo cliente, não de uma chave padrão do KMS. Você deve dar permissão à SES para usar a chave gerenciada pelo cliente adicionando uma declaração à política da chave.
Cole a seguinte instrução de política na política de chave para permitir que o SES use sua chave gerenciada pelo cliente.
{ "Sid": "AllowSESToDecrypt", "Effect": "Allow", "Principal": { "Service":"ses.amazonaws.com" }, "Action": [ "kms:Decrypt", ], "Resource": "*" } -
Use a
CreateImportJoboperação na API SES v2.
nota
O exemplo a seguir pressupõe que a AWS CLI já foi instalada. Para obter mais informações sobre como instalar e configurar o AWS CLI, consulte o Guia do AWS Command Line Interface usuário.
Na linha de comando, insira o seguinte comando: s3bucketSubstitua pelo nome do bucket do Amazon S3 s3object e pelo nome do objeto do Amazon S3.
aws sesv2 create-import-job --import-destination ContactListDestination={ContactListName=ExampleContactListName,ContactListImportAction=PUT} --import-data-source S3Url="s3://s3bucket/s3object",DataFormat=CSV
Demonstração do gerenciamento de listas com exemplos
A demonstração a seguir fornece exemplos de como você pode usar o gerenciamento de listas para listar seus contatos, utilizar ListManagementOptions para especificar uma lista de contatos e um nome de tópico em seu e-mail e como inserir links de cancelamento de assinatura.
-
Liste contatos usando o AWS CLI — Você pode usar a
ListContactsoperação para recuperar uma lista de todos os seus contatos que se inscreveram em um tópico específico, em conjunto com aSendEmailoperação, que permite enviar e-mails para eles.Na linha de comando, insira o seguinte comando:
aws sesv2 list-contacts --cli-input-json file://LIST-CONTACTS-JSONNo comando anterior,
LIST-CONTACTS-JSONsubstitua pelo caminho para o arquivo JSON da suaListContactssolicitação.Um exemplo de arquivo JSON de entrada
ListContactspara a solicitação é o seguinte:{ "ContactListName": "ExampleContactListName", "Filter": { "FilteredStatus": "OPT_IN", "TopicFilter": { "TopicName": "Cycling", "UseDefaultIfPreferenceUnavailable": true } }, "PageSize": 50 }O
FilteredStatusmostra o status da assinatura para a qual você deseja filtrar, que éOPT_INouOPT_OUT.O
TopicFilteré um filtro opcional que especifica o tópico para o qual você deseja resultados e, no exemplo acima, é “Ciclismo”.UseDefaultIfPreferenceUnavailablepode ter um valor detrueoufalse. Setrue, a preferência padrão do tópico será usada se o contato não tiver nenhuma preferência explícita para um tópico. Sefalse, apenas os contatos com uma preferência definida explicitamente serão considerados para filtragem. -
Enviar e-mail com
ListManagementOptionshabilitado: depois de listar os contatos em sua lista usando a operaçãoListContactsacima, você pode usar a operaçãoSendEmailpara enviar e-mails a cada um de seus contatos utilizando o cabeçalhoListManagementOptionspara especificar a lista de contatos e o nome do tópico.Para usar
ListManagementOptionscom a operaçãoSendEmail, inclua ocontactListNamee otopicNameaos quais o e-mail pertence (otopicNameé opcional):ListManagementOptions: String contactListName String topicNameSe você incluir
ListManagementOptionsna solicitaçãoSendEmailpara o endereço de e-mail de um destinatário que não esteja em sua lista de contatos, será criado um contato em sua lista automaticamente.A SES emitirá um evento de rejeição para uma mensagem enviada a um contato não inscrito em sua lista de contatos, o que significa que você não precisará atualizar suas
SendEmailsolicitações para evitar o envio para contatos que cancelaram a inscrição. -
Indique o local para seus links de cancelamento de inscrição — Ao utilizar,
ListManagementOptionsvocê tem a opção de permitir que o SES adicione links de rodapé de cancelamento de inscrição em seu e-mail usando o{{amazonSESUnsubscribeUrl}}espaço reservado para especificar onde o SES precisa inserir o URL de cancelamento de inscrição. A substituição de espaço reservado é suportada apenas com os tipos de conteúdo HTML e TEXT. Você pode incluir o espaço reservado duas vezes no máximo. Se for usado mais de duas vezes, apenas as duas primeiras ocorrências são substituídas. Para obter mais informações, consulte Uso de o gerenciamento de assinaturas.Como alternativa, se estiver usando a interface SMTP para enviar um e-mail, você pode usar o cabeçalho
X-SES-LIST-MANAGEMENT-OPTIONSpara especificar um nome de lista e de tópico.Para especificar um nome de lista e tópico ao enviar e-mail usando a interface SMTP, adicione o seguinte cabeçalho de e-mail à sua mensagem:
X-SES-LIST-MANAGEMENT-OPTIONS: {contactListName}; topic={topicName}