Skip to content

Airmail

Airmail 是一款邮件客户端。Protocol Launcher 允许您生成官方 Airmail iOS URL scheme 链接,用于撰写和发送邮件。

使用方式

有两种使用此库的方式:

  • 按需导入(On-Demand):从子路径导入支持 tree-shaking,保持较小的打包体积。
  • 完整导入(Full Import):从根包导入更方便,但会包含所有应用模块。

生产构建建议选择按需导入;快速脚本或演示可以使用完整导入。

选择安装方式

按需加载
推荐使用。生产环境优化。
全量导入
使用便捷。适合快速脚本。

撰写邮件

On-Demand
ts
import { compose } from 'protocol-launcher/airmail'

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

发送邮件

Airmail 将 send 记录为 x-callback-url 端点,包含 fromsubjecttoplainBody 和 x-callback 参数。

On-Demand
ts
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',
})