# letterbuilder

> Build RFC 5322 complaint messages.

Latest version **0.0.4** (published 2024-01-12) · BSD-3-Clause-Clear license · 0 weekly downloads

## Install

```sh
npm install letterbuilder
pnpm add letterbuilder
yarn add letterbuilder
bun add letterbuilder
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2024-01-12 |
| First published | 2020-07-30 |
| Weekly downloads | 0 |
| License | BSD-3-Clause-Clear |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Mat Sz |
| Maintainers | mat-sz |
| Keywords | email, e-mail, mail, mime, mailparser, emailparser, mail-parser, email-parser, e-mail-parser, mime-parser, mime-message, mime-message-parser, parser, typescript, isomorphic |

## Links

- npm: https://www.npmjs.com/package/letterbuilder
- Repository: https://github.com/mat-sz/letterbuilder
- Issues: https://github.com/mat-sz/letterbuilder/issues
- npm.io page: https://npm.io/package/letterbuilder

## Dependencies (1)

- [base64-js](https://npm.io/package/base64-js.md) ^1.5.1

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2024-01-12
- 0.0.3 — 2022-09-12
- 0.0.2 — 2020-07-30

## README

<h1 align="center">
  letterbuilder
</h1>

<p align="center">
<img alt="workflow" src="https://img.shields.io/github/actions/workflow/status/mat-sz/letterbuilder/node.js.yml?branch=master">
<a href="https://npmjs.com/package/letterbuilder">
<img alt="npm" src="https://img.shields.io/npm/v/letterbuilder">
<img alt="npm" src="https://img.shields.io/npm/dw/letterbuilder">
<img alt="NPM" src="https://img.shields.io/npm/l/letterbuilder">
</a>
</p>

**letterbuilder** is a library created for building RFC 5322 compliant e-mail messages. The library is written in TypeScript, fully supports both browser and server environments.

| Parser                                                 | SMTP client/server                                 |
| ------------------------------------------------------ | -------------------------------------------------- |
| [letterparser](https://github.com/mat-sz/letterparser) | [@typemail/smtp](https://github.com/typemail/smtp) |

## Usage

### General information

To build the message, use `build`:

```js
import { build } from 'letterbuilder';
let res = build({
  from: 'test@example.com',
  to: ['someone@example.com'],
  text: 'Hello, world!',
});
```

---
_Source: https://npm.io/package/letterbuilder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
