Skip to content

Documentation

Send email from Remix and React Router.

An action that reads the form, sends the message, and returns the result to the page.

Before you start

You need a verified sending domain (see Domains) and an API key (under API keys in the dashboard; it is shown once). Keep the key in an environment variable on your server, never in code that runs in a browser or an app.

Install

Add the client. Actions run on the server, so the key never reaches the browser.

Terminal
npm install mailtruss

The action

Remix and React Router v7 use the same shape. In React Router v7 import ActionFunctionArgs from react-router; in Remix v2 import it from @remix-run/node (or the runtime package you use).

app/routes/contact.tsx
import { Form, useActionData } from "react-router";
import type { ActionFunctionArgs } from "react-router";
import { MailClient, MailError } from "mailtruss";
​
const escapeHtml = (s: string) => s.replace(/[&<>"']/g, (c) => `&#${c.charCodeAt(0)};`);
​
export async function action({ request }: ActionFunctionArgs) {
const form = await request.formData();
const email = String(form.get("email") ?? "").trim();
const message = String(form.get("message") ?? "").trim();
if (!email.includes("@") || !message) return { ok: false, error: "Enter your email and a message." };
​
const mail = new MailClient({ apiKey: process.env.MAILTRUSS_API_KEY! });
try {
await mail.emails.send({
from: "Site <hello@yourdomain.com>", to: "you@yourdomain.com", reply_to: email,
subject: "New message from the site", html: `<p>${escapeHtml(message)}</p>`,
});
return { ok: true };
} catch (e) {
if (e instanceof MailError) return { ok: false, error: "We could not send that. Try again in a minute." };
throw e;
}
}
​
export default function Contact() {
const result = useActionData<typeof action>();
return (
<Form method="post">
<input name="email" type="email" required />
<textarea name="message" required />
<button>Send</button>
{result?.ok === false && <p role="alert">{result.error}</p>}
{result?.ok && <p>Sent. Thank you.</p>}
</Form>
);
}

On Cloudflare

On Cloudflare Workers there is no process.env: read the key from the context your adapter gives the action (context.cloudflare.env.MAILTRUSS_API_KEY) and set it with wrangler secret put.

Try it without sending real mail

Send to delivered@mailtruss.test first. It works before any domain is verified and reaches no real mailbox, so you can check your code and see the recorded timeline. Then try bounced@mailtruss.test to see what a bounce looks like. All the test addresses are listed under Sending.

See what happened

Open the message under Emails in the dashboard: it shows the recorded timeline, what each event proves, and a diagnosis if something went wrong. Or fetch it with GET /api/v1/emails/:id/events. To be told as it happens, add a webhook.

If it fails

API requests answer with an error name and message. The common ones:

  • 403 invalid_api_key or 401 missing_api_key: the key is wrong, revoked or not sent. Send it as Authorization: Bearer ms_live_….
  • 403 domain_not_verified: the from address is on a domain that is not verified. Publish the DNS records and re-check.
  • 422 validation_error: fix the field the message names. Nothing was sent and no quota was used.
  • 429 rate_limit_exceeded: back off for the Retry-After header. See rate limits.

Problems that happen after a message is accepted (bounces, complaints) are explained under delivery errors.

Other guides

Last updated

Something wrong or unclear on this page?

Report an issue