Skip to content

Scripting API / core/EmailApi / External

External

Type Aliases

Exclude

Exclude<T, U> = T extends U ? never : T

Exclude from T those types that are assignable to U

Type Parameters

Type Parameter
T
U

Omit

Omit<T, K> = Pick<T, Exclude<keyof T, K>>

Construct a type with the properties of T except for those in type K.

Type Parameters

Type Parameter
T
K extends keyof any

Pick

Pick<T, K> = { [P in K]: T[P] }

From T, pick a set of properties whose keys are in the union K

Type Parameters

Type Parameter
T
K extends keyof T

SendEmail

SendEmail = object

Properties

Property Type Description
attachments? string[] Doc Base 64 encoded attachments (must be .png format). Limited to 10 items.
bcc? string[] Doc Email addresses to include in the "bcc" line
body string Doc Email body formatted as HTML
cc? string[] Doc Email addresses to include in the "cc" line
subject string Doc Email subject
to? string[] Doc Email addresses to include in the "to" line

WorkerSendEmailOptions

WorkerSendEmailOptions = Omit<SendEmail, "attachments"> & object

Type Declaration

Name Type Description
charts? string[] Script IDs of charts to include in the email as .png attachments (limit 10). Only visual charts (i.e. non-tables) can be included as attachments. In Inspections, the script IDs must refer to charts in the current sub-inspection. In Dashboards, the script IDs can refer to any visual chart.