MailFlat

MailFlat SDK

适用于 MailFlat 的官方客户端库：由你的代码掌控的电子邮箱收件箱，支持单行代码获取 OTP。专为测试套件（Selenium、pytest、Playwright）和 AI Agent 打造。

邮箱地址是永久的，因此测试套件无需每次运行都申请新地址。只有邮件会在你选择的保留期限后过期。

本仓库仅包含开源 SDK。MailFlat 服务本身为闭源。

软件包

软件包	适用对象	安装
mailflat	Python	pip install mailflat
@mailflat/sdk	JavaScript / TypeScript	npm i @mailflat/sdk
mailflat-mcp	AI 助手（Claude、Cursor）— MCP	uvx mailflat-mcp
@mailflat/ai-sdk	Vercel AI SDK Agent	npm i @mailflat/ai-sdk
mailflat.langchain	LangChain Agent	pip install "mailflat[langchain]"
mailflat-sdk（Java）	Java / Selenium	通过 JitPack — 见下文

每个客户端都是基于相同 /api/v1 Agent API 的轻量级强类型封装，因此行为一致。 使用控制面板中的账户密钥（mf_live_…）进行身份验证（Agents → API keys）。

Java / Selenium（JitPack）

JitPack 根据 GitHub 所有者生成 groupId。本仓库于 2026 年 8 月迁移至官方 MailFlat 账户，因此从 v0.4.4 起发布的版本坐标为 com.github.MailFlat:mailflat-sdks。更早的版本仍使用旧坐标 com.github.onderyentar21:mailflat-sdks；旧仓库会继续保留，以支持这些版本。 客户端接下来将迁移至 Maven Central（net.mailflat），届时不再受所有者名称限制。

<repositories>
  <repository><id>jitpack.io</id><url>https://jitpack.io</url></repository>
</repositories>

<dependency>
  <groupId>com.github.MailFlat</groupId>
  <artifactId>mailflat-sdks</artifactId>
  <version>v0.8.1</version>
</dependency>

MailFlat mf = new MailFlat("mf_live_…");
Inbox inbox = mf.create("signup");
driver.findElement(By.id("email")).sendKeys(inbox.address());
String otp = inbox.waitForOtp(30);          // polls until the code arrives
driver.findElement(By.id("code")).sendKeys(otp);

快速示例

Python

from mailflat import MailFlat
mf = MailFlat(api_key="mf_live_…")
inbox = mf.create(label="signup")
otp = inbox.wait_for_otp(timeout=30)

JavaScript / TypeScript

import { MailFlat } from "@mailflat/sdk";
const mf = new MailFlat({ apiKey: process.env.MAILFLAT_API_KEY });
const inbox = await mf.create({ label: "signup" });
const otp = await inbox.waitForOtp({ timeout: 30000 });

许可证

MIT。完整文本位于仓库根目录的 LICENSE 文件中；每个软件包目录均附有相同副本。