core.mailoptions | Medplum

MailOptions interface

Email message definition. Compatible with nodemailer Mail.Options.

Signature:

export interface MailOptions

Properties

Property Modifiers Type Description
attachments? readonly MailAttachment (Optional) An array of attachment objects
bcc? readonly MailDestination (Optional) Comma separated list or an array of recipients e-mail addresses that will appear on the Bcc: field
cc? readonly MailDestination (Optional) Comma separated list or an array of recipients e-mail addresses that will appear on the Cc: field
from? readonly string | MailAddress (Optional) The e-mail address of the sender. All e-mail addresses can be plain sender@server.com or formatted Sender Name <sender@server.com>
html? readonly string (Optional) The HTML version of the message
replyTo? readonly string | MailAddress (Optional) An e-mail address that will appear on the Reply-To: field
sender? readonly string | MailAddress (Optional) An e-mail address that will appear on the Sender: field
subject? readonly string (Optional) The subject of the e-mail
text? readonly string (Optional) The plaintext version of the message
to? readonly MailDestination (Optional) Comma separated list or an array of recipients e-mail addresses that will appear on the To: field