Exemples d’utilisation de l’AWS CLI avec Amazon SES - AWS Command Line Interface

Exemples d’utilisation de l’AWS CLI avec Amazon SES

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec Amazon SES.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser delete-identity.

AWS CLI

Pour supprimer une identité

L'exemple suivant utilise la commande delete-identity pour supprimer une identité de la liste des identités vérifiées auprès d'Amazon SES :

aws ses delete-identity --identity user@example.com

Pour plus d’informations sur les identités vérifiées, consultez Vérification des adresses e-mail et des domaines dans Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

  • Pour plus de détails sur l’API, consultez DeleteIdentity dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-identity-dkim-attributes.

AWS CLI

Pour obtenir les attributs Easy DKIM d’Amazon SES d’une liste d’identités

L’exemple suivant utilise la commande get-identity-dkim-attributes pour récupérer les attributs Easy DKIM d’Amazon SES d’une liste d’identités :

aws ses get-identity-dkim-attributes --identities "example.com" "user@example.com"

Sortie :

{ "DkimAttributes": { "example.com": { "DkimTokens": [ "EXAMPLEjcs5xoyqytjsotsijas7236gr", "EXAMPLEjr76cvoc6mysspnioorxsn6ep", "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k" ], "DkimEnabled": true, "DkimVerificationStatus": "Success" }, "user@example.com": { "DkimEnabled": false, "DkimVerificationStatus": "NotStarted" } } }

Si vous appelez cette commande avec une identité que vous n’avez jamais soumise pour vérification, cette identité n’apparaîtra pas dans la sortie.

Pour plus d’informations sur Easy DKIM, consultez Easy DKIM dans Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

L’exemple de code suivant montre comment utiliser get-identity-notification-attributes.

AWS CLI

Pour obtenir les attributs de notification Amazon SES d’une liste d’identités

L’exemple suivant utilise la commande get-identity-notification-attributes pour récupérer les attributs de notification Amazon SES d’une liste d’identités :

aws ses get-identity-notification-attributes --identities "user1@example.com" "user2@example.com"

Sortie :

