emailthing
TypeScript icon, indicating that this package has built-in type declarations

0.0.3 • Public • Published

EmailThing

This is a package with the SDK for EmailThing to use with the API, and also has a CLI version so you can view your emails and send them from the terminal.

NOTE: This is v0 still and can contain breaking changes.

SDK

JavaScript library for the EmailThing API.

Setup

First, you need to get an API key, which is available in the EmailThing mailbox config page.

import { EmailThing } from 'emailthing';
const emailthing = new EmailThing('et__aaaaaaaaaaaaaaaaaaaaaaaaaaaaaabbbbbb');

Usage

Send your first email:

await emailthing.send({
  from: 'you@example.com',
  to: ['user@gmail.com'],
  subject: 'hello world',
  text: 'it works!',
});

You can also use more advanced features:

await emailthing.send({
  from: 'Me <you@example.com>',
  to: [
    'Friend <user@gmail.com',
    'Better Friend <user@emailthing.xyz>'
  ],
  cc: ['Me <you@example.com>'],
  bcc: ['Me <you@example.com>'],
  reply_to: 'Everyone <you@example.com>',
  subject: 'hello world',
  text: 'it works!',
  html: '<h1>it works!</h1>',
  headers: {
    'X-Entity-Ref-ID': '23456789',
  },
  config: {
    // save the email in the sent folder?
    save_in_sent: false, // (default: true)
  },
});

CLI

A visual terminal interface for the EmailThing site.

Not done yet - It will have a CLI version so you can view your emails and send them from the terminal.

$ bunx emailthing

Readme

Keywords

Package Sidebar

Install

npm i emailthing

Weekly Downloads

2

Version

0.0.3

License

none

Unpacked Size

8.9 kB

Total Files

9

Last publish

Collaborators

  • riskymh