Class KimMailBuilder

to

subject

OptionalhtmlBody

OptionaltextBody

Staticwith

• with(
      subject: string,
      htmlBody: string,
      textBody: string,
      ...to: MailAddressType[],
  ): KimMailBuilder

  Creates a new builder with html and plain-text mail content.

  Parameters

  • subject: string
  • htmlBody: string
  • textBody: string
  • ...to: MailAddressType[]

  Returns KimMailBuilder

StaticwithHtml

• withHtml(
      subject: string,
      htmlBody: string,
      ...to: MailAddressType[],
  ): KimMailBuilder

  Creates a new builder with only html mail content.

  Parameters

  • subject: string
  • htmlBody: string
  • ...to: MailAddressType[]

  Returns KimMailBuilder

StaticwithText

• withText(
      subject: string,
      textBody: string,
      ...to: MailAddressType[],
  ): KimMailBuilder

  Creates a new builder with only plain-text mail content.

  Parameters

  • subject: string
  • textBody: string
  • ...to: MailAddressType[]

  Returns KimMailBuilder

StaticwithoutTextOrHtmlBody

• withoutTextOrHtmlBody(subject: string, ...to: MailAddressType[]): KimMailBuilder

  Creates a new builder without text or html mail content. This is a rare case and should only be necessary for technical processes.

  Parameters

  • subject: string
  • ...to: MailAddressType[]

  Returns KimMailBuilder

withFromDisplayName

• withFromDisplayName(displayName?: string): KimMailBuilder

  Allows setting the sender display-name of a mail. The send-mail it self will be set by the client while sending the mail.

  Parameters

  • OptionaldisplayName: string

  Returns KimMailBuilder

toCc

• toCc(...addresses: MailAddressType[]): KimMailBuilder

  Sets the CarbonCopy receivers of this mail.

  Parameters

  • ...addresses: MailAddressType[]

  Returns KimMailBuilder

  this

withDienstkennung

• withDienstkennung(value: string): KimMailBuilder

  Allows to set the "X-KIM-Dienstkennung" mail header.

  Parameters

  • value: string

  Returns KimMailBuilder

  See

  https://gemspec.gematik.de/docs/gemSpec/gemSpec_CM_KOMLE/gemSpec_CM_KOMLE_V1.19.0/#A_19488-02

withSendersystem

• withSendersystem(name: string, version: string): KimMailBuilder

  Allows to set the "X-KIM-Sendersystem" mail header.

  Parameters

  • name: string
  • version: string

  Returns KimMailBuilder

withSupportMailAddress

• withSupportMailAddress(
      mailAddress: string,
      displayName?: string,
  ): KimMailBuilder

  Allows to set the "X-KIM-Support" mail header.

  Parameters

  • mailAddress: string
  • OptionaldisplayName: string

  Returns KimMailBuilder

inReplyTo

• inReplyTo(messageId: string): KimMailBuilder

  sets the "In-Reply-To" mail header, defining the Message Id to which this mail is a reply.

  Parameters

  • messageId: string

  Returns KimMailBuilder

  this

replyTo

• replyTo(mailAddress: string, displayName?: string): KimMailBuilder

  sets the "Reply-To" mail header, defining where a reply should be send to.

  Parameters

  • mailAddress: string
  • OptionaldisplayName: string

  Returns KimMailBuilder

  this

addHeader

• addHeader(name: string, value: string): KimMailBuilder

  Add an additional Mail header to the Kim Message.

  Parameters

  • name: string

    Header name

  • value: string

    Header value

  Returns KimMailBuilder

  self

addAttachment

• addAttachment(
      filename: string,
      contentType: string,
      content: string | ArrayBuffer,
      additionalHeaders?: KimMailHeaderField[],
  ): KimMailBuilder

  Adds an attachment to the mail being constructed.

  Parameters

  • filename: string

    The Filename of the attachment

  • contentType: string

    the mime type of the content being send.

  • content: string | ArrayBuffer

    the actual content as binary ArrayBuffer or a base64 encoded string.

  • additionalHeaders: KimMailHeaderField[] = []

    Allows to attach additional Headers to the MimePart of the attachment.

  Returns KimMailBuilder

  this

addAttachmentFromBase64

• addAttachmentFromBase64(
      filename: string,
      contentType: string,
      base64Content: string,
      additionalHeaders?: KimMailHeaderField[],
  ): KimMailBuilder

  Adds an attachment to the mail being constructed.

  Parameters

  • filename: string

    The Filename of the attachment

  • contentType: string

    the mime type of the content being send.

  • base64Content: string

    the actual content as a base64 encoded string.

  • additionalHeaders: KimMailHeaderField[] = []

    Allows to attach additional Headers to the MimePart of the attachment.

  Returns KimMailBuilder

  this

addAttachmentFromArrayBuffer

• addAttachmentFromArrayBuffer(
      filename: string,
      contentType: string,
      arrayBuffer: ArrayBuffer,
      additionalHeaders?: KimMailHeaderField[],
  ): KimMailBuilder

  Adds an attachment to the mail being constructed.

  Parameters

  • filename: string

    The Filename of the attachment

  • contentType: string

    the mime type of the content being send.

  • arrayBuffer: ArrayBuffer

    the actual content as binary ArrayBuffer.

  • additionalHeaders: KimMailHeaderField[] = []

    Allows to attach additional Headers to the MimePart of the attachment.

  Returns KimMailBuilder

  this

addMimeTextPart

• addMimeTextPart(
      text: string,
      additionalHeaders?: KimMailHeaderField[],
  ): KimMailBuilder

  Adds a text part to the mail being constructed. the content type of the part is "text/plain;charset=UTF-8"

  Parameters

  • text: string

    the text of the mime part.

  • additionalHeaders: KimMailHeaderField[] = []

    Allows to attach additional Headers to the MimePart of the attachment.

  Returns KimMailBuilder

  this

addMimePartFromBase64

• addMimePartFromBase64(
      contentType: string,
      base64Content: string,
      additionalHeaders?: KimMailHeaderField[],
  ): KimMailBuilder

  Adds a mime part to the mail being constructed.

  Parameters

  • contentType: string

    the mime type of the part.

  • base64Content: string

    the actual content as a base64 encoded string.

  • additionalHeaders: KimMailHeaderField[] = []

    Allows to attach additional Headers to the MimePart of the attachment.

  Returns KimMailBuilder

  this

addMimePartFromArrayBuffer

• addMimePartFromArrayBuffer(
      contentType: string,
      arrayBuffer: ArrayBuffer,
      additionalHeaders?: KimMailHeaderField[],
  ): KimMailBuilder

  Adds a mime part to the mail being constructed.

  Parameters

  • contentType: string

    the mime type of the part.

  • arrayBuffer: ArrayBuffer

    the actual content as binary ArrayBuffer.

  • additionalHeaders: KimMailHeaderField[] = []

    Allows to attach additional Headers to the MimePart of the attachment.

  Returns KimMailBuilder

  this

build

• build(): Mail

  Constructs the actual mime mail.

  Returns Mail

  mail in Mime format.