Skip to main content

IQEmailOptions

@quik/communication


@quik/communication / IQEmailOptions

Interface: IQEmailOptions

Defined in: communication/src/email/definition.ts:40

A list of options that can be passed when sending an email through the Email handling Service.

Properties​

attachments?​

optional attachments?: (string | QEmailAttachment)[]

Defined in: communication/src/email/definition.ts:72

Optional list of attachments. Each entry is either a file path string or an inline content descriptor.


bcc?​

optional bcc?: string | string[]

Defined in: communication/src/email/definition.ts:60

Optional. Addresses that will be placed in BCC and hidden from recipients.


cc?​

optional cc?: string | string[]

Defined in: communication/src/email/definition.ts:56

Optional. Addresses that will be placed in CC.


from?​

optional from?: string

Defined in: communication/src/email/definition.ts:48

Optional. Overrides the default sender.


html?​

optional html?: string

Defined in: communication/src/email/definition.ts:70

Optional HTML content of the email.


replyTo?​

optional replyTo?: string

Defined in: communication/src/email/definition.ts:62

Optional address used for replies.


sender?​

optional sender?: string

Defined in: communication/src/email/definition.ts:52

Optional. Sets the Sender header.


subject​

subject: string

Defined in: communication/src/email/definition.ts:66

The subject of the email.


text?​

optional text?: string

Defined in: communication/src/email/definition.ts:68

Optional text content of the email.


to?​

optional to?: string | string[]

Defined in: communication/src/email/definition.ts:44

Optional. List of recipients used for the TO field.