Azure.Communication.Email 1.0.0-beta.1

Azure Communication Email client library for .NET

This package contains a C# SDK for Azure Communication Services for Email.

Source code | Package (NuGet) | Product documentation

Getting started

Install the package

Install the Azure Communication Email client library for .NET with NuGet:

dotnet add package Azure.Communication.Email --prerelease

Prerequisites

You need an Azure subscription, a Communication Service Resource, and an Email Communication Resource with an active Domain.

To create these resource, you can use the Azure Portal, the Azure PowerShell, or the .NET management client library.

Key concepts

EmailClient provides the functionality to send email messages .

Using statements

using Azure.Communication.Email;
using Azure.Communication.Email.Models;

Authenticate the client

Email clients can be authenticated using the connection string acquired from an Azure Communication Resource in the Azure Portal.

var connectionString = "<connection_string>"; // Find your Communication Services resource in the Azure portal
EmailClient client = new EmailClient(connectionString);

Alternatively, Email clients can also be authenticated using a valid token credential. With this option, AZURE_CLIENT_SECRET, AZURE_CLIENT_ID and AZURE_TENANT_ID environment variables need to be set up for authentication.

string endpoint = "<endpoint_url>";
TokenCredential tokenCredential = new DefaultAzureCredential();
tokenCredential = new DefaultAzureCredential();
EmailClient client = new EmailClient(new Uri(endpoint), tokenCredential);

Examples

Send an Email Message

To send an email message, call the Send or SendAsync function from the EmailClient.

// Create the email content
var emailContent = new EmailContent("This is the subject");
emailContent.PlainText = "This is the body";

// Create the recipient list
var emailRecipients = new EmailRecipients(
    new List<EmailAddress>
    {
        new EmailAddress(
            email: "<recipient email address>"
            displayName: "<recipient displayname>"
    });

// Create the EmailMessage
var emailMessage = new EmailMessage(
    sender: "<Send email address>" // The email address of the domain registered with the Communication Services resource
    emailContent,
    emailRecipients);

SendEmailResult sendResult = client.Send(emailMessage);

Console.WriteLine($"Email id: {sendResult.MessageId}");

Send an Email Message to Multiple Recipients

To send an email message to multiple recipients, add an EmailAddress object for each recipent type to the EmailRecipient object.

// Create the email content
var emailContent = new EmailContent("This is the subject");
emailContent.PlainText = "This is the body";

// Create the To list
var toRecipients = new List<EmailAddress>
{
    new EmailAddress(
        email: "<recipient email address>"
        displayName: "<recipient displayname>"
    new EmailAddress(
        email: "<recipient email address>"
        displayName: "<recipient displayname>"
};

// Create the CC list
var ccRecipients = new List<EmailAddress>
{
    new EmailAddress(
        email: "<recipient email address>"
        displayName: "<recipient displayname>"
    new EmailAddress(
        email: "<recipient email address>"
        displayName: "<recipient displayname>"
};

// Create the BCC list
var bccRecipients = new List<EmailAddress>
{
    new EmailAddress(
        email: "<recipient email address>"
        displayName: "<recipient displayname>"
    new EmailAddress(
        email: "<recipient email address>"
        displayName: "<recipient displayname>"
};

var emailRecipients = new EmailRecipients(toRecipients, ccRecipients, bccRecipients);

// Create the EmailMessage
var emailMessage = new EmailMessage(
    sender: "<Send email address>" // The email address of the domain registered with the Communication Services resource
    emailContent,
    emailRecipients);

SendEmailResult sendResult = client.Send(emailMessage);

Console.WriteLine($"Email id: {sendResult.MessageId}");

Send Email with Attachments

Azure Communication Services support sending email swith attachments. See EmailAttachmentType for a list of supported attachments

// Create the EmailMessage
var emailMessage = new EmailMessage(
    sender: "<Send email address>" // The email address of the domain registered with the Communication Services resource
    emailContent,
    emailRecipients);

var filePath = "<path to your file>";
var attachmentName = "<name of your attachment>"
EmailAttachmentType attachmentType = EmailAttachmentType.Txt;

// Convert the file content into a Base64 string
byte[] bytes = File.ReadAllBytes(filePath);
string attachmentFileInBytes = Convert.ToBase64String(bytes);
var emailAttachment = new EmailAttachment(attachmentName, attachmentType, attachmentFileInBytes);

emailMessage.Attachments.Add(emailAttachment);

SendEmailResult sendResult = client.Send(emailMessage);

Get Email Message Status

The EmailSendResult from the Send call contains a MessageId which can be used to query the status of the email.

SendEmailResult sendResult = client.Send(emailMessage);

SendStatusResult status = client.GetSendStatus(sendResult.MessageId);

Troubleshooting

A RequestFailedException is thrown as a service response for any unsuccessful requests. The exception contains information about what response code was returned from the service.

Next steps

• Read more about Email in Azure Communication Services

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit cla.microsoft.com.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.