Source: https://once-email.com/zh_cn/sdk

开发者文档

开发者文档 SDK

# Once Email SDK

面向 Once Email 只收不发 API 的开源 SDK 候选版，提供七种生态的已测试下载。

[查看源码](<https://github.com/pangxin12345/once-email-sdks>) [SHA256SUMS](<https://once-email.com/downloads/sdk/SHA256SUMS>) [阅读 API 合同](<https://once-email.com/zh_cn/api>) [阅读 SDK 测试指南](<https://once-email.com/zh_cn/blog/temporary-email-api-testing-guide>)

## [7 Once Email SDK](<https://once-email.com/zh_cn/sdk#languages>)

TypeScript、Python、Java、Go、.NET、PHP 和 Ruby 共用一份经过审校的 OpenAPI 合同。源码、参考文档、版本和本地下载包均已公开。

### TypeScript

[下载预发布版](<https://once-email.com/downloads/sdk/once-email-typescript-sdk-0.1.0-private.2.zip>) [查看源码](<https://github.com/pangxin12345/once-email-sdks/tree/main/sdks/typescript>)

```
npm ci && npm run build
```

### Python

[下载预发布版](<https://once-email.com/downloads/sdk/once-email-python-sdk-0.1.0-private.2.zip>) [查看源码](<https://github.com/pangxin12345/once-email-sdks/tree/main/sdks/python>)

```
python -m pip install .
```

### Java

[下载预发布版](<https://once-email.com/downloads/sdk/once-email-java-sdk-0.1.0-private.2.zip>) [查看源码](<https://github.com/pangxin12345/once-email-sdks/tree/main/sdks/java>)

```
mvn clean install
```

### Go

[下载预发布版](<https://once-email.com/downloads/sdk/once-email-go-sdk-0.1.0-private.2.zip>) [查看源码](<https://github.com/pangxin12345/once-email-sdks/tree/main/sdks/go>)

```
go mod edit -replace github.com/pangxin12345/once-email-sdks/sdks/go=./once-email-go-sdk-0.1.0-private.2
```

### .NET

[下载预发布版](<https://once-email.com/downloads/sdk/once-email-dotnet-sdk-0.1.0-private.2.zip>) [查看源码](<https://github.com/pangxin12345/once-email-sdks/tree/main/sdks/dotnet>)

```
dotnet build OnceEmail.Sdk.sln
```

### PHP

[下载预发布版](<https://once-email.com/downloads/sdk/once-email-php-sdk-0.1.0-private.2.zip>) [查看源码](<https://github.com/pangxin12345/once-email-sdks/tree/main/sdks/php>)

```
composer install
```

### Ruby

[下载预发布版](<https://once-email.com/downloads/sdk/once-email-ruby-sdk-0.1.0-private.2.zip>) [查看源码](<https://github.com/pangxin12345/once-email-sdks/tree/main/sdks/ruby>)

```
bundle install && gem build once_email.gemspec
```

Linux · macOS · Windows

原生 CI 已在 Linux、macOS 和 Windows 通过。TypeScript 与 Python 执行自动化测试，其余语言执行可用的原生构建或语法门禁。

发布状态

当前是公开预发布候选版，尚未发布到 npm、PyPI、Maven Central、NuGet、Packagist 或 RubyGems。使用时请固定版本并校验 SHA256SUMS。

每个归档同时包含代码和文档；发布页另提供 MANIFEST.txt 与 SHA256SUMS。

选择 SDK

使用测试服务本来就采用的语言，不要只为轮询邮箱增加第二套运行时；七种客户端遵循同一只收不发合同。

安装前校验

下载一个不可变版本归档，对照 SHA256SUMS 校验摘要，阅读包内 README，并在项目中固定版本。

限制工作流边界

每个授权测试创建一个邮箱，在统一截止时间内轮询，分别处理 429/503，不记录邮件或验证码，并在 finally 中删除邮箱。

SDK Demo

## 代码、文档和 Demo 一起下载

版本归档包含源码、说明、安全边界和校验值。

[本地下载](<https://once-email.com/downloads/once-email-developer-demo-0.1.0-private.2.zip>) [查看 Demo](<https://github.com/pangxin12345/once-email-sdks/tree/main/demos>)

完整使用指南

## 选择具体 SDK

只测试你拥有或明确获授权的应用。Once Email 只接收邮件，不发送邮件，也不自动操作第三方注册。

文档和源码已公开；API 调用仍受控，SDK 与 Skill 是固定版本预发布下载，不是语言注册中心正式版本。 公开文档和预发布包下载不代表获得 API 访问权限；API Key 创建和真实调用尚未公开开放。

解压前先打开 SHA256SUMS 校验文件。

[选择具体 SDK](<https://once-email.com/zh_cn/sdk#languages>) [SHA256SUMS](<https://once-email.com/downloads/sdk/SHA256SUMS>)

准确的本地起点

严格使用包内 README 的本地构建或安装命令；当前不能使用语言 registry 安装。

## 从下载到第一次完整清理

1. 选择获授权测试服务本来就在使用的语言。
2. 下载该语言归档，解压前校验对应 SHA-256。
3. 确认 SDK 0.1.0-private.2、API 合同 0.5.0-private-beta、运行时、许可证和预发布状态。
4. 严格使用包内 README 的本地构建或安装命令；当前不能使用语言 registry 安装。
5. 仅在已明确获得 API 访问授权、并已持有最小必要权限的有效凭据时继续。凭据存入进程密钥设施；没有此访问资格时，只阅读文档和查看下载内容。 通过进程密钥设施注入 Key，在一个截止时间内完成创建、列表、读取和错误处理。
6. 无论成功失败都在 finally 删除，禁止输出地址、邮件、验证码、链接或 Key。

## 失败与恢复

必须区分 400、401、403、404、413、429 和 503；超时、歧义、提取、断言和清理也是不同失败。只在统一截止时间内重试，不能把依赖失败当成空收件箱。

[查看公开源码](<https://github.com/pangxin12345/once-email-sdks>) [阅读实战指南](<https://once-email.com/zh_cn/blog/temporary-email-api-testing-guide>)