Partager via

Démarrage rapide : interroger le statut d’email manuellement lors de l’envoi d’e-mails

  • Article

Dans ce guide de démarrage rapide, vous allez découvrir comment interroger le statut d’e-mail manuellement lors de l’envoi d’e-mails à l’aide de nos SDK d’e-mail.

Commencez avec Azure Communication Services en utilisant la bibliothèque de client Communication Services .NET Email pour envoyer des e-mails.

Conseil

Démarrez votre expérience d’envoi d’e-mails avec Azure Communication Services en passant directement à l’exemple de code Envoi de Email de base et Email d’envoi avancé sur GitHub.

Comprendre le modèle objet de l’e-mail

Les classes et les interfaces suivantes gèrent certaines des principales fonctionnalités de la bibliothèque de client Azure Communication Services Email pour C#.

Nom Description
EmailAddress Cette classe contient une adresse e-mail et une option pour un nom d’affichage.
EmailAttachment Cette classe crée une pièce jointe d’e-mail en acceptant un ID unique, une chaîne de pièce jointe d’e-mail de type MIME, des données binaires pour le contenu et un ID de contenu facultatif pour la définir en tant que pièce jointe inline.
EmailClient Cette classe est nécessaire pour toutes les fonctionnalités de messagerie. Vous l’instanciez avec vos chaîne de connexion et vous l’utilisez pour envoyer des e-mails.
EmailClientOptions Cette classe peut être ajoutée à l’instanciation de EmailClient pour cibler une version d’API spécifique.
EmailContent Cette classe contient l’objet et le corps de l’e-mail. Vous devez spécifier au moins un contenu PlainText ou Html
EmailCustomHeader Cette classe permet l’ajout d’une paire nom et valeur pour un en-tête personnalisé. L’importance de l’e-mail peut également être spécifiée par le biais de ces en-têtes à l’aide du nom d’en-tête « x-priority » ou « x-msmail-priority »
EmailMessage Cette classe combine l’expéditeur, le contenu et les destinataires. Des en-têtes personnalisés, des pièces jointes et des adresses e-mail de réponse peuvent également être ajoutés.
EmailRecipients Cette classe contient des listes d’objets EmailAddress pour les destinataires de l’e-mail, y compris les listes facultatives pour les destinataires CC et BCC.
EmailSendOperation Cette classe représente l’opération d’envoi asynchrone d’e-mail et est renvoyée à partir d’un appel d’API d’envoi d’e-mail.
EmailSendResult Cette classe contient les résultats de l’opération d’envoi d’e-mail. Il a un ID d’opération, un état d’opération et un objet d’erreur (le cas échéant).

EmailSendResult renvoie l’état suivant sur l’opération de messagerie effectuée.

Statut Description
NotStarted Nous n’envoyons pas cet état à partir de notre service pour l’instant.
Exécution en cours L’opération d’envoi d’e-mail est en cours de traitement.
Opération réussie L’opération d’envoi d’e-mail s’est terminée sans erreur et l’e-mail est en attente de remise. Tout état détaillé de la remise d’e-mail au-delà de cette étape peut être obtenu via Azure Monitor ou via Azure Event Grid. Découvrir comment s’abonner à des événements par e-mail
Échec L’opération d’envoi d’e-mail n’a pas réussi et a rencontré une erreur. L’e-mail n’a pas été envoyé. Le résultat contient un objet d’erreur avec des détails supplémentaires sur la cause de l’échec.

Prérequis

Suivre ce guide de démarrage rapide entraîne un coût minime de quelques cents USD tout au plus dans votre compte Azure.

Notes

Nous pouvons également envoyer un e-mail à partir de notre propre domaine vérifié. Ajouter des domaines personnalisés vérifiés à Email Communication Service.

Vérification du prérequis

  • Dans une fenêtre de terminal ou de commande, exécutez la commande dotnet pour vérifier que la bibliothèque de client .NET est installée.
  • Pour voir les sous-domaines associés à votre ressource Email Communication Services, connectez-vous au portail Azure, localisez votre ressource Email Communication Services, puis ouvrez l’onglet Provisionner des domaines dans le volet de navigation gauche.

Créer une application C#

Dans une fenêtre de console (par exemple cmd, PowerShell ou Bash), utilisez la commande dotnet new pour créer une application console avec le nom EmailQuickstart. Cette commande crée un projet C# « Hello World » simple avec un seul fichier source : Program.cs.

dotnet new console -o EmailQuickstart

Remplacez votre répertoire par le dossier d’application que vous venez de créer, puis utilisez la commande dotnet build pour compiler votre application.

cd EmailQuickstart
dotnet build

Installer le package

Toujours dans le répertoire de l’application, installez le package de la bibliothèque de client Communication Services Email pour .NET en utilisant la commande dotnet add package.

dotnet add package Azure.Communication.Email

Création du client de messagerie avec l’authentification

