# @cemalgnlts/mailjs 中文文档

规范地址：https://npmcn.com/package/%40cemalgnlts/mailjs/

版本：3\.1\.2
npm 元数据更新时间：2026-03-05T18:42:56.574Z
中文译文更新时间：2026-11-09T07:32:41.562Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cemalgnlts/mailjs
原文对照：https://npmcn.com/package/%40cemalgnlts/mailjs/?lang=original
项目主页：https://github.com/cemalgnlts/Mailjs#readme
源码仓库：https://github.com/cemalgnlts/Mailjs

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

- 包体积（解压后）：34.9 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2021-09-05T08:12:15.930Z
- 最新版本发布：2026-03-05T18:42:56.191Z
- 近 30 天下载量：138990（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 1 个）

## 中文简介

一个 Java 脚本包装 [邮件](https://docs.mail.tm/) api. (英语).

## 安装

```sh
npm install @cemalgnlts/mailjs
```

也可以使用：`pnpm add @cemalgnlts/mailjs`、`yarn add @cemalgnlts/mailjs`、`bun add @cemalgnlts/mailjs`

## README

# 邮件

一个 Java 脚本包装 [邮件](https://docs.mail.tm/) api. (英语).

可能是创建临时电子邮件账户的最佳API之一.

-   严禁将我国API用于非法活动.
-   禁止出售完全使用我们的API的程序或从中赚取收入(例如,创建一个竞争的临时邮件客户端并收取使用费).
-   一般配额限制是每个IP地址每秒8个查询(QPS).

> 如果你的目标是测试您的电子邮件, 请检查 [smpt.dev (英语)](https://smtp.dev/) 为了更多的工具.

# 安装

**无**

```sh
npm install @cemalgnlts/mailjs
```

**线条**

```sh
yarn add @cemalgnlts/mailjs
```

**光盘N**

```html
<!-- It is only needed to listen to new messages. -->
<script src="https://cdn.jsdelivr.net/gh/cemalgnlts/Mailjs@3.0.0/eventsource.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@cemalgnlts/mailjs@3.0.0/dist/mailjs.min.js"></script>
```

# 快速启动

-   节点( CommonJS)

```js
const Mailjs = require("@cemalgnlts/mailjs");
```

-   节点( ESM)

```js
import Mailjs from "@cemalgnlts/mailjs";
```

-   浏览器

```html
<!-- You can exlude this if not listening to events. -->
<script src="https://cdn.jsdelivr.net/gh/cemalgnlts/Mailjs@3.0.0/eventsource.min.js"></script>
<!-- Mailjs library -->
<script src="https://cdn.jsdelivr.net/npm/@cemalgnlts/mailjs@3.0.0/dist/mailjs.min.js"></script>
```

[`EventSourcePolyfill`](https://github.com/EventSource/eventsource) 仅用于收听新来的消息,参见 [活动](https://npmcn.com/package/%40cemalgnlts/mailjs/#readme-events) 标题。 添加 [`EventSourcePolyfill`](https://github.com/EventSource/eventsource) 在迈勒斯之前.

```js
const mailjs = new Mailjs();

mailjs.createOneAccount()
    .then(account => console.log(account.data));
```

更多参考访问 [实例](https://npmcn.com/examples) 目录.

# 文档

在函数调用后返回“承诺”对象。 如果请求发送正确, `status` 返回时 `true`。 。 。 .

如果返回不正确,则 `status` 将会是 `false` 编辑 `message` 在数据中也添加.

如果没有错误, `status` 总是返回 `true`。 。 。 .

与 `statusCode` 您可以访问由于请求而返回的状态代码. `statusCode` 只用于调试,只是看看 `status` 以查看是否发生了错误.

一个成功的响应实例:

```json
{
  "status": true,
  "statusCode": 200,
  "message": "ok",
  "data": {}
}
```

失败的响应示例 :

```json
{
  "status": false,
  "statusCode": 410,
  "message": "Invalid credentials.",
  "data": {}
}
```

示例使用:

```js
const acc = await mailjs.createOneAccount();

// If there is a error.
if(!acc.status) {
  // Show the cause of the error.
  console.error(acc.message);

  return;
}

// If successful, access the data.
console.log(acc.data);
```

要查看所有结果, 请检查 API 页面 : [https://api.mail.tm/ (中文(简体) )](https://api.mail.tm/)。 。 。 .

用户需要登录才能访问JWT标志. 登记不退回这些资料,在登记后登录.

登录过程结束后,用户的JWT 令牌和ID被分配到 `mailjs.token` 财务报告和审定财务报表 `mailjs.id`。 。 。 .

* * *

## 构造器

一般配额限制是每个IP地址每秒8个查询(QPS). 但随着时间的推移,这种情况可能会发生变化。 如果发生超时出错,库会等待一秒并重复请求. 如果3次尝试后问题仍未解决,则会出错.

要关闭此选项或增加尝试次数, 请用 `rateLimitRetries` 当创建构建器对象时。 默认值是 **3个**。 。 。 .

禁用它 :

```js
const mailjs = new Mailjs({ rateLimitRetries: 0 });
```

或者如果出现超时出错,请尝试5次等待每秒1:

```js
const mailjs = new Mailjs({ rateLimitRetries: 5 });
```

## 域名

### 列表域

```js
mailjs.getDomains()
  .then(console.log);
```

### 获取域

```js
mailjs.getDomain("[domain id]")
  .then(console.log);
```

## 账户

### 创建账户

```js
mailjs.register("user@example.com", "password")
  .then(console.log);
```

### 登录

`mailjs.token` 财务报告和审定财务报表 `mailjs.id` 可用于访问用户符和后期的id.

```js
mailjs.login("user@example.com", "password")
  .then(console.log);
```

### 用托肯登录

如果您使用 JWT 符号存储在 `mailjs.token` 登录后,它将允许您登录,无需用户名和密码.

```js
mailjs.loginWithToken("eyJ0eXAiO...")
  .then(console.log);
```

### 获取账户数据

```js
mailjs.me()
  .then(console.log);
```

### 删除账户

```js
mailjs.deleteMe()
  .then(console.log);
```

也可以使用ID访问用户信息并删除他们的账户.

```js
mailjs.deleteAccount("[account id]")
  .then(console.log);
```

```js
mailjs.getAccount("[account id]")
  .then(console.log);
```

## 消息

### 列出信件

获取指定页面的所有信件资源.

```js
mailjs.getMessages()
  .then(console.log);
```

### 读取信件

以特定代号获取信件资源( 它拥有比用 GET / messages 获取信件更多的信息, 但是它没有“ intro” 成员)

```js
mailjs.getMessage("[message id]")
  .then(console.log);
```

### 删除信件

```js
mailjs.deleteMessage("[message id]")
  .then(console.log);
```

### 发一通已读或未读.

`true` 被读取. `false` 为未读取.

```js
mailjs.setMessageSeen("[message id]", true)
  .then(console.log);
```

## 活动

事件是 **页:1**尔瓦 **页:1**数字 **页:1**消息发出时发射的通风口 `arrive`, (中文(简体) ), `seen` 或者说 `delete`。它还发射 `error`, (中文(简体) ), `open` 状态.

### 打开

打开事件收听器查看消息和错误 .

```js
// Add it before other activities if you need it.
mailjs.on("open", msg => console.log("Event listening has begun."));

// When a new message arrives.
mailjs.on("arrive", msg => console.log(`Message id: ${msg.id} has arrived (${msg.intro}).`));

// When a message is marked as read.
mailjs.on("seen", msg => console.log(`Message id: ${msg.id} marked as seen.`));

// When a message is deleted.
mailjs.on("delete", msg => console.log(`Message id: ${msg.id} has been deleted.`));

// If an error occurs during listening.
mailjs.on("error", err => console.error("Something went wrong:", err));
```

### 关

清除事件并安全关闭事件听众.

```js
mailjs.off();
```

## 来源

### 获取来源

获得信件的来源资源( 如果您不知道这是什么, 您不是真的不想使用它, 或是您应该使用它 ) [看这个!](https://en.wikipedia.org/wiki/Email#Plain_text_and_HTML)(中文(简体) )

```js
mailjs.getSource("[message id]")
  .then(console.log)
```

## 帮助方法

### 创建随机账户 .

`mailjs.createOneAccount(useUUID: boolean = false)`

在有随机用户名和密码的账户中创建和日志。 在自动电子邮件创建时可以使用相同的电子邮件地址. 为了防止这种情况,您可以使用UUID作为电子邮件地址: `mailjs.createOneAccount(true)`

```js
mailjs.createOneAccount()
  .then(console.log);
```

#### 回应

```json
{
  "status": true,
  "message": "ok",
  "data": {
    "username": "user@example.com",
    "password": "my-password"
  }
}
```

# 问题和建议

如果你有任何问题或建议,请通过电子邮件联系我们 [支持@ mail.tm](mailto:support@mail.tm) 或者说 [不对](https://discord.gg/Mhw2PDZBdk)。 。 。 .

## 常见问题

### @cemalgnlts/mailjs 是什么？

一个 Java 脚本包装 邮件 api\. \(英语\)\.

### 如何安装 @cemalgnlts/mailjs？

在项目目录运行 npm install @cemalgnlts/mailjs，或使用 pnpm add / yarn add / bun add。

### @cemalgnlts/mailjs 支持 TypeScript 吗？

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

### @cemalgnlts/mailjs 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cemalgnlts/mailjs 可以商用吗？

@cemalgnlts/mailjs 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cemalgnlts/mailjs 的下载量有多少？

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

### @cemalgnlts/mailjs 还在维护吗？

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