Email - Send

Référence

Service:: Communication

Version d'API:: 2023-03-31

Met en file d’attente un message électronique à envoyer à un ou plusieurs destinataires

POST {endpoint}/emails:send?api-version=2023-03-31

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (url)	Ressource de communication, par exemple https://my-resource.communication.azure.com
api-version	query	True	string	Version de l’API à appeler.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Chaîne d’authentification contenant une signature générée à l’aide de HMAC-SHA256 schéma.
Operation-Id		string (uuid)	Il s’agit de l’ID fourni par le client pour identifier l’opération de longue durée. Si un ID n’est pas fourni par le client, le service en génère un.
x-ms-client-request-id		string (uuid)	ID de suivi envoyé avec la demande pour faciliter le débogage.

Corps de la demande

Nom	Obligatoire	Type	Description
content	True	EmailContent	Contenu de messagerie à envoyer.
recipients	True	EmailRecipients	Destinataires de l’e-mail.
senderAddress	True	string	Adresse e-mail de l’expéditeur à partir d’un domaine vérifié.
attachments		EmailAttachment[]	Liste des pièces jointes. Notez que nous limitons la taille totale d’une demande de messagerie (qui inclut des pièces jointes) à 10 Mo.
headers		object	En-têtes de courrier personnalisés à passer.
replyTo		EmailAddress[]	Adresses e-mail auxquelles les réponses des destinataires seront envoyées.
userEngagementTrackingDisabled		boolean	Indique si le suivi de l’engagement utilisateur doit être désactivé pour cette demande si le paramètre de suivi de l’engagement utilisateur au niveau de la ressource a déjà été activé dans le plan de contrôle.

Réponses

