邮件
一个 Java 脚本包装 邮件 api. (英语).
可能是创建临时电子邮件账户的最佳API之一.
- 严禁将我国API用于非法活动.
- 禁止出售完全使用我们的API的程序或从中赚取收入(例如,创建一个竞争的临时邮件客户端并收取使用费).
- 一般配额限制是每个IP地址每秒8个查询(QPS).
如果你的目标是测试您的电子邮件, 请检查 smpt.dev (英语) 为了更多的工具.
安装
无
npm install @cemalgnlts/mailjs
线条
yarn add @cemalgnlts/mailjs
光盘N
<!-- It is only needed to listen to new messages. -->
<script src="https://cdn.jsdelivr.net/gh/cemalgnlts/[email protected]/eventsource.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@cemalgnlts/[email protected]/dist/mailjs.min.js"></script>
快速启动
- 节点( CommonJS)
const Mailjs = require("@cemalgnlts/mailjs");
- 节点( ESM)
import Mailjs from "@cemalgnlts/mailjs";
- 浏览器
<!-- You can exlude this if not listening to events. -->
<script src="https://cdn.jsdelivr.net/gh/cemalgnlts/[email protected]/eventsource.min.js"></script>
<!-- Mailjs library -->
<script src="https://cdn.jsdelivr.net/npm/@cemalgnlts/[email protected]/dist/mailjs.min.js"></script>
EventSourcePolyfill 仅用于收听新来的消息,参见 活动 标题。 添加 EventSourcePolyfill 在迈勒斯之前.
const mailjs = new Mailjs();
mailjs.createOneAccount()
.then(account => console.log(account.data));
更多参考访问 实例 目录.
文档
在函数调用后返回“承诺”对象。 如果请求发送正确, status 返回时 true。 。 。 .
如果返回不正确,则 status 将会是 false 编辑 message 在数据中也添加.
如果没有错误, status 总是返回 true。 。 。 .
与 statusCode 您可以访问由于请求而返回的状态代码. statusCode 只用于调试,只是看看 status 以查看是否发生了错误.
一个成功的响应实例:
{
"status": true,
"statusCode": 200,
"message": "ok",
"data": {}
}
失败的响应示例 :
{
"status": false,
"statusCode": 410,
"message": "Invalid credentials.",
"data": {}
}
示例使用:
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/ (中文(简体) )。 。 。 .
用户需要登录才能访问JWT标志. 登记不退回这些资料,在登记后登录.
登录过程结束后,用户的JWT 令牌和ID被分配到 mailjs.token 财务报告和审定财务报表 mailjs.id。 。 。 .
构造器
一般配额限制是每个IP地址每秒8个查询(QPS). 但随着时间的推移,这种情况可能会发生变化。 如果发生超时出错,库会等待一秒并重复请求. 如果3次尝试后问题仍未解决,则会出错.
要关闭此选项或增加尝试次数, 请用 rateLimitRetries 当创建构建器对象时。 默认值是 3个。 。 。 .
禁用它 :
const mailjs = new Mailjs({ rateLimitRetries: 0 });
或者如果出现超时出错,请尝试5次等待每秒1:
const mailjs = new Mailjs({ rateLimitRetries: 5 });
域名
列表域
mailjs.getDomains()
.then(console.log);
获取域
mailjs.getDomain("[domain id]")
.then(console.log);
账户
创建账户
mailjs.register("[email protected]", "password")
.then(console.log);
登录
mailjs.token 财务报告和审定财务报表 mailjs.id 可用于访问用户符和后期的id.
mailjs.login("[email protected]", "password")
.then(console.log);
用托肯登录
如果您使用 JWT 符号存储在 mailjs.token 登录后,它将允许您登录,无需用户名和密码.
mailjs.loginWithToken("eyJ0eXAiO...")
.then(console.log);
获取账户数据
mailjs.me()
.then(console.log);
删除账户
mailjs.deleteMe()
.then(console.log);
也可以使用ID访问用户信息并删除他们的账户.
mailjs.deleteAccount("[account id]")
.then(console.log);
mailjs.getAccount("[account id]")
.then(console.log);
消息
列出信件
获取指定页面的所有信件资源.
mailjs.getMessages()
.then(console.log);
读取信件
以特定代号获取信件资源( 它拥有比用 GET / messages 获取信件更多的信息, 但是它没有“ intro” 成员)
mailjs.getMessage("[message id]")
.then(console.log);
删除信件
mailjs.deleteMessage("[message id]")
.then(console.log);
发一通已读或未读.
true 被读取. false 为未读取.
mailjs.setMessageSeen("[message id]", true)
.then(console.log);
活动
事件是 页:1尔瓦 页:1数字 页:1消息发出时发射的通风口 arrive, (中文(简体) ), seen 或者说 delete。它还发射 error, (中文(简体) ), open 状态.
打开
打开事件收听器查看消息和错误 .
// 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));
关
清除事件并安全关闭事件听众.
mailjs.off();
来源
获取来源
获得信件的来源资源( 如果您不知道这是什么, 您不是真的不想使用它, 或是您应该使用它 ) 看这个!(中文(简体) )
mailjs.getSource("[message id]")
.then(console.log)
帮助方法
创建随机账户 .
mailjs.createOneAccount(useUUID: boolean = false)
在有随机用户名和密码的账户中创建和日志。 在自动电子邮件创建时可以使用相同的电子邮件地址. 为了防止这种情况,您可以使用UUID作为电子邮件地址: mailjs.createOneAccount(true)
mailjs.createOneAccount()
.then(console.log);
回应
{
"status": true,
"message": "ok",
"data": {
"username": "[email protected]",
"password": "my-password"
}
}
问题和建议
如果你有任何问题或建议,请通过电子邮件联系我们 支持@ mail.tm 或者说 不对。 。 。 .