- Clone this repository
- Install the dependencies with
npm install
- Use the command
npx wrangler secret put --env production TOKEN
to deploy a securely stored token to Cloudflare. With this command, you will be prompted to enter a random secret value, which will be used to authenticate your requests with the HTTPAuthorization
header as described below. You can also set this encrypted value directly in your Cloudflare dashboard. - Repeat step 3 with the DKIM Secrets if need be
- Deploy the worker with
npm run deploy
Or deploy directly to Cloudflare and enable Github Actions
SPF is a DNS record that helps prevent email spoofing. You will need to add an SPF record to your domain to allow MailChannels to send emails on your behalf.
-
Add a
TXT
record to your domain with the following values:- Name: `@` - Value: `v=spf1 a mx include:relay.mailchannels.net ~all`
Note: If you're facing Domain Lockdown error, follow the below steps:
-
Create a
TXT
record with the following values:- Name: `_mailchannels` - Value: `v=mc1 cfid=yourdomain.workers.dev` (the value of `cfid` will also be present in the error response if you do it wrong)
This step is optional, but highly recommended. DKIM is a DNS record that helps prevent email spoofing. You may follow the steps listed in the MailChannels documentation to set up DKIM for your domain.
- TOKEN - Client authentication
- DKIM_DOMAIN - DKIM Domain
- DKIM_PRIVATE_KEY - DKIM Private Key (Bare base64 encoded key without BEGIN and END statements and no newlines)
- DKIM_SELECTOR - DKIM Selector
- CF_ACCOUNT_ID - Cloudflare Account ID
- CF_API_TOKEN - Cloudflare API Token with enough capability to deploy workers
Once you have deployed this worker function to Cloudflare Workers, you can send emails by making a POST
request to the worker on the /api/email
endpoint with the following parameters:
- Note you need to pass an
Authorization
header with the secure token you deployed. Like the following:Authorization: TOKEN
The Most basic request would look like this:
{
"to": "john@example.com",
"from": "me@example.com",
"subject": "Hello World",
"text": "Hello World"
}
You can also send HTML emails by adding an html
parameter to the request. This can be used in conjunction with the text
parameter to send a multi-part email.
{
"to": "john@example.com",
"from": "me@example.com",
"subject": "Hello World",
"html": "<h1>Hello World</h1>"
}
You can also specify a sender and recipient name by adding a name
parameter to the request. This can be used for both the to
and from
parameters.
{
"to": { "address": "john@example.com", "name": "John Doe" },
"from": { "address": "me@example.com", "name": "Jane Doe" },
"subject": "Hello World",
"text": "Hello World"
}
You may also send to multiple recipients by passing an array of emails, or an array of objects with address
and name
properties.
{
"to": [
"john@example.com",
"rose@example.com"
],
"from": "me@example.com",
"subject": "Hello World",
"text": "Hello World"
}
or
{
"to": [
{ "address": "john@example.com", "name": "John Doe" },
{ "address": "rose@example.com", "name": "Rose Doe" }
],
"from": "me@example.com",
"subject": "Hello World",
"text": "Hello World"
}
You can also send BCC and CC emails by passing an array of emails, an object with address
and name
properties, or an array of either, similar to the to
parameter.
{
"to": "john@example.com",
"from": "me@example.com",
"subject": "Hello World",
"text": "Hello World",
"cc": [
"jim@example.com",
"rose@example.com"
],
"bcc": [
"gil@example.com"
]
}
Reply To
You can also specify a reply to email address by adding a replyTo
parameter to the request. Again, you can use an email string, an object with address
and name
properties, or an array of either.
{
"to": "john@example.com",
"from": "me@example.com",
"replyTo": "support@example.com",
"subject": "Hello World",
"text": "Hello World"
}