azure.communication.email.aio package¶

class azure.communication.email.aio.EmailClient(endpoint: str, credential: Union[azure.core.credentials_async.AsyncTokenCredential, azure.core.credentials.AzureKeyCredential], **kwargs)[source]¶

A client to interact with the AzureCommunicationService Email gateway asynchronously.

This client provides operations to send an email and monitor its status.

Parameters

endpoint (str) – The endpoint url for Azure Communication Service resource.
AzureKeyCredential] credential (Union[AsyncTokenCredential,) – The credential we use to authenticate against the service.

async close() → None [source]¶

classmethod from_connection_string(conn_str: str, **kwargs) → azure.communication.email.aio._email_client_async.EmailClient[source]¶

Create EmailClient from a Connection String.

Parameters: conn_str (str) – A connection string to an Azure Communication Service resource.
Returns: Instance of EmailClient.
Return type: EmailClient

async get_send_status(message_id: str, **kwargs) → azure.communication.email._generated.models._models_py3.SendStatusResult[source]¶

Gets the status of a message sent previously.

Parameters: message_id (str) – System generated message id (GUID) returned from a previous call to send email
Returns: SendStatusResult
Return type: SendStatusResult

async send(email_message: azure.communication.email._generated.models._models_py3.EmailMessage, **kwargs) → azure.communication.email._generated.models._patch.SendEmailResult[source]¶

Queues an email message to be sent to one or more recipients.

Parameters: email_message (EmailMessage) – The message payload for sending an email.
Returns: SendEmailResult
Return type: SendEmailResult