# @antelopejs/interface-email 中文文档

规范地址：https://npmcn.com/package/%40antelopejs/interface-email/

版本：0\.1\.1
npm 元数据更新时间：2026-11-04T15:44:39.884Z
中文译文更新时间：2026-11-06T06:26:25.263Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40antelopejs/interface-email
原文对照：https://npmcn.com/package/%40antelopejs/interface-email/?lang=original
项目主页：https://github.com/AntelopeJS/interface-email/tree/main/docs
源码仓库：https://github.com/AntelopeJS/interface-email

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：64.8 kB，13 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@antelopejs/interface-core \>=0\.2\.4 \<1\.0\.0
- 首次发布：2026-03-22T16:18:16.986Z
- 最新版本发布：2026-11-04T15:44:39.553Z
- 近 30 天下载量：13562（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

发送电子邮件的羚羊JS接口:单发、批发和带有附件的模板信件

## 安装

```sh
npm install @antelopejs/interface-email
```

也可以使用：`pnpm add @antelopejs/interface-email`、`yarn add @antelopejs/interface-email`、`bun add @antelopejs/interface-email`

## README

# `@antelopejs/interface-email`

[![npm](https://img.shields.io/npm/v/@antelopejs/interface-email?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/interface-email) [![License](https://img.shields.io/npm/l/@antelopejs/interface-email?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/interface-email/LICENSE) [![Discord](https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000)](https://discord.gg/g4pFt6eXqu) [![Docs](https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000)](https://npmcn.com/package/%40antelopejs/interface-email/docs/1.introduction.md)

AntelopeJS发送电子邮件的合同:一个API,用于单发,批发和模板消息,任何供应商都会发送.

## 它提供的东西

-   `Send` 发送一个带有文本或 HTML、收件人、线程头和附件的信息.
-   `SendBatch` 在一个呼叫中发送多条消息, 并共享默认值 .
-   `SendTemplate` 使提供者模板或带有变量的内置模板.
-   `GetCapabilities` 报告提供者支持的内容,例如时间安排或跟踪.
-   `Send` 财务报告和审定财务报表 `SendTemplate` 返回状态、可选提供者消息ID和可选错误细节. `SendBatch` 返回总计和每个消息一个结果. `GetCapabilities` 返回提供者的特性和限制,而不是执行结果.

## 执行情况

| 模块 | 页:1 |
| --- | --- |
| [`@antelopejs/nodemailer`](https://github.com/AntelopeJS/nodemailer) | SMTP 通过节点 |
| [`@antelopejs/brevo`](https://github.com/AntelopeJS/brevo) | 布莱沃 HTTP API |

## 安装

向发送电子邮件的模块添加接口 :

```bash
pnpm add @antelopejs/interface-email
```

然后在项目中添加一个执行:

```bash
ajs project modules add @antelopejs/nodemailer
```

## 快开始

```ts
import { Send } from "@antelopejs/interface-email";

export async function sendWelcome(address: string) {
  const response = await Send({
    to: address,
    subject: "Welcome aboard",
    html: "<p>Thanks for joining.</p>",
    text: "Thanks for joining.",
  });

  if (!response.success) {
    throw new Error(response.error?.message);
  }
  return response.messageId;
}
```

## 文档

-   [导言](https://npmcn.com/package/%40antelopejs/interface-email/docs/1.introduction.md)
-   [发送电子邮件](https://npmcn.com/package/%40antelopejs/interface-email/docs/2.sending-emails.md)
-   [附录](https://npmcn.com/package/%40antelopejs/interface-email/docs/3.attachments.md)

## 兼容性

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` | `0.2.4` |

表格重复对等区域 `package.json`。软件包宣布不 `@antelopejs/core` 对等范围,请检查执行模块的要求.

## 捐款

读取 [捐款额](https://npmcn.com/package/%40antelopejs/interface-email/CONTRIBUTING.md) 在你打开拉动请求之前。 当地检查为:

```bash
pnpm install
pnpm lint
pnpm build
```

## 许可证

[阿帕奇 - 2.0](https://npmcn.com/package/%40antelopejs/interface-email/LICENSE)

## 常见问题

### @antelopejs/interface-email 是什么？

发送电子邮件的羚羊JS接口:单发、批发和带有附件的模板信件

### 如何安装 @antelopejs/interface-email？

在项目目录运行 npm install @antelopejs/interface-email，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@antelopejs/interface-core（\>=0\.2\.4 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @antelopejs/interface-email 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @antelopejs/interface-email 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @antelopejs/interface-email 可以商用吗？

@antelopejs/interface-email 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @antelopejs/interface-email 的下载量有多少？

根据 npm 官方下载统计，@antelopejs/interface-email 在 2026/10/06 – 2026/11/04 这 30 天内被下载 13,562 次，日均约 452 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @antelopejs/interface-email 还在维护吗？

最新版本 0\.1\.1 发布于 2026/11/04（1 天前）；至今共发布 7 个版本，其中过去 12 个月发布了 7 个；首次发布于 2026/03/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。