Airmail

Airmail is an email client. Protocol Launcher allows you to generate official Airmail iOS URL scheme links to compose and send messages.

Usage

There are two ways to use this library:

• On-Demand import from subpaths enables tree-shaking and keeps bundles small.
• Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand

Recommended. Optimized for production.

Full Import

Convenient. Good for quick scripts.

Compose

On-Demand

import { compose } from 'protocol-launcher/airmail'

const url = compose({
  subject: 'Message subject',
  to: 'joe@example.com',
  plainBody: 'Message body',
})

Compose in Airmail

Send

Airmail documents send as an x-callback-url endpoint with from, subject, to, plainBody, and x-callback parameters.

On-Demand

import { send } from 'protocol-launcher/airmail'

const url = send({
  from: 'info@email.com',
  subject: 'subj',
  to: 'infoto@email.com',
  plainBody: 'hello',
  xSource: 'sourceapp',
  xSuccess: 'sourceapp://success',
  xError: 'sourceapp://error',
  xCancel: 'sourceapp://cancelled',
})