Raw New Markdown
Generating updated version of doc...
Rendered New Markdown
Generating updated version of doc...
---
title: include file
description: include file
author: v-deepikal
manager: komivi.agbakpem
services: azure-communication-services
ms.author: v-deepikal
ms.date: 12/04/2024
ms.topic: include
ms.service: azure-communication-services
ms.custom: include files
---
Get started with Azure Communication Services using the Azure PowerShell communication module to send Email messages.
Completing this article incurs a small cost of a few USD cents or less in your Azure account.
## Prerequisites
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/pricing/purchase-options/azure-account?cid=msft_learn).
- An Azure Email Communication Services resource created and ready with a provisioned domain. [Create an Email Communication Resource](../create-email-communication-resource.md).
- An active Azure Communication Services resource connected to an Email Domain and its connection string. [Connect a verified email domain to send email](../connect-email-communication-resource.md).
- The latest [Azure PowerShell](/powershell/azure/install-azps-windows).
### Prerequisite check
- In a windows PowerShell, run the `Get-Module -ListAvailable -Name Az.Communication` command to check whether the communication module is installed.
- To view the domains verified with your Email Communication Services resource, sign in to the [Azure portal](https://portal.azure.com/). Locate your Email Communication Services resource and open the **Provision domains** tab from the left navigation panel.
## Set up
### Install communication module
Install the Azure Communication Services module for Azure PowerShell using the `Install-Module -Name Az.Communication` command.
```azurepowershell-interactive
Install-Module -Name Az.Communication
```
After installing Communication module, run the `Get-Command -Module Az.Communication` command to get all the communication modules.
```azurepowershell-interactive
Get-Command -Module Az.Communication
```
## Send an email message
Queue an email message to be sent to one or more recipients with only required fields.
```azurepowershell-interactive
$emailRecipientTo = @(
@{
Address = "<emailalias@emaildomain.com>"
DisplayName = "Email DisplayName"
}
)
$message = @{
ContentSubject = "Test Email"
RecipientTo = @($emailRecipientTo) # Array of email address objects
SenderAddress = '<donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net>'
ContentPlainText = "This is the first email from ACS - Azure PowerShell"
}
Send-AzEmailServicedataEmail -Message $Message -endpoint "<yourEndpoint>"
```
Make these replacements in the code:
- Replace `<yourEndpoint>` with your endpoint.
- Replace `<emailalias@emaildomain.com>` with the email address you would like to send a message to.
- Replace `<donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net>` with the MailFrom address of your verified domain.
Queue an email message to be sent to one or more recipients with all the fields.
```azurepowershell-interactive
$emailRecipientTo = @(
@{
Address = "<emailalias@emaildomain.com>"
DisplayName = "Email DisplayName"
},
@{
Address = "<emailalias1@emaildomain.com>"
DisplayName = "Email DisplayName"
}
)
$fileBytes1 = [System.IO.File]::ReadAllBytes("<file path>")
$fileBytes2 = [System.IO.File]::ReadAllBytes("<image file path>")
$emailAttachment = @(
@{
ContentInBase64 = $fileBytes1
ContentType = "<text/plain>"
Name = "<test.txt>"
},
@{
ContentInBase64 = $fileBytes2
ContentType = "<image/png>"
Name = "<inline-attachment.png>"
contentId = "<inline-attachment>"
}
)
$headers = @{
"Key1" = "Value1"
"Key2" = "Value2"
"Importance" = "high"
}
$emailRecipientBcc = @(
@{
Address = "<emailbccalias@emaildomain.com>"
DisplayName = "Email DisplayName"
}
)
$emailRecipientCc = @(
@{
Address = "<emailccalias@emaildomain.com>"
DisplayName = "Email DisplayName"
}
)
$emailRecipientReplyTo = @(
@{
Address = "<emailreplytoalias@emaildomain.com>"
DisplayName = "Email DisplayName"
}
)
$message = @{
ContentSubject = "Test Email"
RecipientTo = @($emailRecipientTo) # Array of email address objects
SenderAddress = '<donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net>'
Attachment = @($emailAttachment) # Array of attachments
ContentHtml = "<html><head><title>Enter title</title></head><body><img src='cid:inline-attachment' alt='Company Logo'/><h1>This is the first email from ACS - Azure PowerShell</h1></body></html>"
ContentPlainText = "This is the first email from ACS - Azure PowerShell"
Header = $headers # Importance = high/medium/low or X-Priority = 2/3/4
RecipientBcc = @($emailRecipientBcc) # Array of email address objects
RecipientCc = @($emailRecipientCc) # Array of email address objects
ReplyTo = @($emailRecipientReplyTo) # Array of email address objects
UserEngagementTrackingDisabled = $true
}
Send-AzEmailServicedataEmail -Message $Message -endpoint "<yourEndpoint>"
```
Make these replacements in the code:
- Replace `<yourEndpoint>` with your endpoint.
- Replace `<emailalias@emaildomain.com> and <emailalias1@emaildomain.com>` with the email addresses you would like to send a message to.
- Replace `<file path> and <image file path>` with the actual file paths of the attachments you want to send.
- Replace `<text/plain> and <image/png>` with the appropriate content types for your attachments.
- Replace `<test.txt> and <inline-attachment.png>` with the filenames of your attachments.
- Replace `<inline-attachment>` with the Content-ID for your inline attachment.
- Replace `<emailbccalias@emaildomain.com>` with the email address you want to send the message to as BCC.
- Replace `<emailccalias@emaildomain.com>` with the email address you want to send the message to as CC.
- Replace `<emailreplytoalias@emaildomain.com>` with the email address you want replies to be sent to.
- Replace `<donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net>` with the MailFrom address of your verified domain.
### Optional parameters
The following optional parameters are available in Azure PowerShell.
- `ContentHtml` can be used to specify the HTML body of the email.
- `ContentPlainText` used to specify the plain text body of the email.
- `Attachment` sets the list of email attachments. This parameter accepts an array of file paths or attachment objects. We limit the total size of an email request, including both regular and inline attachments, to 10 MB.
- `Header` custom email headers to be passed and sets email importance level (high, normal, or low).
- `RecipientBcc` array of recipients for the BCC field.
- `RecipientCc` array of recipients for the CC field.
- `ReplyTo` array of email addresses where recipients replies are sent.
- `UserEngagementTrackingDisabled` indicates whether user engagement tracking needs to be disabled for this request if the resource-level user engagement tracking setting was already enabled in the control plane.
You can also use a list of recipients with `RecipientCc` and `RecipientBcc` similar to `RecipientTo`. There needs to be at least one recipient in `RecipientTo` or `RecipientCc` or `RecipientBcc`.
View on GitHub