Share via


@azure/communication-email package

Classes

EmailClient

The Email service client.

Interfaces

EmailAddress

An object representing the email address and its display name

EmailAttachment

Attachment to the email.

EmailClientOptions

Client options used to configure Email Client API requests.

EmailMessage

Message payload for sending an email

EmailRecipients

Recipients of the email

EmailSendHeaders

Defines headers for Email_send operation.

EmailSendOptionalParams

Optional parameters for the beginSend method.

EmailSendResult

Status of the long running operation

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

HtmlEmailContent

Content of the email with a required html property.

PlainTextEmailContent

Content of the email with a required plainText property.

Type Aliases

EmailContent

Content of the email.

EmailSendResponse

Contains response data for the send operation.

EmailSendStatus

Defines values for EmailSendStatus.
KnownEmailSendStatus can be used interchangeably with EmailSendStatus, this enum contains the known values that the service supports.

Known values supported by the service

NotStarted
Running
Succeeded
Failed
Canceled

Enums

KnownEmailSendStatus

Known values of EmailSendStatus that the service accepts.