Integrating with Fastmail

Welcome, builders! Involved in getting began writing integrations for
your Fastmail account? You’ve got come to the proper place.

Fastmail presently presents a JMAP (RFC8620) API for accessing, managing and sending mail, and for managing your masked email addresses. We hope to develop our API entry to scopes over time.

JMAP Crash Course

Want to learn more about JMAP, the modern standard powering Fastmail?
Check out our quick guide to how it works.

You want two issues to get began with our API:

The JMAP Session Useful resource, which might be discovered at might be discovered at https://api.fastmail.com/jmap/session. This provides you with all the opposite endpoints you want; for instance, to make API requests or to add information. For extra info, see the specification. We additionally help DNS autodiscovery as outlined in the JMAP standard.
A option to authenticate your requests.

All Fastmail API requests have to be authenticated with a bearer token. This can be a shared secret that gives entry to a restricted set of knowledge inside a specific consumer’s account. Bearer tokens ought to be handled as a kind of password and saved accordingly. These ought to be created with as little entry to an account doable: solely create a token with the scopes you want on your software. If you do not want to switch knowledge, you possibly can create a read-only token.

To authenticate an HTTP request, you add an Authorization header set to Bearer {worth}, the place {worth} is the worth of the token. Our APIs are CORS enabled so you possibly can create integrations straight from an online app, in addition to from a server or native code.

To get began, you possibly can create a token on your personal consumer in Settings → Password & Security → API tokens. If you want to share your app extra extensively, we encourage you to implement OAuth to permit your customers to simply log in and get a token on your app.

Try the
JMAP-Samples repository for
illustrative examples of bearer tokens in motion in a good pattern of programming
languages.