Merge pull request #226567 from mayssamm/main

[Communication] add azure-cli quick start for email

Author: ttorble

articles/communication-services/quickstarts/email/includes/send-email-az-cli.md

@@ -0,0 +1,127 @@
+---
+title: include file
+description: include file
+author: mayssamm
+manager: ankita
+services: azure-communication-services
+ms.author: mayssamm
+ms.date: 02/03/2023
+ms.topic: include
+ms.service: azure-communication-services
+ms.custom: include files
+---
+
+Get started with Azure Communication Services by using the Azure CLI communication extension to send Email messages.
+
+Completing this quick start 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/free/?WT.mc_id=A261C142F).
+- An Azure Email Communication Services resource created and ready with a provisioned domain. [Get started with creating an Email Communication Resource](../create-email-communication-resource.md).
+- An active Azure Communication Services resource connected to an Email Domain and its connection string. [Get started by connecting an Email Communication Resource with a Azure Communication Resource](../connect-email-communication-resource.md).
+- The latest [Azure CLI](/cli/azure/install-azure-cli-windows?tabs=azure-cli).
+
+### Prerequisite check
+- In a terminal or command window, run the `az --version` command to check that Azure CLI and the communication extension are 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 pane.
+
+## Setting up
+### Add the extension
+Add the Azure Communication Services extension for Azure CLI by using the `az extension` command.
+
+```azurecli-interactive
+az extension add --name communication
+```
+
+### Sign in to Azure CLI
+You'll need to [sign in to Azure CLI](/cli/azure/authenticate-azure-cli). You can sign in running the ```az login``` command from the terminal and providing your credentials.
+
+
+### Store your connection string in an environment variable 
+
+You can configure the `AZURE_COMMUNICATION_CONNECTION_STRING` environment variable to use Azure CLI keys operations without having to use `--connection_string` to pass in the connection string. To configure an environment variable, open a console window and select your operating system from the below tabs. Replace `<connectionString>` with your actual connection string.
+
+##### [Windows](#tab/windows)
+
+```console
+setx AZURE_COMMUNICATION_STRING "<yourConnectionString>"
+```
+
+After you add the environment variable, you may need to restart any running programs that will need to read the environment variable, including the console window. For example, if you're using Visual Studio as your editor, restart Visual Studio before running the example. 
+
+##### [macOS](#tab/unix)
+
+Edit your **`.zshrc`**, and add the environment variable:
+
+```bash
+export AZURE_COMMUNICATION_STRING="<connectionString>"
+```
+
+After you add the environment variable, run `source ~/.zshrc` from your console window to make the changes effective. If you created the environment variable with your IDE open, you may need to close and reopen the editor, IDE, or shell in order to access the variable. 
+
+##### [Linux](#tab/linux)
+
+Edit your **`.bash_profile`**, and add the environment variable:
+
+```bash
+export AZURE_COMMUNICATION_STRING="<connectionString>"
+```
+
+After you add the environment variable, run `source ~/.bash_profile` from your console window to make the changes effective. If you created the environment variable with your IDE open, you may need to close and reopen the editor, IDE, or shell in order to access the variable. 
+
+---
+
+## Send an email message
+
+```azurecli-interactive
+az communication email send
+	--connection-string "yourConnectionString"
+	--sender "<[email protected]>"
+	--to "<[email protected]>"
+	--subject "Welcome to Azure Communication Services Email" --text "This email message is sent from Azure Communication Services Email using Azure CLI." 
+```
+
+Make these replacements in the code:
+
+- Replace `<yourConnectionString>` with your connection string.
+- Replace "<[email protected]>" with the email address you would like to send a message to.
+- Replace "<[email protected]>" with the MailFrom address of your verified domain.
+
+To track the status of the email delivery, you'll need the `messageId` from the response.
+
+### Optional parameters
+
+The following optional parameters are available in Azure CLI.
+
+- `--html` can be used instead of `--text` for html email body.
+
+- `--importance` sets the importance type for the email. Known values are: high, normal, and low. Default is normal.
+
+- `--cc` sets carbon copy email addresses.
+
+- `--bcc` sets blind carbon copy email addresses.
+
+- `--reply-to` sets Reply-To email address.
+
+- `--disable-tracking` indicates whether user engagement tracking should be disabled for this request.
+
+- `--attachments` sets the list of email attachments.
+
+- `--attachment-types` sets the list of email attachment types, in the same order of attachments.
+
+Also, you can use a list of recipients with `--to`, similar to `--cc` and `--bcc`.
+
+
+## Get the status of the email delivery
+
+We can keep checking the email delivery status until the status is `OutForDelivery`.
+
+```azurecli-interactive
+az communication email status get --message-id "\<messageId\>"
+```
+
+- Replace "\<messageId\>" with the messageId from the response of the send request.
+
+[!INCLUDE [Email Message Status](./email-message-status.md)]
+

articles/communication-services/quickstarts/email/includes/send-email-python.md

