SingleSendMail - - Centre de documentation Alibaba Cloud

Envoie un e-mail unique.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

dm:SingleSendMail

none

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AccountName	string	Oui	L'adresse de l'expéditeur configurée dans la console de gestion.	test***@example.net
AddressType	integer	Oui	Le type d'adresse. Valeurs valides : 0 : compte aléatoire 1 : adresse de l'expéditeur	1
TagName	string	Non	La balise créée dans la console DirectMail. Les balises sont utilisées pour catégoriser les lots d'e-mails. Vous pouvez interroger l'état d'envoi de chaque lot par balise. Si la fonction de suivi des e-mails est activée, vous devez utiliser une balise d'e-mail lors de l'envoi des e-mails. La valeur doit comporter de 1 à 128 caractères et peut contenir des lettres, des chiffres, des traits de soulignement (_) et des traits d'union (-).	test
ReplyToAddress	boolean	Oui	Indique si l'adresse de réponse configurée dans la console de gestion doit être utilisée (l'adresse doit être vérifiée). Valeurs valides : true ou false.	true
ToAddress	string	Oui	L'adresse de destination. Vous pouvez spécifier plusieurs adresses e-mail séparées par des virgules. Un maximum de 100 adresses sont prises en charge (les listes de diffusion sont prises en charge).	test1***@example.net
Subject	string	Oui	L'objet de l'e-mail. La valeur ne peut pas dépasser 256 caractères.	Objet
HtmlBody	string	Non	Le corps HTML de l'e-mail. Remarque : HtmlBody et TextBody sont utilisés pour différents types de contenu d'e-mail. Vous devez spécifier l'un des deux. La limite de taille pour le passage de paramètres basé sur l'URL est d'environ 80 Ko. La limite de taille pour le passage de paramètres basé sur le corps avec le nouveau SDK est d'environ 8 Mo (Java 1.4.0 ou version ultérieure, Python3 1.4.0 ou version ultérieure, PHP 1.4.0 ou version ultérieure).	corps
TextBody	string	Non	Le corps textuel de l'e-mail. Remarque : HtmlBody et TextBody sont utilisés pour différents types de contenu d'e-mail. Vous devez spécifier l'un des deux. La limite de taille pour le passage de paramètres basé sur l'URL est d'environ 80 Ko. La limite de taille pour le passage de paramètres basé sur le corps avec le nouveau SDK est d'environ 8 Mo (Java 1.4.0 ou version ultérieure, Python3 1.4.0 ou version ultérieure, PHP 1.4.0 ou version ultérieure).	corps
FromAlias	string	Non	Le pseudonyme de l'expéditeur. La valeur ne peut pas dépasser 15 caractères. Par exemple, si le pseudonyme de l'expéditeur est défini sur "Jane" et que l'adresse de l'expéditeur est test*@example.net, le destinataire voit l'adresse de l'expéditeur sous la forme "Jane" test*@example.net.	Jane
ReplyAddress	string	Non	L'adresse de réponse.	test2***@example.net
ReplyAddressAlias	string	Non	Le pseudonyme de l'adresse de réponse.	Jane
ClickTrace	string	Non	Indique si le suivi des données doit être activé. Valeurs valides : 1 : activer le suivi des données. 0 (par défaut) : désactiver le suivi des données.	0
UnSubscribeLinkType	string	Non	Le type de lien de désabonnement. Valeurs valides : disabled : aucun lien de désabonnement n'est généré. default : la stratégie par défaut est utilisée. Un lien de désabonnement est généré lorsque des e-mails sont envoyés depuis des adresses d'expéditeur de type lot vers des domaines spécifiques, tels que ceux contenant les mots-clés "gmail", "yahoo", "google", "aol.com", "hotmail", "outlook" ou "ymail.com". Pour plus d'informations, consultez Mécanisme de génération et de filtrage des liens de désabonnement. La langue d'affichage est automatiquement détectée en fonction des paramètres du navigateur du destinataire.	default
UnSubscribeFilterLevel	string	Non	Le niveau de filtrage. Pour plus d'informations, consultez Mécanisme de génération et de filtrage des liens de désabonnement. Valeurs valides : disabled : aucun filtrage n'est appliqué. default : la stratégie par défaut est utilisée. Les adresses de lot utilisent le filtrage au niveau de l'adresse de l'expéditeur. mailfrom : filtrage au niveau de l'adresse de l'expéditeur. mailfrom_domain : filtrage au niveau du domaine de l'expéditeur. edm_id : filtrage au niveau du compte.	mailfrom_domain
Headers	string	Non	Les paramètres d'en-tête de l'e-mail. Les champs standard et non standard doivent respecter les exigences de syntaxe des en-têtes définies dans la norme. Un maximum de 10 en-têtes peuvent être transmis via le champ headers lors de l'envoi d'e-mails via l'API. Les en-têtes dépassant cette limite sont ignorés. SMTP n'a pas cette limite. Champs standard Message-ID, List-Unsubscribe, List-Unsubscribe-Post Les champs standard remplacent les valeurs d'origine dans l'en-tête de l'e-mail. Champs non standard Insensibles à la casse. a. Champs préfixés par X-User- (non transmis à EventBridge ou Message Service MNS. Il s'agit d'une exigence propre à l'API. SMTP autorise tous les champs personnalisés.) b. Champs préfixés par X-User-Notify- (transmis à EventBridge et Message Service MNS. L'API et SMTP sont tous deux pris en charge.) Lorsqu'ils sont transmis à EventBridge ou MNS, ces champs sont inclus sous le champ d'en-tête.	{ "Message-ID": "", "X-User-UID1": "UID-1-000001", "X-User-UID2": "UID-2-000001", "X-User-Notify-UID1": "UID-3-000001", "X-User-Notify-UID2": "UID-4-000001" }
IpPoolId	string	Non	L'identifiant du pool d'adresses IP dédiées. Les utilisateurs ayant acheté des adresses IP dédiées peuvent utiliser ce paramètre pour spécifier l'adresse IP sortante pour cet e-mail. Pour plus d'informations, consultez IP dédiée.	e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef
Attachments	array<object>	Non	Pris en charge uniquement lors de l'utilisation du nouveau SDK. Non pris en charge via l'OpenAPI ou les méthodes de mécanisme de signature. Pour plus d'informations, consultez Comment envoyer des e-mails avec des pièces jointes via le SDK ?.
	object	Non	Pris en charge uniquement lors de l'utilisation du nouveau SDK. Non pris en charge via l'OpenAPI ou les méthodes de mécanisme de signature.
AttachmentName	string	Non	Pris en charge uniquement lors de l'utilisation du nouveau SDK. Non pris en charge via l'OpenAPI ou les méthodes de mécanisme de signature.	test.txt
AttachmentUrl	string	Non	Pris en charge uniquement lors de l'utilisation du nouveau SDK. Non pris en charge via l'OpenAPI ou les méthodes de mécanisme de signature.	C:\Users\Downloads\test.txt
Template	object	Non	Les informations sur le modèle pour l'envoi basé sur un modèle. Lors de l'envoi avec un modèle, les valeurs HtmlBody et TextBody sont ignorées.
TemplateId	string	Non	L'identifiant du modèle.	xxx
TemplateData	object	Non	Les variables et valeurs du modèle.
	string	Non	Le paramètre et la valeur de la variable du modèle.	{ "name": "Tom", "age": "22" }
BccAddress	string	Non	Spécifie la liste des destinataires en Cci (copie carbone invisible) pour l'e-mail. Le système envoie une copie identique au contenu principal de l'e-mail à chaque adresse Cci. Les informations Cci ne sont visibles par aucun destinataire (y compris ToAddress et BccAddress). Pour protéger la confidentialité des destinataires en Cci, les fonctionnalités de suivi des e-mails sont désactivées par défaut pour les e-mails en Cci. Cela signifie que le système n'enregistre pas les données comportementales telles que les taux d'ouverture ou les taux de clics pour les e-mails en Cci. Cependant, la facturation du volume d'envoi, des détails d'envoi et des statistiques d'état d'envoi reste cohérente avec les e-mails ordinaires. Un maximum de 2 destinataires en Cci peuvent être spécifiés par envoi. Remarque : l'opération SingleSendMail ne prend pas en charge le champ Cc (copie carbone). Utilisez SMTP si vous avez besoin de cette fonctionnalité.	1@example.com,2@example.com
DomainAuth	boolean	Non	Indique si l'authentification au niveau du domaine doit être activée. Valeurs valides : true false Utilisez ce paramètre uniquement pour l'authentification au niveau du domaine. Ignorez-le pour l'authentification au niveau de l'adresse de l'expéditeur. Créez l'adresse domain-auth-created-by-system@example.com dans la console. Conservez le préfixe avant @ inchangé et utilisez votre propre nom de domaine comme suffixe. Scénario API Définissez AccountName sur une adresse d'expéditeur personnalisée pour le domaine. Le destinataire voit l'adresse d'expéditeur personnalisée comme expéditeur. Scénario SMTP a. Définissez le mot de passe du domaine via l'opération ModifyPWByDomain. b. Authentifiez-vous en utilisant le nom de domaine et le mot de passe configuré. Transmettez une adresse personnalisée telle que user@example.com comme expéditeur réel (mailfrom). Le destinataire voit user@example.com comme expéditeur.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object
EnvId	string	L'identifiant de l'événement.	600000xxxxxxxxxx642
RequestId	string	L'identifiant de la requête.	2D086F6-xxxx-xxxx-xxxx-006DED011A85

Exemples

JSON format

{
  "EnvId": "600000xxxxxxxxxx642",
  "RequestId": "2D086F6-xxxx-xxxx-xxxx-006DED011A85"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidReceiverName.Malformed	The format of the receiver name is invalid. It must contain the @ sign. The domain must only contain numbers, letters, underscores, minus signs, and periods. The account name must only contain numbers, letters, underscores, minus signs, and periods.	Le format du destinataire est invalide. L'adresse doit contenir le symbole @. Le nom de domaine ne peut contenir que des chiffres, des lettres, des traits de soulignement, des traits d'union et des points. Le nom du compte ne peut contenir que des chiffres, des lettres, des traits de soulignement, des traits d'union et des points.
404	InvalidMailAddress.NotFound	The specified mail address is not found.	L'adresse d'expéditeur n'a pas été trouvée.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.