Class EmailClient

Package version

The Email service client.

Hierarchy

EmailClient

Index

Constructors

constructor

Methods

Constructors

constructor

new EmailClient(connectionString: string, options?: EmailClientOptions): EmailClient
new EmailClient(endpoint: string, credential: KeyCredential, options?: EmailClientOptions): EmailClient

- Defined in emailClient.ts:34
Initializes a new instance of the EmailClient class.

Parameters
- connectionString: string
  
  Connection string to connect to an Azure Communication Service resource. Example: "endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret";
- Optional options: EmailClientOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns EmailClient
- Defined in emailClient.ts:42
Initializes a new instance of the EmailClient class using an Azure KeyCredential.

Parameters
- endpoint: string
  
  The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).
- credential: KeyCredential
  
  An object that is used to authenticate requests to the service. Use the Azure KeyCredential or @azure/identity to create a credential.
- Optional options: EmailClientOptions
  
  Optional. Options to configure the HTTP pipeline.
Returns EmailClient

Methods

getSendStatus

getSendStatus(messageId: string): Promise<SendStatusResult>

- Defined in emailClient.ts:105
Gets the status of a message sent previously.

Parameters
- messageId: string
  
  System generated message id (GUID) returned from a previous call to send email
Returns Promise<SendStatusResult>

send

send(emailMessage: EmailMessage): Promise<SendEmailResult>

- Defined in emailClient.ts:93
Queues an email message to be sent to one or more recipients

Parameters
- emailMessage: EmailMessage
  
  Message payload for sending an email
Returns Promise<SendEmailResult>

Generated using TypeDoc