@medplum/core 5.2.9 → 5.2.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4299,16 +4299,23 @@ export declare interface MailAddress {
4299
4299
  /**
4300
4300
  * Email attachment definition.
4301
4301
  * Compatible with nodemailer Mail.Options.
4302
+ * Other nodemailer attachment options are ignored by the Medplum server.
4302
4303
  */
4303
4304
  export declare interface MailAttachment {
4304
- /** String, Buffer or a Stream contents for the attachment */
4305
+ /** String contents for the attachment */
4305
4306
  readonly content?: string;
4306
- /** 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) */
4307
+ /** A `Binary/{id}` reference, an HTTPS URL, or a data URI, if you want to stream the file instead of including it (better for larger attachments). Local file paths are not allowed. */
4307
4308
  readonly path?: string;
4308
4309
  /** 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 */
4309
4310
  readonly filename?: string | false;
4310
4311
  /** optional content type for the attachment, if not set will be derived from the filename property */
4311
4312
  readonly contentType?: string;
4313
+ /** optional content disposition type for the attachment, defaults to 'attachment' */
4314
+ readonly contentDisposition?: string;
4315
+ /** optional content id for using inline images in HTML message source */
4316
+ readonly cid?: string;
4317
+ /** If set and content is string, then encodes the content to a Buffer using the specified encoding. Example values: 'base64', 'hex', 'binary' etc. */
4318
+ readonly encoding?: string;
4312
4319
  }
4313
4320
 
4314
4321
  /**
@@ -4316,14 +4323,28 @@ export declare interface MailAttachment {
4316
4323
  */
4317
4324
  export declare type MailDestination = string | MailAddress | string[] | MailAddress[];
4318
4325
 
4326
+ /**
4327
+ * Email calendar event definition.
4328
+ * Compatible with nodemailer Mail.IcalAttachment.
4329
+ */
4330
+ export declare interface MailIcalEvent {
4331
+ /** Method of the calendar event, for example 'REQUEST' or 'CANCEL' */
4332
+ readonly method?: string;
4333
+ /** Filename of the calendar event attachment */
4334
+ readonly filename?: string;
4335
+ /** iCalendar contents of the event */
4336
+ readonly content: string;
4337
+ }
4338
+
4319
4339
  /**
4320
4340
  * Email message definition.
4321
4341
  * Compatible with nodemailer Mail.Options.
4342
+ * Other nodemailer message options are ignored by the Medplum server.
4322
4343
  */
4323
4344
  export declare interface MailOptions {
4324
- /** The e-mail address of the sender. All e-mail addresses can be plain `sender@server.com` or formatted `Sender Name <sender@server.com>` */
4345
+ /** The e-mail address of the sender. All e-mail addresses can be plain `sender@server.com` or formatted `Sender Name <sender@server.com>`. Must be an approved sender, otherwise the default sender address is used. */
4325
4346
  readonly from?: string | MailAddress;
4326
- /** An e-mail address that will appear on the Sender: field */
4347
+ /** Ignored by the Medplum server. The Sender: field is set to the from address. */
4327
4348
  readonly sender?: string | MailAddress;
4328
4349
  /** Comma separated list or an array of recipients e-mail addresses that will appear on the To: field */
4329
4350
  readonly to?: MailDestination;
@@ -4341,6 +4362,8 @@ export declare interface MailOptions {
4341
4362
  readonly html?: string;
4342
4363
  /** An array of attachment objects */
4343
4364
  readonly attachments?: MailAttachment[];
4365
+ /** iCalendar event to use as an alternative, for example an appointment invitation */
4366
+ readonly icalEvent?: string | MailIcalEvent;
4344
4367
  }
4345
4368
 
4346
4369
  /**
@@ -5874,6 +5897,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
5874
5897
  * });
5875
5898
  * ```
5876
5899
  *
5900
+ * Only the options in {@link MailOptions} are supported; other nodemailer options are ignored.
5877
5901
  * See the {@link https://nodemailer.com/extras/mailcomposer/ | nodemailer MailComposer options} for full details.
5878
5902
  * @category Media
5879
5903
  * @param email - The MailComposer options.
@@ -4299,16 +4299,23 @@ export declare interface MailAddress {
4299
4299
  /**
4300
4300
  * Email attachment definition.
4301
4301
  * Compatible with nodemailer Mail.Options.
4302
+ * Other nodemailer attachment options are ignored by the Medplum server.
4302
4303
  */
4303
4304
  export declare interface MailAttachment {
4304
- /** String, Buffer or a Stream contents for the attachment */
4305
+ /** String contents for the attachment */
4305
4306
  readonly content?: string;
4306
- /** 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) */
4307
+ /** A `Binary/{id}` reference, an HTTPS URL, or a data URI, if you want to stream the file instead of including it (better for larger attachments). Local file paths are not allowed. */
4307
4308
  readonly path?: string;
4308
4309
  /** 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 */
4309
4310
  readonly filename?: string | false;
4310
4311
  /** optional content type for the attachment, if not set will be derived from the filename property */
4311
4312
  readonly contentType?: string;
4313
+ /** optional content disposition type for the attachment, defaults to 'attachment' */
4314
+ readonly contentDisposition?: string;
4315
+ /** optional content id for using inline images in HTML message source */
4316
+ readonly cid?: string;
4317
+ /** If set and content is string, then encodes the content to a Buffer using the specified encoding. Example values: 'base64', 'hex', 'binary' etc. */
4318
+ readonly encoding?: string;
4312
4319
  }
4313
4320
 
4314
4321
  /**
@@ -4316,14 +4323,28 @@ export declare interface MailAttachment {
4316
4323
  */
4317
4324
  export declare type MailDestination = string | MailAddress | string[] | MailAddress[];
4318
4325
 
4326
+ /**
4327
+ * Email calendar event definition.
4328
+ * Compatible with nodemailer Mail.IcalAttachment.
4329
+ */
4330
+ export declare interface MailIcalEvent {
4331
+ /** Method of the calendar event, for example 'REQUEST' or 'CANCEL' */
4332
+ readonly method?: string;
4333
+ /** Filename of the calendar event attachment */
4334
+ readonly filename?: string;
4335
+ /** iCalendar contents of the event */
4336
+ readonly content: string;
4337
+ }
4338
+
4319
4339
  /**
4320
4340
  * Email message definition.
4321
4341
  * Compatible with nodemailer Mail.Options.
4342
+ * Other nodemailer message options are ignored by the Medplum server.
4322
4343
  */
4323
4344
  export declare interface MailOptions {
4324
- /** The e-mail address of the sender. All e-mail addresses can be plain `sender@server.com` or formatted `Sender Name <sender@server.com>` */
4345
+ /** The e-mail address of the sender. All e-mail addresses can be plain `sender@server.com` or formatted `Sender Name <sender@server.com>`. Must be an approved sender, otherwise the default sender address is used. */
4325
4346
  readonly from?: string | MailAddress;
4326
- /** An e-mail address that will appear on the Sender: field */
4347
+ /** Ignored by the Medplum server. The Sender: field is set to the from address. */
4327
4348
  readonly sender?: string | MailAddress;
4328
4349
  /** Comma separated list or an array of recipients e-mail addresses that will appear on the To: field */
4329
4350
  readonly to?: MailDestination;
@@ -4341,6 +4362,8 @@ export declare interface MailOptions {
4341
4362
  readonly html?: string;
4342
4363
  /** An array of attachment objects */
4343
4364
  readonly attachments?: MailAttachment[];
4365
+ /** iCalendar event to use as an alternative, for example an appointment invitation */
4366
+ readonly icalEvent?: string | MailIcalEvent;
4344
4367
  }
4345
4368
 
4346
4369
  /**
@@ -5874,6 +5897,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
5874
5897
  * });
5875
5898
  * ```
5876
5899
  *
5900
+ * Only the options in {@link MailOptions} are supported; other nodemailer options are ignored.
5877
5901
  * See the {@link https://nodemailer.com/extras/mailcomposer/ | nodemailer MailComposer options} for full details.
5878
5902
  * @category Media
5879
5903
  * @param email - The MailComposer options.