Skip to main content

core.mailattachment

Home > @medplum/core > MailAttachment

MailAttachment interface

Email attachment definition. Compatible with nodemailer Mail.Options.

Signature:

export interface MailAttachment 

Properties

Property

Modifiers

Type

Description

content?

readonly

string

(Optional) String, Buffer or a Stream contents for the attachmentent

contentType?

readonly

string

(Optional) optional content type for the attachment, if not set will be derived from the filename property

filename?

readonly

string | false

(Optional) filename to be reported as the name of the attached file, use of unicode is allowed. If you do not want to use a filename, set this value as false, otherwise a filename is generated automatically

path?

readonly

string

(Optional) path to a file or an URL (data uris are allowed as well) if you want to stream the file instead of including it (better for larger attachments)