Class EmailBuilder

A chainable email builder compatible with the legacy newEmail() formula. Build an email by chaining method calls, then call send() to queue for delivery.

Index

Constructors

Methods

attach bcc bulkPriority cc embedAll errors from html priority replyTo resetErrors send sender subject text to

Constructors

constructor

new EmailBuilder(): EmailBuilder
Returns EmailBuilder

Methods

attach

attach(docKeyOrUrl: string): EmailBuilder
Attaches a document by key or download URL.
Parameters
- docKeyOrUrl: string
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19686

bcc

bcc(address: string, name?: string): EmailBuilder
Adds a BCC recipient.
Parameters
- address: string
- Optionalname: string
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19641

bulkPriority

bulkPriority(bulkPriority: number): EmailBuilder
Sets the bulk priority (0-9, lower = higher priority).
Parameters
- bulkPriority: number
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19703

cc

cc(address: string, name?: string): EmailBuilder
Adds a CC recipient.
Parameters
- address: string
- Optionalname: string
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19634

embedAll

embedAll(): EmailBuilder
Enables embedding all attachments in the HTML body.

Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19691

errors

errors(): string
Returns any accumulated error messages.

Returns string
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19713

from

from(address: string, name?: string): EmailBuilder
Sets the From address.
Parameters
- address: string
- Optionalname: string
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19648

html

html(html: string): EmailBuilder
Sets the HTML body.
Parameters
- html: string
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19680

priority

priority(priority: number): EmailBuilder
Sets the priority. Positive = high, zero = normal, negative = low.
Parameters
- priority: number
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19697

replyTo

replyTo(address: string, name?: string): EmailBuilder
Sets the Reply-To address.
Parameters
- address: string
- Optionalname: string
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19655

resetErrors

resetErrors(): void
Clears accumulated errors.

Returns void
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19718

send

send(): boolean
Validates and queues the email for sending. Returns true on success, false on validation failure.

Returns boolean
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19708

sender

sender(address: string, name?: string): EmailBuilder
Sets the Sender address.
Parameters
- address: string
- Optionalname: string
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19662

subject

subject(subject: string): EmailBuilder
Sets the subject.
Parameters
- subject: string
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19668

text

text(text: string): EmailBuilder
Sets the plain text body.
Parameters
- text: string
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19674

to

to(address: string, name?: string): EmailBuilder
Adds a To recipient.
Parameters
- address: string
- Optionalname: string
Returns EmailBuilder
- Defined in dev/github/bluestep-systems/web/build/tsdoc/combined/jslib/types/B/B.d.ts:19627