Ouvrez Program.cs et remplacez le code existant par ce qui suit pour ajouter des directives using afin d’inclure l’espace de noms Azure.Communication.Email et un point de départ pour l’exécution de votre programme.


using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

using Azure;
using Azure.Communication.Email;

namespace SendEmail
{
  internal class Program
  {
    static async Task Main(string[] args)
    {

    }
  }
}

Il existe différentes options disponibles pour authentifier un client de messagerie :

Ouvrez Program.cs dans un éditeur de texte, puis remplacez le corps de la méthode Main par du code permettant d’initialiser un EmailClient avec votre chaîne de connexion. Le code suivant récupère la chaîne de connexion de la ressource à partir d’une variable d’environnement nommée COMMUNICATION_SERVICES_CONNECTION_STRING. Découvrez comment gérer la chaîne de connexion de la ressource.

// This code demonstrates how to fetch your connection string
// from an environment variable.
string connectionString = Environment.GetEnvironmentVariable("COMMUNICATION_SERVICES_CONNECTION_STRING");
EmailClient emailClient = new EmailClient(connectionString);

Envoi asynchrone d’e-mail et interrogation de l’état d’envoi d’e-mail

Lorsque vous appelez SendAsync avec Azure.WaitUntil.Started, la méthode est renvoyée après le démarrage de l’opération. La méthode renvoie l’objet EmailSendOperation. Vous pouvez appeler la méthode UpdateStatusAsync pour actualiser l’état de l’opération d’e-mail.

L’objet EmailSendOperation renvoyé contient un objet EmailSendStatus dans lequel figurent les éléments suivants :

  • État actuel de l’opération d’envoi d’e-mail.
  • Objet d’erreur avec les détails de l’échec en cas d’échec de l’état actuel ;

//Replace with your domain and modify the content, recipient details as required
var subject = "Welcome to Azure Communication Service Email APIs.";
var htmlContent = "<html><body><h1>Quick send email test</h1><br/><h4>This email message is sent from Azure Communication Service Email.</h4><p>This mail was sent using .NET SDK!!</p></body></html>";
var sender = "donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net";
var recipient = "emailalias@contoso.com";

/// Send the email message with WaitUntil.Started
EmailSendOperation emailSendOperation = await emailClient.SendAsync(
    Azure.WaitUntil.Started,
    sender,
    recipient,
    subject,
    htmlContent);

/// Call UpdateStatus on the email send operation to poll for the status
/// manually.
try
{
    while (true)
    {
        await emailSendOperation.UpdateStatusAsync();
        if (emailSendOperation.HasCompleted)
        {
            break;
        }
        await Task.Delay(100);
    }

    if (emailSendOperation.HasValue)
    {
        Console.WriteLine($"Email queued for delivery. Status = {emailSendOperation.Value.Status}");
    }
}
catch (RequestFailedException ex)
{
    Console.WriteLine($"Email send failed with Code = {ex.ErrorCode} and Message = {ex.Message}");
}

/// Get the OperationId so that it can be used for tracking the message for troubleshooting
string operationId = emailSendOperation.Id;
Console.WriteLine($"Email operation id = {operationId}");

Exécutez l’application à partir de votre répertoire d’application avec la commande dotnet run.

dotnet run

Exemple de code

Vous pouvez télécharger l’exemple d’application à partir de GitHub.

Dépannage

Remise d’e-mails

Pour résoudre les problèmes liés à la remise d’e-mails, vous pouvez obtenir l’état de la remise de l’e-mail pour capturer les détails de la remise.

Important

Le résultat de réussite retourné par l’interrogation du statut de l’opération d’envoi valide uniquement le fait que l’e-mail a été envoyé avec succès pour remise. Pour obtenir des informations supplémentaires sur le statut de la remise du côté du destinataire, vous devez référencer la façon de gérer les événements de messagerie.

Limitation d’email

Si vous voyez que votre application est bloquée, cela peut être dû à la limitation de l’envoi d’e-mails. Vous pouvez gérer cela via la journalisation ou en implémentant une stratégie personnalisée.

Notes

Cette configuration de bac à sable (sandbox) permet aux développeurs de commencer à générer l’application. Vous pouvez demander progressivement d’augmenter le volume d’envoi une fois que l’application est prête à démarrer. Envoyez une demande de support pour déclencher votre limite d’envoi souhaitée si vous avez besoin d’envoyer un volume de messages dépassant les limites de débit.

Nettoyer les ressources Azure Communication Service

Si vous voulez nettoyer et supprimer un abonnement Communication Services, vous pouvez supprimer la ressource ou le groupe de ressources. La suppression du groupe de ressources efface également les autres ressources qui y sont associées. Apprenez-en davantage sur le nettoyage des ressources.

Étapes suivantes

Dans ce guide de démarrage rapide, vous avez appris à interroger le statut manuellement lors de l’envoi d’e-mails à l’aide de Azure Communication Services.

Vous voudrez peut-être aussi :