Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/communication-email

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

EmailAttachmentType

EmailAttachmentType: "avi" | "bmp" | "doc" | "docm" | "docx" | "gif" | "jpeg" | "mp3" | "one" | "pdf" | "png" | "ppsm" | "ppsx" | "ppt" | "pptm" | "pptx" | "pub" | "rpmsg" | "rtf" | "tif" | "txt" | "vsd" | "wav" | "wma" | "xls" | "xlsb" | "xlsm" | "xlsx"

Defines values for EmailAttachmentType.

EmailGetSendStatusResponse

EmailGetSendStatusResponse: EmailGetSendStatusHeaders & SendStatusResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SendStatusResult; parsedHeaders: EmailGetSendStatusHeaders } }

Contains response data for the getSendStatus operation.

EmailImportance

EmailImportance: "high" | "normal" | "low"

Defines values for EmailImportance.

EmailSendResponse

EmailSendResponse: EmailSendHeaders & { _response: coreHttp.HttpResponse & { parsedHeaders: EmailSendHeaders } }

Contains response data for the send operation.

SendStatus

SendStatus: "queued" | "outForDelivery" | "dropped"

Defines values for SendStatus.

Variables

Const SDK_VERSION

SDK_VERSION: string = "1.0.0-beta.1"

Const logger

logger: any = createClientLogger("communication-email")

The @azure/logger configuration for this package.

Const packageName

packageName: "@azure/communication-email" = "@azure/communication-email"

Const packageVersion

packageVersion: "1.0.0-beta.1" = "1.0.0-beta.1"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers, /* isXml */ false)

Functions

Const isEmailClientOptions

  • isEmailClientOptions(options: any): options is EmailClientOptions

  • Checks whether the type of a value is EmailClientOptions or not.

    Parameters

    • options: any

      The value being checked.

    Returns options is EmailClientOptions

Object literals

Const CommunicationError

CommunicationError: object

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

innerError

innerError: object

serializedName

serializedName: string = "innererror"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

message

message: object

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const CommunicationErrorResponse

CommunicationErrorResponse: object

type

type: object

className

className: string = "CommunicationErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "CommunicationError"

name

name: string = "Composite"

Const EmailAddress

EmailAddress: object

type

type: object

className

className: string = "EmailAddress"

name

name: string = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

email

email: object

required

required: boolean = true

serializedName

serializedName: string = "email"

type

type: object

name

name: string = "String"

Const EmailAttachment

EmailAttachment: object

type

type: object

className

className: string = "EmailAttachment"

name

name: string = "Composite"

modelProperties

modelProperties: object

attachmentType

attachmentType: object

required

required: boolean = true

serializedName

serializedName: string = "attachmentType"

type

type: object

name

name: string = "String"

contentBytesBase64

contentBytesBase64: object

required

required: boolean = true

serializedName

serializedName: string = "contentBytesBase64"

type

type: object

name

name: string = "String"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const EmailContent

EmailContent: object

type

type: object

className

className: string = "EmailContent"

name

name: string = "Composite"

modelProperties

modelProperties: object

html

html: object

serializedName

serializedName: string = "html"

type

type: object

name

name: string = "String"

plainText

plainText: object

serializedName

serializedName: string = "plainText"

type

type: object

name

name: string = "String"

subject

subject: object

required

required: boolean = true

serializedName

serializedName: string = "subject"

type

type: object

name

name: string = "String"

Const EmailCustomHeader

EmailCustomHeader: object

type

type: object

className

className: string = "EmailCustomHeader"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

value

value: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "String"

Const EmailGetSendStatusHeaders

EmailGetSendStatusHeaders: object

type

type: object

className

className: string = "EmailGetSendStatusHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

retryAfter

retryAfter: object

serializedName

serializedName: string = "retry-after"

type

type: object

name

name: string = "Number"

Const EmailMessage

EmailMessage: object

type

type: object

className

className: string = "EmailMessage"

name

name: string = "Composite"

modelProperties

modelProperties: object

attachments

attachments: object

serializedName

serializedName: string = "attachments"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EmailAttachment"

name

name: string = "Composite"

content

content: object

serializedName

serializedName: string = "content"

type

type: object

className

