Class Email

constructor

• new Email(
      envelope: Envelope,
      headers: Record<string, string | string[]>,
      body: string,
      attachments?: Attachment[],
  ): Email

• Creates a new email instance.

  Parameters

  • envelope: Envelope

    The envelope containing sender and recipient details.
  • headers: Record<string, string | string[]>

    The headers of the email.
  • body: string

    The plain text body of the email.
  • Optionalattachments: Attachment[]

    Optional attachments for the email.

  Returns Email

  Since

  0.0.1

Optionalattachments

body

envelope

headers

addHeader

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

• Adds a new header or appends to an existing header. If the header already exists, it is converted to an array.

  Parameters

  • name: string

    The name of the header.
  • value: string

    The value to add to the header.

  Returns void

  Example

  const email = new Email(envelope, {}, 'Hello');
  email.addHeader('X-Custom-Header', 'Value1');
  email.addHeader('X-Custom-Header', 'Value2');
  console.log(email.getHeader('X-Custom-Header')); // Output: ['Value1', 'Value2']
  Copy

  Since

  0.0.1

getBody

• getBody(): string

• Retrieves the body of the email. If the email contains both plain text and HTML, plain text is preferred.

  Returns string

  The email body.

  Example

  const email = new Email(envelope, {}, 'Hello, world!');
  console.log(email.getBody()); // Output: 'Hello, world!'
  Copy

  Since

  0.0.1

getHeader

• getHeader(name: string): undefined | string | string[]

• Retrieves a header value by name (case-insensitive).

  Parameters

  • name: string

    The name of the header to retrieve.

  Returns undefined | string | string[]

  The header value, or undefined if not found.

  Example

  const email = new Email(envelope, { 'subject': 'Subject String' });
  console.log(email.getHeader('Subject')); // Output: 'Subject String'
  Copy

  Since

  0.0.1

removeHeader

• removeHeader(name: string): void

• Removes a header by name (case-insensitive).

  Parameters

  • name: string

    The name of the header to remove.

  Returns void

  Example

  const email = new Email(envelope, { 'X-Test': 'value' }, 'Hello');
  email.removeHeader('X-Test');
  console.log(email.getHeader('X-Test')); // Output: undefined
  Copy

  Since

  0.0.1

toString

• toString(): string

• Returns the email as a string in the IMF format.

  Returns string

  The formatted email as a string.

  See

  https://datatracker.ietf.org/doc/html/rfc5322

  Example

  const email = new Email(envelope, { subject: 'Test' }, 'Hello');
  console.log(email.toString());
  // Output:
  // Subject: Test
  //
  // Hello
  Copy

  Since

  0.0.1