@@ -63,7 +63,7 @@ pip install azure-communication-email
 
 ## Object model
 
-The following classes and interfaces handle some of the major features of the Azure Communication Services SMS SDK for Python.
+The following classes and interfaces handle some of the major features of the Azure Communication Services Email SDK for Python.
 
 | Name | Description |
 | ---- |-------------|

articles/communication-services/quickstarts/email/send-email.md

@@ -10,7 +10,7 @@ ms.date: 04/15/2022
 ms.topic: quickstart
 ms.service: azure-communication-services
 ms.custom: private_preview, event-tier1-build-2022
-zone_pivot_groups: acs-js-csharp-java-python
+zone_pivot_groups: acs-azcli-js-csharp-java-python
 ---
 
 # Quickstart: How to send an email using Azure Communication Service
@@ -19,6 +19,10 @@ zone_pivot_groups: acs-js-csharp-java-python
 
 In this quick start, you'll learn about how to send email using our Email SDKs.
 
+::: zone pivot="platform-azcli"
+[!INCLUDE [Send email with Azure CLI](./includes/send-email-az-cli.md)]
+::: zone-end
+
 ::: zone pivot="programming-language-csharp"
 [!INCLUDE [Send email with .NET SDK](./includes/send-email-net.md)]
 ::: zone-end

articles/communication-services/quickstarts/rooms/includes/rooms-quickstart-az-cli.md

@@ -32,7 +32,7 @@ az extension add --name communication
 You'll need to [sign in to Azure CLI](/cli/azure/authenticate-azure-cli). You can sign in running the ```az login``` command from the terminal and providing your credentials.
 
 
-### Store your connection string in an envrionment variable 
+### Store your connection string in an environment variable 
 
 You can configure the `AZURE_COMMUNICATION_CONNECTION_STRING` environment variable to use Azure CLI keys operations without having to use `--connection_string` to pass in the connection string. To configure an environment variable, open a console window and select your operating system from the below tabs. Replace `<connectionString>` with your actual connection string.
 
@@ -42,7 +42,7 @@ You can configure the `AZURE_COMMUNICATION_CONNECTION_STRING` environment variab
 setx AZURE_COMMUNICATION_STRING "<yourConnectionString>"
 ```
 
-After you add the environment variable, you may need to restart any running programs that will need to read the environment variable, including the console window. For example, if you are using Visual Studio as your editor, restart Visual Studio before running the example. 
+After you add the environment variable, you may need to restart any running programs that will need to read the environment variable, including the console window. For example, if you're using Visual Studio as your editor, restart Visual Studio before running the example. 
 
 ##### [macOS](#tab/unix)
 
@@ -56,7 +56,7 @@ After you add the environment variable, run `source ~/.zshrc` from your console
 
 ##### [Linux](#tab/linux)
 
-Edit your **`.bash_profile`**, and add the environment vairable:
+Edit your **`.bash_profile`**, and add the environment variable:
 
 ```bash
 export AZURE_COMMUNICATION_STRING="<connectionString>"
@@ -82,7 +82,7 @@ az communication rooms create --presenter-participants "<participantId>" --consu
 - Use `<validFrom>` optionally to specify the timestamp when the room is open for joining, in ISO8601 format, ex: 2022-07-14T10:21. 
 - Use `<validUntil>` optionally to specify the timestamp when the room can no longer be joined, in ISO8601 format, ex: 2022-07-14T10:21. 
 
-If you have stored the connection string in environment variables as stated above, you won't need to pass them to the command.
+If you've stored the connection string in environment variables as stated above, you won't need to pass them to the command.
 
 ```azurecli-interactive
 az communication rooms create 
@@ -93,7 +93,7 @@ az communication rooms create
 
 ### Get the rooms 
 
-The `rooms get` command returns the attributes of an exisiting room.
+The `rooms get` command returns the attributes of an existing room.
 
 ```azurecli-interactive
 az communication rooms get --room "<roomId>" 
@@ -129,8 +129,8 @@ You can update the timestamp of a room. Before calling the `room update` command
 az communication rooms update --validFrom "<validFrom>" --validUntil "<validUntil>" --room "<roomId>"
 ```
 
-- Replace `<validFrom>` with the timestamp in ISO8601 format, ex: 2022-07-14T10:21, to specify when the room is open for joining. Should be used together with --valid-until.
-- Replace `<validUntil>` with the timestamp in ISO8601 format, ex: 2022-07-14T10:21, to specify when the room can no longer be joined. Should be used together with --valid-from.
+- Replace `<validFrom>` with the timestamp in ISO8601 format, ex: 2022-07-14T10:21, to specify when the room is open for joining. Should be used together with `--valid-until`.
+- Replace `<validUntil>` with the timestamp in ISO8601 format, ex: 2022-07-14T10:21, to specify when the room can no longer be joined. Should be used together with `--valid-from`.
 - Replace `<roomId>` with your room ID.