@procedures/mail
v0.48.2
Published
Email procedures: the headers, addresses and text of a raw MIME message, and the headers of recent IMAP messages, read only.
Maintainers
mark1russell7Readme
@procedures/mail
Email procedures: the headers, the addresses and the text of a raw message (MIME), and the headers of the recent messages of an IMAP mailbox.
Install
pnpm add @procedures/mail @procedures/clientA host registers the procedures with createRegistry(mailModule), or with import "@procedures/mail/register" for the global registry. The package root and ./module register nothing.
Procedures
| Procedure | Effects | What it does |
| --- | --- | --- |
| mail.parse | none | Reads the headers, the addresses and the text of a raw RFC 822 message. It reads multipart, quoted-printable, base64 and HTML-only messages. |
| mail.headers | reads network | Gives the headers of the recent messages of an IMAP mailbox. It opens the mailbox read only, so no message becomes read. |
Example
// IMAP_PASSWORD holds the password (an app password for Gmail)
const { messages } = await client.exec(["mail", "headers"], {
host: "imap.gmail.com",
user: "[email protected]",
sinceDays: 2,
});The password
The password of mail.headers is never an input, so no log of a call records it. The procedure reads it from the environment variable that passwordEnv names (default: IMAP_PASSWORD).
The name starts with IMAP_ or MAIL_, for example IMAP_PASSWORD or MAIL_WORK_PASSWORD. The procedure refuses another name. The caller chooses the host, so another name lets it send a secret of the host, for example GITHUB_TOKEN, to its own server.