Exemplos do Amazon SES usando o AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Amazon SES.
Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
Tópicos
Ações
O código de exemplo a seguir mostra como usar delete-identity
.
- AWS CLI
-
Para excluir uma identidade
O exemplo a seguir usa o comando
delete-identity
para excluir uma identidade da lista de identidades verificadas com o Amazon SES:aws ses delete-identity --identity
user@example.com
Para saber mais sobre identidades verificadas, consulte Verificar endereços de e-mail e domínios no Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para obter detalhes da API, consulte DeleteIdentity
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar get-identity-dkim-attributes
.
- AWS CLI
-
Para obter os atributos Easy DKIM do Amazon SES para uma lista de identidades
O exemplo a seguir usa o comando
get-identity-dkim-attributes
para recuperar os atributos do Amazon SES Easy DKIM para uma lista de identidades:aws ses get-identity-dkim-attributes --identities
"example.com"
"user@example.com"
Saída:
{ "DkimAttributes": { "example.com": { "DkimTokens": [ "EXAMPLEjcs5xoyqytjsotsijas7236gr", "EXAMPLEjr76cvoc6mysspnioorxsn6ep", "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k" ], "DkimEnabled": true, "DkimVerificationStatus": "Success" }, "user@example.com": { "DkimEnabled": false, "DkimVerificationStatus": "NotStarted" } } }
Se você chamar esse comando com uma identidade que nunca foi enviada para verificação, essa identidade não aparecerá na saída.
Para obter mais informações sobre o Easy DKIM, consulte Easy DKIM no Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para ver detalhes da API, consulte GetIdentityDkimAttributes
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar get-identity-notification-attributes
.
- AWS CLI
-
Para obter os atributos de notificação do Amazon SES para uma lista de identidades
O exemplo a seguir usa o comando
get-identity-notification-attributes
para recuperar os atributos de notificação do Amazon SES para uma lista de identidades:aws ses get-identity-notification-attributes --identities
"user1@example.com"
"user2@example.com"
Saída:
{ "NotificationAttributes": { "user1@example.com": { "ForwardingEnabled": false, "ComplaintTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:MyTopic", "BounceTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:MyTopic", "DeliveryTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:MyTopic" }, "user2@example.com": { "ForwardingEnabled": true } } }
Esse comando retorna o status do encaminhamento de feedback por e-mail e, se aplicável, os nomes do recurso da Amazon (ARNs) dos tópicos do Amazon SNS para os quais as notificações de devolução, reclamação e entrega são enviadas.
Se você chamar esse comando com uma identidade que nunca foi enviada para verificação, essa identidade não aparecerá na saída.
Para obter mais informações sobre as notificações, consulte Usar notificações com o Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para obter os detalhes da API, consulte GetIdentityNotificationAttributes
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar get-identity-verification-attributes
.
- AWS CLI
-
Para obter o status de verificação do Amazon SES para uma lista de identidades
O exemplo a seguir usa o comando
get-identity-verification-attributes
para recuperar o status de verificação do Amazon SES para uma lista de identidades:aws ses get-identity-verification-attributes --identities
"user1@example.com"
"user2@example.com"
Saída:
{ "VerificationAttributes": { "user1@example.com": { "VerificationStatus": "Success" }, "user2@example.com": { "VerificationStatus": "Pending" } } }
Se você chamar esse comando com uma identidade que nunca foi enviada para verificação, essa identidade não aparecerá na saída.
Para saber mais sobre identidades verificadas, consulte Verificar endereços de e-mail e domínios no Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para obter os detalhes da API, consulte GetIdentityVerificationAttributes
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar get-send-quota
.
- AWS CLI
-
Para obter limites do envio do Amazon SES
O exemplo a seguir usa o comando
get-send-quota
para retornar seus limites de envio do Amazon SES:aws ses get-send-quota
Saída:
{ "Max24HourSend": 200.0, "SentLast24Hours": 1.0, "MaxSendRate": 1.0 }
Max24HourSend é sua cota de envio, que é o número máximo de e-mails que você pode enviar em um período de 24 horas. A cota de envio reflete um período de tempo acumulado. Sempre que você tenta enviar um e-mail, o Amazon SES verifica quantos e-mails foram enviados nas 24 horas anteriores. Desde que o número total de e-mails que você enviou seja menor que a sua cota, sua solicitação de envio será aceito e seus e-mails serão enviados.
SentLast24Hours é o número de e-mails que você enviou nas 24 horas anteriores.
MaxSendRate é o número máximo de e-mails que podem ser enviados por segundo.
Os limites de envio se baseiam em destinatários, e não em mensagens. Por exemplo, um e-mail com dez destinatários conta como dez em sua cota de envio.
Para obter mais informações, consulte Gerenciamento de limites do envio do Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para obter detalhes da API, consulte GetSendQuota
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar get-send-statistics
.
- AWS CLI
-
Para obter estatísticas de envio do Amazon SES
O exemplo a seguir usa o comando
get-send-statistics
para retornar suas estatísticas de envio do Amazon SESaws ses get-send-statistics
Saída:
{ "SendDataPoints": [ { "Complaints": 0, "Timestamp": "2013-06-12T19:32:00Z", "DeliveryAttempts": 2, "Bounces": 0, "Rejects": 0 }, { "Complaints": 0, "Timestamp": "2013-06-12T00:47:00Z", "DeliveryAttempts": 1, "Bounces": 0, "Rejects": 0 } ] }
O resultado é uma lista de pontos de dados que representa as duas últimas semanas de atividades de envio. Cada ponto de dados na lista contém estatísticas para um intervalo de 15 minutos.
Neste exemplo, há apenas dois pontos de dados porque os únicos e-mails que o usuário enviou nas últimas duas semanas caíram em dois intervalos de 15 minutos.
Para obter mais informações, consulte Monitoramento das estatísticas de uso do Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para ver detalhes da API, consulte GetSendStatistics
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-identities
.
- AWS CLI
-
Para listar todas as identidades (endereços de e-mail e domínios) de uma conta da AWS específica
O exemplo a seguir usa o comando
list-identities
para listar todas as identidades que foram enviadas para verificação com o Amazon SES:aws ses list-identities
Saída:
{ "Identities": [ "user@example.com", "example.com" ] }
A lista retornada contém todas as identidades, independentemente do status da verificação (verificada, verificação pendente, falha etc.).
Neste exemplo, endereços de e-mail e domínios são retornados porque não especificamos o parâmetro identity-type.
Para obter mais informações sobre verificação, consulte Verificar endereços de e-mail e domínios no Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para obter detalhes da API, consulte ListIdentities
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar send-email
.
- AWS CLI
-
Para enviar um e-mail formatado usando o Amazon SES
O exemplo a seguir usa o comando
send-email
para enviar um e-mail formatado:aws ses send-email --from
sender@example.com
--destinationfile://destination.json
--messagefile://message.json
Saída:
{ "MessageId": "EXAMPLEf3a5efcd1-51adec81-d2a4-4e3f-9fe2-5d85c1b23783-000000" }
O destino e a mensagem são estruturas de dados JSON salvas em arquivos .json no diretório atual. Esses arquivos são os seguintes:
destination.json
:{ "ToAddresses": ["recipient1@example.com", "recipient2@example.com"], "CcAddresses": ["recipient3@example.com"], "BccAddresses": [] }
message.json
:{ "Subject": { "Data": "Test email sent using the AWS CLI", "Charset": "UTF-8" }, "Body": { "Text": { "Data": "This is the message body in text format.", "Charset": "UTF-8" }, "Html": { "Data": "This message body contains HTML formatting. It can, for example, contain links like this one: <a class=\"ulink\" href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide\" target=\"_blank\">Amazon SES Developer Guide</a>.", "Charset": "UTF-8" } } }
Substitua os endereços de e-mail do remetente e do destinatário por aqueles que você deseja usar. O endereço de e-mail do remetente deverá ser verificado com o Amazon SES. Até que você tenha acesso de produção ao Amazon SES, você também deverá verificar o endereço de e-mail de cada destinatário, a menos que o destinatário seja o simulador de caixa de correio do Amazon SES. Para obter mais informações sobre verificação, consulte Verificar endereços de e-mail e domínios no Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
O ID da mensagem na saída indica que a chamada para send-email foi bem-sucedida.
Se você não receber o e-mail, verifique a caixa de lixo eletrônico.
Para obter mais informações sobre como enviar e-mail formatado, consulte Envio de e-mail formatado usando a API do Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para ver os detalhes da API, consulte SendEmail
na referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar send-raw-email
.
- AWS CLI
-
Para enviar e-mail bruto usando o Amazon SES
O exemplo a seguir usa o comando
send-raw-email
para enviar um e-mail com um anexo TXT:aws ses send-raw-email --raw-message
file://message.json
Saída:
{ "MessageId": "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000" }
A mensagem bruta é uma estrutura de dados JSON salva em um arquivo chamado
message.json
no diretório atual. Ele contém o seguinte:{ "Data": "From: sender@example.com\nTo: recipient@example.com\nSubject: Test email sent using the AWS CLI (contains an attachment)\nMIME-Version: 1.0\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\n\n--NextPart\nContent-Type: text/plain\n\nThis is the message body.\n\n--NextPart\nContent-Type: text/plain;\nContent-Disposition: attachment; filename=\"attachment.txt\"\n\nThis is the text in the attachment.\n\n--NextPart--" }
Como você pode ver, “Dados” é uma longa sequência de caracteres que contém todo o conteúdo bruto do e-mail no formato MIME, incluindo um anexo chamado attachment.txt.
Substitua sender@example.com e recipient@example.com pelos endereços que você deseja usar. O endereço de e-mail do remetente deverá ser verificado com o Amazon SES. Até que você tenha acesso de produção ao Amazon SES, você também deverá verificar o endereço de e-mail do destinatário, a menos que o destinatário seja o simulador de caixa de correio do Amazon SES. Para obter mais informações sobre verificação, consulte Verificar endereços de e-mail e domínios no Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
O ID da mensagem na saída indica que a chamada para send-raw-email foi bem-sucedida.
Se você não receber o e-mail, verifique a caixa de lixo eletrônico.
Para obter mais informações sobre como enviar e-mail bruto, consulte Enviar e-mail bruto usando a API do Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para encontrar os detalhes da API, consulte SendRawEmail
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar set-identity-dkim-enabled
.
- AWS CLI
-
Para habilitar ou desabilitar o Easy DKIM em uma identidade verificada do Amazon SES
O exemplo a seguir usa o comando
set-identity-dkim-enabled
para desabilitar o DKIM para um endereço de e-mail verificado:aws ses set-identity-dkim-enabled --identity
user@example.com
--no-dkim-enabledPara obter mais informações sobre o Easy DKIM, consulte Easy DKIM no Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para ver detalhes da API, consulte SetIdentityDkimEnabled
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar set-identity-feedback-forwarding-enabled
.
- AWS CLI
-
Para habilitar ou desabilitar o encaminhamento de feedback por e-mail de devoluções e reclamações para uma identidade verificada do Amazon SES
O exemplo a seguir usa o comando
set-identity-feedback-forwarding-enabled
para permitir que um endereço de e-mail verificado receba notificações de devolução e reclamação por e-mail:aws ses set-identity-feedback-forwarding-enabled --identity
user@example.com
--forwarding-enabledVocê deve receber notificações de devolução e reclamação por meio do Amazon SNS ou do encaminhamento de feedback de e-mail e, portanto, só poderá desabilitar o encaminhamento de feedback de e-mail se selecionar um tópico do Amazon SNS para ambas as notificações.
Para obter mais informações sobre as notificações, consulte Usar notificações com o Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para ver detalhes da API, consulte SetIdentityFeedbackForwardingEnabled
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar set-identity-notification-topic
.
- AWS CLI
-
Como definir o tópico do Amazon SNS no qual o Amazon SES publicará notificações de devolução, reclamação e/ou entrega de uma identidade verificada
O exemplo a seguir usa o comando
set-identity-notification-topic
para especificar o tópico do Amazon SNS para o qual um endereço de e-mail verificado receberá notificações de devolução:aws ses set-identity-notification-topic --identity
user@example.com
--notification-typeBounce
--sns-topicarn:aws:sns:us-east-1:EXAMPLE65304:MyTopic
Para obter mais informações sobre as notificações, consulte Usar notificações com o Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para ver detalhes da API, consulte SetIdentityNotificationTopic
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar verify-domain-dkim
.
- AWS CLI
-
Como gerar tokens DKIM de um domínio verificado para assinatura DKIM com o Amazon SES
O exemplo a seguir usa o comando
verify-domain-dkim
para gerar tokens DKIM para um domínio verificado com o Amazon SES:aws ses verify-domain-dkim --domain
example.com
Saída:
{ "DkimTokens": [ "EXAMPLEq76owjnks3lnluwg65scbemvw", "EXAMPLEi3dnsj67hstzaj673klariwx2", "EXAMPLEwfbtcukvimehexktmdtaz6naj" ] }
Para configurar o DKIM, você deve usar os tokens DKIM retornados para atualizar as configurações de DNS do seu domínio com registros CNAME que apontam para chaves públicas DKIM hospedadas pelo Amazon SES. Para obter mais informações, consulte Easy DKIM no Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para ver detalhes da API, consulte VerifyDomainDkim
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar verify-domain-identity
.
- AWS CLI
-
Para verificar um domínio com o Amazon SES
O exemplo a seguir usa o comando
verify-domain-identity
para verificar um domínio:aws ses verify-domain-identity --domain
example.com
Saída:
{ "VerificationToken": "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE" }
Para concluir a verificação do domínio, você deverá adicionar um registro TXT com o token de verificação retornado às configurações de DNS do seu domínio. Para obter mais informações, consulte Verificar domínios no Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para obter os detalhes da API, consulte VerifyDomainIdentity
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar verify-email-identity
.
- AWS CLI
-
Para verificar um endereço de e-mail com o Amazon SES
O exemplo a seguir usa o comando
verify-email-identity
para verificar um endereço de e-mail:aws ses verify-email-identity --email-address
user@example.com
Antes de enviar e-mails usando o Amazon SES, você deve verificar que o endereço ou domínio do qual você está enviando o email para provar que você é o proprietário. Se você ainda não tem acesso de produção, também precisará verificar todos os endereços de e-mail aos quais envia e-mails, exceto aqueles fornecidos pelo simulador de caixa de correio do Amazon SES.
Depois que verify-email-identity for chamado, o endereço de e-mail receberá um e-mail de verificação. O usuário deve clicar no link do e-mail para concluir o processo de verificação.
Para saber mais, consulte Verificar endereços de e-mail no Amazon SES no Guia do desenvolvedor do Amazon Simple Email Service.
-
Para obter os detalhes da API, consulte VerifyEmailIdentity
na Referência de comandos da AWS CLI.
-