Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Email

Package version

Class representing a Email.

Hierarchy

  • Email

Index

Constructors

Methods

Constructors

constructor

Methods

getSendStatus

  • Gets the status of a message sent previously.

    Parameters

    • messageId: string

      System generated message id (GUID) returned from a previous call to send email

    • Optional options: coreHttp.OperationOptions

      The options parameters.

    Returns Promise<EmailGetSendStatusResponse>

send

  • send(repeatabilityRequestId: string, repeatabilityFirstSent: string, emailMessage: EmailMessage, options?: coreHttp.OperationOptions): Promise<EmailSendResponse>

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

    Parameters

    • repeatabilityRequestId: string

      If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.

    • repeatabilityFirstSent: string

      Must be sent by clients to specify that a request is repeatable. Repeatability-First-Sent is used to specify the date and time at which the request was first created in the IMF-fix date form of HTTP-date as defined in RFC7231. eg- Tue, 26 Mar 2019 16:06:51 GMT

    • emailMessage: EmailMessage

      Message payload for sending an email

    • Optional options: coreHttp.OperationOptions

      The options parameters.

    Returns Promise<EmailSendResponse>

Generated using TypeDoc