Skip to content
This repository has been archived by the owner on Jun 5, 2024. It is now read-only.

boywithkeyboard/mailchannels

Repository files navigation

mailchannels(.js)

mailchannels announced that their free tier and the API to send email from Cloudflare Workers will reach its end of life on June 30th.

Note

This SDK is meant for Cloudflare Workers' integration of mailchannels, which doesn't require authentication.

Setup

npm i mailchannels
import { sendMail } from 'mailchannels'

Usage

Add the below TXT records for SPF and Domain Lock to work correctly. Replace WORKER_ID with either

  • your unique subdomain for workers, e.g. username.workers.dev
  • or the (sub)domain you're using for the worker, e.g. example.com.
Name Content
@ v=spf1 a mx include:relay.mailchannels.net ~all
_mailchannels v=mc1 cfid=WORKER_ID
const { success } = await sendMail({
  subject: 'An example',
  message: 'This is an example email sent from Cloudflare Workers.',
  from: {
    name: 'You',
    email: '[email protected]'
  },
  to: '[email protected]'
})