{ "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 } } }

Cette commande renvoie le statut du transfert des commentaires par e-mail et, le cas échéant, les Amazon Resource Names (ARN) des rubriques Amazon SNS auxquelles les notifications de retour à l’expéditeur, de réclamation et de remise sont envoyées.

Si vous appelez cette commande avec une identité que vous n’avez jamais soumise pour vérification, cette identité n’apparaîtra pas dans la sortie.

Pour plus d’informations, consultez Using Notifications With Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

L’exemple de code suivant montre comment utiliser get-identity-verification-attributes.

AWS CLI

Pour obtenir le statut de vérification Amazon SES pour une liste d'identités

L'exemple suivant utilise la commande get-identity-verification-attributes pour récupérer le statut de vérification Amazon SES pour une liste d'identités :

aws ses get-identity-verification-attributes --identities "user1@example.com" "user2@example.com"

Sortie :

{ "VerificationAttributes": { "user1@example.com": { "VerificationStatus": "Success" }, "user2@example.com": { "VerificationStatus": "Pending" } } }

Si vous appelez cette commande avec une identité que vous n'avez jamais soumise pour vérification, cette identité n'apparaîtra pas dans la sortie.

Pour plus d’informations sur les identités vérifiées, consultez Vérification des adresses e-mail et des domaines dans Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

L’exemple de code suivant montre comment utiliser get-send-quota.

AWS CLI

Pour obtenir vos limites d'envoi Amazon SES

L'exemple suivant utilise la commande get-send-quota pour renvoyer vos limites d'envoi Amazon SES :

aws ses get-send-quota

Sortie :

{ "Max24HourSend": 200.0, "SentLast24Hours": 1.0, "MaxSendRate": 1.0 }

Max24HourSend est votre quota d'envoi, soit le nombre maximal d'e-mails que vous pouvez envoyer sur une période de 24 heures. Le quota d'envoi reflète une période glissante. Chaque fois que vous essayez d'envoyer un e-mail, Amazon SES vérifie le nombre d'e-mails que vous avez envoyés dans les dernières 24 heures. Tant que le nombre total d'e-mails que vous avez envoyés est inférieur à votre quota, votre demande d'envoi est acceptée et votre e-mail est envoyé.

SentLast24Hours est le nombre d'e-mails que vous avez envoyés dans les dernières 24 heures.

MaxSendRate est le nombre maximal d'e-mails que vous pouvez envoyer par seconde.

Notez que les limites d'envoi sont définies en fonction des destinataires et non pas des messages. Par exemple, un e-mail qui a 10 destinataires compte pour 10 dans votre quota d'envoi.

Pour plus d’informations, consultez Gestion de vos limites d’envoi Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

  • Pour plus de détails sur l’API, consultez GetSendQuota dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-send-statistics.

AWS CLI

Pour obtenir vos statistiques d’envoi Amazon SES

L’exemple suivant utilise la commande get-send-statistics pour renvoyer vos limites d’envoi Amazon SES :

aws ses get-send-statistics

Sortie :

{ "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 } ] }

Le résultat est une liste de points de données représentant les deux dernières semaines de l’activité d’envoi. Chaque point de données de la liste contient des statistiques pour un intervalle de 15 minutes.

Cet exemple ne comprend que deux points de données, car les seuls e-mails envoyés par l’utilisateur au cours des deux dernières semaines se situaient à deux intervalles de 15 minutes.

Pour plus d’informations, consultez Monitoring Your Amazon SES Usage Statistics dans le Manuel du développeur Amazon Simple Email Service.

  • Pour plus de détails sur l’API, consultez GetSendStatistics dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-identities.

AWS CLI

Pour répertorier toutes les identités (adresses e-mail et domaines) pour un compte AWS spécifique

L'exemple suivant utilise la commande list-identities pour répertorier toutes les identités soumises pour vérification auprès d'Amazon SES :

aws ses list-identities

Sortie :

{ "Identities": [ "user@example.com", "example.com" ] }

La liste renvoyée contient toutes les identités, quel que soit le statut de vérification (vérifié, en attente de vérification, échec, etc.).

Dans cet exemple, les adresses e-mail et les domaines sont renvoyés, car nous n’avons pas spécifié le paramètre identity-type.

Pour plus d’informations sur la vérification, consultez Vérification des adresses e-mail et des domaines dans Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

  • Pour plus de détails sur l’API, consultez ListIdentities dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser send-email.

AWS CLI

Pour envoyer un e-mail formaté à l'aide d'Amazon SES

L'exemple suivant utilise la commande send-email pour envoyer un e-mail formaté :

aws ses send-email --from sender@example.com --destination file://destination.json --message file://message.json

Sortie :

{ "MessageId": "EXAMPLEf3a5efcd1-51adec81-d2a4-4e3f-9fe2-5d85c1b23783-000000" }

La destination et le message sont des structures de données JSON enregistrées dans des fichiers .json du répertoire actuel. Ces fichiers sont les suivants :

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" } } }

Remplacez les adresses e-mail de l'expéditeur et du destinataire par celles que vous souhaitez utiliser. Notez que l'adresse e-mail de l'expéditeur doit être vérifiée avec Amazon SES. Jusqu'à ce que vous obteniez un accès en production pour Amazon SES, vous devez également vérifier l'adresse e-mail de chaque destinataire, sauf si le destinataire est le simulateur de boîte aux lettres Amazon SES. Pour plus d’informations sur la vérification, consultez Vérification des adresses e-mail et des domaines dans Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

L'ID du message dans la sortie indique que l'appel pour envoyer un e-mail a réussi.

Si vous ne recevez pas l'e-mail, vérifiez votre boîte de courrier indésirable.

Pour plus d’informations sur l’envoi d’un e-mail formaté, consultez Envoi d’e-mails formatés à l’aide de l’API Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

  • Pour plus de détails sur l’API, consultez SendEmail dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser send-raw-email.

AWS CLI

Pour envoyer un e-mail brut à l'aide d'Amazon SES

L'exemple suivant utilise la commande send-raw-email pour envoyer un e-mail avec une pièce jointe TXT :

aws ses send-raw-email --raw-message file://message.json

Sortie :

{ "MessageId": "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000" }

Le message brut est une structure de données JSON enregistrée dans un fichier nommé message.json dans le répertoire actuel. Il contient les éléments suivants :

{ "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--" }

Comme vous pouvez le constater, « Data » est une longue chaîne contenant l'intégralité du contenu de l'e-mail brut au format MIME, y compris une pièce jointe appelée attachment.txt.

Remplacez sender@example.com et recipient@example.com par les adresses que vous souhaitez utiliser. Notez que l'adresse e-mail de l'expéditeur doit être vérifiée avec Amazon SES. Jusqu'à ce que vous obteniez un accès en production pour Amazon SES, vous devez également vérifier l'adresse e-mail du destinataire, sauf si le destinataire est le simulateur de boîte aux lettres Amazon SES. Pour plus d’informations sur la vérification, consultez Vérification des adresses e-mail et des domaines dans Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

L'ID du message dans la sortie indique que l'appel pour send-raw-email a réussi.

Si vous ne recevez pas l'e-mail, vérifiez votre boîte de courrier indésirable.

Pour plus d’informations sur l’envoi d’un e-mail brut, consultez Envoi d’e-mails bruts à l’aide de l’API Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

  • Pour plus de détails sur l’API, consultez SendRawEmail dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser set-identity-dkim-enabled.

AWS CLI

Pour activer ou désactiver Easy DKIM pour une identité vérifiée Amazon SES

L’exemple suivant utilise la commande set-identity-dkim-enabled pour désactiver DKIM pour une adresse e-mail vérifiée :

aws ses set-identity-dkim-enabled --identity user@example.com --no-dkim-enabled

Pour plus d’informations sur Easy DKIM, consultez Easy DKIM dans Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

  • Pour plus de détails sur l’API, consultez SetIdentityDkimEnabled dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser set-identity-feedback-forwarding-enabled.

AWS CLI

Activer ou désactiver le transfert des notifications de retour à l’expéditeur et de réclamation par e-mail pour une identité Amazon SES vérifiée

L’exemple suivant utilise la commande set-identity-feedback-forwarding-enabled pour permettre à une adresse e-mail vérifiée de recevoir des notifications de retour à l’expéditeur et de réclamation par e-mail :

aws ses set-identity-feedback-forwarding-enabled --identity user@example.com --forwarding-enabled

Vous devez recevoir les notifications de retour à l’expéditeur et de réclamation via Amazon SNS ou le transfert de commentaires par e-mail. Vous ne pouvez donc désactiver le transfert des commentaires par e-mail que si vous sélectionnez une rubrique Amazon SNS pour les notifications de retour à l’expéditeur et de réclamation.

Pour plus d’informations, consultez Using Notifications With Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

L’exemple de code suivant montre comment utiliser set-identity-notification-topic.

AWS CLI

Pour définir la rubrique Amazon SNS à laquelle Amazon SES publie les notifications de retour à l’expéditeur, de réclamation et/ou de remise de message pour une identité vérifiée

L’exemple suivant utilise la commande set-identity-notification-topic pour spécifier la rubrique Amazon SNS pour laquelle une adresse e-mail vérifiée recevra des notifications de retour à l’expéditeur :

aws ses set-identity-notification-topic --identity user@example.com --notification-type Bounce --sns-topic arn:aws:sns:us-east-1:EXAMPLE65304:MyTopic

Pour plus d’informations, consultez Using Notifications With Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

L’exemple de code suivant montre comment utiliser verify-domain-dkim.

AWS CLI

Pour générer les jetons DKIM d’un domaine vérifié pour la signature DKIM avec Amazon SES

L’exemple suivant utilise la commande verify-domain-dkim pour générer les jetons DKIM d’un domaine vérifié avec Amazon SES :

aws ses verify-domain-dkim --domain example.com

Sortie :

{ "DkimTokens": [ "EXAMPLEq76owjnks3lnluwg65scbemvw", "EXAMPLEi3dnsj67hstzaj673klariwx2", "EXAMPLEwfbtcukvimehexktmdtaz6naj" ] }

Pour configurer DKIM, vous devez utiliser les jetons DKIM renvoyés pour mettre à jour les paramètres DNS de votre domaine avec des enregistrements CNAME pointant vers des clés publiques DKIM hébergées par Amazon SES. Pour plus d’informations, consultez Easy DKIM dans Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

  • Pour plus de détails sur l’API, consultez VerifyDomainDkim dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser verify-domain-identity.

AWS CLI

Pour vérifier un domaine avec Amazon SES

L'exemple suivant utilise la commande verify-domain-identity pour vérifier un domaine :

aws ses verify-domain-identity --domain example.com

Sortie :

{ "VerificationToken": "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE" }

Pour terminer la vérification du domaine, vous devez ajouter un enregistrement TXT avec le jeton de vérification renvoyé aux paramètres DNS de votre domaine. Pour plus d’informations, consultez Vérification des domaines dans Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

  • Pour plus de détails sur l’API, consultez VerifyDomainIdentity dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser verify-email-identity.

AWS CLI

Pour vérifier une adresse e-mail avec Amazon SES

L'exemple suivant utilise la commande verify-email-identity pour vérifier une adresse e-mail :

aws ses verify-email-identity --email-address user@example.com

Avant de pouvoir envoyer un e-mail avec Amazon SES, vous devez vérifier l'adresse ou le domaine à partir desquels vous envoyez l'e-mail afin de prouver que vous en êtes le propriétaire. Si vous n'avez pas encore l'accès en production, vous devez également vérifier toutes les adresses e-mail des destinataires, à l'exception de celles fournies par le simulateur de boîte aux lettres Amazon SES.

Après avoir appelé verify-email-identity, l'adresse e-mail recevra un e-mail de vérification. L'utilisateur doit cliquer sur le lien disponible dans l'e-mail pour terminer le processus de vérification.

Pour plus d’informations, consultez Vérification des adresses e-mail dans Amazon SES dans le Manuel du développeur Amazon Simple Email Service.

  • Pour plus de détails sur l’API, consultez VerifyEmailIdentity dans la Référence des commandes de l’AWS CLI.