Nom	Type	Description
202 Accepted	EmailSendResult	Le service a accepté la demande et commencera à traiter le message ultérieurement. Il retourne immédiatement « Accepté » et inclut un en-tête « Operation-Location ». Le côté client doit interroger davantage l’état de l’opération/du message à l’aide de l’URL spécifiée dans l’en-tête « Operation-Location ». Une fois l’opération d’envoi réussie, vous pouvez obtenir un état supplémentaire sur la remise par e-mail par le biais d’événements Azure Monitor ou Event Grid (pour référence d’événements, reportez-vous à : https://learn.microsoft.com/en-us/azure/event-grid/communication-services-email-events) En-têtes Operation-Location: string retry-after: integer
Other Status Codes	ErrorResponse	Erreur En-têtes x-ms-error-code: string

Nom

Type

Description

202 Accepted

EmailSendResult

Le service a accepté la demande et commencera à traiter le message ultérieurement. Il retourne immédiatement « Accepté » et inclut un en-tête « Operation-Location ». Le côté client doit interroger davantage l’état de l’opération/du message à l’aide de l’URL spécifiée dans l’en-tête « Operation-Location ». Une fois l’opération d’envoi réussie, vous pouvez obtenir un état supplémentaire sur la remise par e-mail par le biais d’événements Azure Monitor ou Event Grid (pour référence d’événements, reportez-vous à : https://learn.microsoft.com/en-us/azure/event-grid/communication-services-email-events)

En-têtes

Operation-Location: string
retry-after: integer

Other Status Codes

ErrorResponse

Erreur

En-têtes

x-ms-error-code: string

Sécurité

Authorization

Chaîne d’authentification contenant une signature générée à l’aide de HMAC-SHA256 schéma.

Type: apiKey
Dans: header

Exemples

Send Email

Exemple de requête

HTTP

POST https://contoso.westus.communications.azure.com/emails:send?api-version=2023-03-31


{
  "headers": {
    "ClientCorrelationId": "123",
    "ClientCustomHeaderName": "ClientCustomHeaderValue"
  },
  "senderAddress": "abc@domain.com",
  "content": {
    "subject": "An exciting offer especially for you!",
    "plainText": "This exciting offer was created especially for you, our most loyal customer.",
    "html": "<html><head><title>Exciting offer!</title></head><body><h1>This exciting offer was created especially for you, our most loyal customer.</h1></body></html>"
  },
  "recipients": {
    "to": [
      {
        "address": "john.doe@domain.com",
        "displayName": "John Doe"
      },
      {
        "address": "jane.doe@domain2.com",
        "displayName": "Jane Doe"
      }
    ],
    "cc": [
      {
        "address": "wendy@someotherdomain.com",
        "displayName": "Wendy"
      },
      {
        "address": "jimmy@anotherdomain.com",
        "displayName": "Jimmy Johns"
      }
    ],
    "bcc": [
      {
        "address": "bob@anotherdomain.com",
        "displayName": "Bob"
      },
      {
        "address": "mail@yetanotherdomain.com",
        "displayName": "Another DisplayName"
      }
    ]
  },
  "attachments": [
    {
      "name": "MyAttachment.pdf",
      "contentType": "application/pdf",
      "contentInBase64": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
    },
    {
      "name": "MyAttachment2.docx",
      "contentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "contentInBase64": "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ="
    }
  ],
  "replyTo": [
    {
      "address": "contoso-support@contoso.com",
      "displayName": "Contoso Support"
    }
  ],
  "userEngagementTrackingDisabled": true
}

Exemple de réponse

Code d’état:: 202

Operation-Location: https://contoso.westus.communications.azure.com//emails/operations/8540c0de-899f-5cce-acb5-3ec493af3800?api-version=2023-03-31
retry-after: 20

{
  "id": "8540c0de-899f-5cce-acb5-3ec493af3800",
  "status": "Running"
}

Définitions

Nom	Description
EmailAddress	Objet représentant l’adresse e-mail et son nom complet
EmailAttachment	Pièce jointe à l’e-mail.
EmailContent	Contenu de l’e-mail.
EmailMessage	Charge utile de message pour l’envoi d’un e-mail
EmailRecipients	Destinataires de l’e-mail
EmailSendResult	État de l’opération de longue durée
EmailSendStatus	État de l’opération.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur

EmailAddress

Object

Objet représentant l’adresse e-mail et son nom complet

Nom	Type	Description
address	string	Adresse courriel.
displayName	string	Nom complet de l’e-mail.

EmailAttachment

Object

Pièce jointe à l’e-mail.

Nom	Type	Description
contentInBase64	string (byte)	Contenu codé en base64 de la pièce jointe
contentType	string	Type MIME du contenu attaché.
name	string	Nom de la pièce jointe

EmailContent

Object

Contenu de l’e-mail.

Nom	Type	Description
html	string	Version html du message électronique.
plainText	string	Version en texte brut du message électronique.
subject	string	Objet du message électronique

EmailMessage

Object

Charge utile de message pour l’envoi d’un e-mail

Nom	Type	Description
attachments	EmailAttachment[]	Liste des pièces jointes. Notez que nous limitons la taille totale d’une demande de messagerie (qui inclut des pièces jointes) à 10 Mo.
content	EmailContent	Contenu de messagerie à envoyer.
headers	object	En-têtes de courrier personnalisés à passer.
recipients	EmailRecipients	Destinataires de l’e-mail.
replyTo	EmailAddress[]	Adresses e-mail auxquelles les réponses des destinataires seront envoyées.
senderAddress	string	Adresse e-mail de l’expéditeur à partir d’un domaine vérifié.
userEngagementTrackingDisabled	boolean	Indique si le suivi de l’engagement utilisateur doit être désactivé pour cette demande si le paramètre de suivi de l’engagement utilisateur au niveau de la ressource a déjà été activé dans le plan de contrôle.

EmailRecipients

Object

Destinataires de l’e-mail

Nom	Type	Description
bcc	EmailAddress[]	Destinataires du cci de messagerie
cc	EmailAddress[]	Destinataires CC d’e-mail
to	EmailAddress[]	Adresse e-mail aux destinataires

EmailSendResult

Object

État de l’opération de longue durée

Nom	Type	Description
error	ErrorDetail	Détails de l’erreur lorsque l’état est un état terminal non réussi.
id	string	ID unique de l’opération. Utilisez un UUID.
status	EmailSendStatus	État de l’opération.

EmailSendStatus

Énumération

État de l’opération.

Valeur	Description
Canceled
Failed
NotStarted
Running
Succeeded

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

Partager via

Email - Send

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Authorization

Exemples

Send Email

Exemple de requête

Exemple de réponse

Définitions

EmailAddress

EmailAttachment

EmailContent

EmailMessage

EmailRecipients

EmailSendResult

EmailSendStatus

ErrorAdditionalInfo

ErrorDetail

ErrorResponse