core.mailoptions
Home > @medplum/core > MailOptions
MailOptions interface
Email message definition. Compatible with nodemailer Mail.Options.
Signature:
export interface MailOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
attachments? |
| (Optional) An array of attachment objects | |
bcc? |
| MailDestination | (Optional) Comma separated list or an array of recipients e-mail addresses that will appear on the Bcc: field |
cc? |
| MailDestination | (Optional) Comma separated list or an array of recipients e-mail addresses that will appear on the Cc: field |
from? |
| string | MailAddress | (Optional) The e-mail address of the sender. All e-mail addresses can be plain |
html? |
| string | (Optional) The HTML version of the message |
replyTo? |
| string | MailAddress | (Optional) An e-mail address that will appear on the Reply-To: field |
sender? |
| string | MailAddress | (Optional) An e-mail address that will appear on the Sender: field |
subject? |
| string | (Optional) The subject of the e-mail |
text? |
| string | (Optional) The plaintext version of the message |
to? |
| MailDestination | (Optional) Comma separated list or an array of recipients e-mail addresses that will appear on the To: field |