className: string = "EmailContent"

name

name: string = "Composite"

customHeaders

customHeaders: object

serializedName

serializedName: string = "headers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EmailCustomHeader"

name

name: string = "Composite"

disableUserEngagementTracking

disableUserEngagementTracking: object

serializedName

serializedName: string = "disableUserEngagementTracking"

type

type: object

name

name: string = "Boolean"

importance

importance: object

defaultValue

defaultValue: string = "normal"

serializedName

serializedName: string = "importance"

type

type: object

name

name: string = "String"

recipients

recipients: object

serializedName

serializedName: string = "recipients"

type

type: object

className

className: string = "EmailRecipients"

name

name: string = "Composite"

replyTo

replyTo: object

serializedName

serializedName: string = "replyTo"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EmailAddress"

name

name: string = "Composite"

sender

sender: object

required

required: boolean = true

serializedName

serializedName: string = "sender"

type

type: object

name

name: string = "String"

Const EmailRecipients

EmailRecipients: object

type

type: object

className

className: string = "EmailRecipients"

name

name: string = "Composite"

modelProperties

modelProperties: object

bCC

bCC: object

serializedName

serializedName: string = "bCC"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EmailAddress"

name

name: string = "Composite"

cC

cC: object

serializedName

serializedName: string = "cC"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EmailAddress"

name

name: string = "Composite"

to

to: object

required

required: boolean = true

serializedName

serializedName: string = "to"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "EmailAddress"

name

name: string = "Composite"

Const EmailSendHeaders

EmailSendHeaders: object

type

type: object

className

className: string = "EmailSendHeaders"

name

name: string = "Composite"

modelProperties

modelProperties: object

operationLocation

operationLocation: object

serializedName

serializedName: string = "operation-location"

type

type: object

name

name: string = "String"

repeatabilityResult

repeatabilityResult: object

serializedName

serializedName: string = "repeatability-result"

type

type: object

name

name: string = "String"

retryAfter

retryAfter: object

serializedName

serializedName: string = "retry-after"

type

type: object

name

name: string = "Number"

xMsRequestId

xMsRequestId: object

serializedName

serializedName: string = "x-ms-request-id"

type

type: object

name

name: string = "String"

Const SendStatusResult

SendStatusResult: object

type

type: object

className

className: string = "SendStatusResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

messageId

messageId: object

required

required: boolean = true

serializedName

serializedName: string = "messageId"

type

type: object

name

name: string = "String"

status

status: object

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-10-01-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const contentType

contentType: object

parameterPath

parameterPath: Object = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const emailMessage

emailMessage: object

mapper

mapper: any = EmailMessageMapper

parameterPath

parameterPath: string = "emailMessage"

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const getSendStatusOperationSpec

getSendStatusOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "/emails/{messageId}/status"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint, Parameters.messageId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SendStatusResult

headersMapper

headersMapper: any = Mappers.EmailGetSendStatusHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

headersMapper

headersMapper: any = Mappers.EmailGetSendStatusHeaders

Const messageId

messageId: object

parameterPath

parameterPath: string = "messageId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "messageId"

type

type: object

name

name: string = "String"

Const repeatabilityFirstSent

repeatabilityFirstSent: object

parameterPath

parameterPath: string = "repeatabilityFirstSent"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "repeatability-first-sent"

type

type: object

name

name: string = "String"

Const repeatabilityRequestId

repeatabilityRequestId: object

parameterPath

parameterPath: string = "repeatabilityRequestId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "repeatability-request-id"

type

type: object

name

name: string = "String"

Const sendOperationSpec

sendOperationSpec: object

headerParameters

headerParameters: Object = [Parameters.contentType,Parameters.repeatabilityRequestId,Parameters.repeatabilityFirstSent]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/emails:send"

queryParameters

queryParameters: Object = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.emailMessage

serializer

serializer: any

urlParameters

urlParameters: Object = [Parameters.endpoint]

responses

responses: object

202

202: object

headersMapper

headersMapper: any = Mappers.EmailSendHeaders

default

default: object

bodyMapper

bodyMapper: any = Mappers.CommunicationErrorResponse

headersMapper

headersMapper: any = Mappers.EmailSendHeaders

Generated using TypeDoc