郵箱服務

虛擬郵箱(臨時郵箱)能力:隨機生成一個郵箱地址並接收來信,常用於註冊驗證、接口聯調與自動化測試。

/api/VMEmail_mailcx/

服務說明

郵箱服務提供虛擬郵箱(臨時郵箱)能力:本地隨機生成一個郵箱地址、無需註冊,該地址即可接收來信,適合註冊驗證、接口聯調、自動化測試等需要一次性郵箱的場合。(原「發送郵件」能力已併入消息推送服務:POST /api/push/email/send。)

本服務需項目簽名調用。

臨時郵箱的收件是長輪詢:沒有新郵件時請求會掛起約 25 秒後返回空列表,屬正常行為,請不要按短超時判定為失敗;郵件有留存期限,重要內容請及時取回。

響應格式

所有接口返回同一個 JSON 信封,業務數據都在 data 裡:

{
  "code": 10000,
  "msg": "成功",
  "data": { ... }
}
  • code:業務狀態碼,10000 表示成功;其餘為各類錯誤,完整清單見「錯誤碼」頁。
  • msg:給人看的提示文案,可直接展示給終端用戶,但不要用它做邏輯判斷。
  • data:業務數據;出錯時通常為 null。各接口 data 的具體字段見該接口的「響應說明」。

判斷成功與否請看 code,不要依賴 HTTP 狀態碼。 查看完整錯誤碼

VMEmail(mail.cx)

VMEmail(mail.cx)臨時郵箱(僅收信) 需簽名

mail.cx 臨時郵箱:地址本地隨機生成、無需註冊,地址即唯一標識(郵件保留約 1 小時);服務端不保存會話,查詢郵件需回傳 address。需項目簽名調用。

GET /api/VMEmail_mailcx/domains 累計調用 0 次

獲取可用域名列表

獲取當前可用的全部後綴域名,用於生成郵箱時指定 domain。

響應說明 外層統一格式

data 為可用後綴域名組成的字符串數組;上遊異常時回退為內置默認域名。

返回示例
["ddker.com", "9k3r.com", "uqu.me"]
POST /api/VMEmail_mailcx/generate 累計調用 0 次

生成臨時郵箱

生成一個臨時郵箱地址(僅收信),返回郵箱地址與客戶端標識。

選填:指定後綴域名,缺省使用默認域名 uqu.me

選填:客戶端標識(X-Client-ID);不傳由服務端隨機生成,傳已有值可復用同一身份

  • 請求體為 application/x-www-form-urlencoded 表單。
響應說明 外層統一格式
字段 類型 說明
address string 臨時郵箱地址
domain string 後綴域名
client_id string 客戶端標識,查詢郵件時回傳
返回示例
{"address": "abc123@uqu.me", "domain": "uqu.me", "client_id": "0f8b2e1c-3a4d-4f6e-9c12-7d5a8b3e2f01"}
GET /api/VMEmail_mailcx/emails 累計調用 0 次

獲取郵件列表

拉取指定郵箱的郵件摘要列表(長輪詢,無新郵件時掛起約 25 秒後返回空列表)。

必填:郵箱地址,來自「生成臨時郵箱」的返回值

選填:非負整數時間戳(秒);不傳返回當前全部郵件,傳入後僅返回該時間之後的新郵件

選填:與生成郵箱時的 client_id 保持一致

  • 上遊為長輪詢:無新郵件時會掛起約 25 秒後返回空列表,客戶端 HTTP 超時應大於 35 秒。
  • 完整正文用列表裡的 id 查「獲取郵件詳情」。
響應說明 外層統一格式

data 為上遊 mail.cx 的郵件摘要列表,每項含 id / from_name / from_email / subject / preview_text / preview_status / size / created_at 等字段,以實際返回為準。

GET /api/VMEmail_mailcx/email_detail 累計調用 0 次

獲取郵件詳情

按郵件 id 獲取完整詳情(含完整正文與附件)。

必填:郵件唯一標識(長度上限 128)

選填:與生成郵箱時的 client_id 保持一致

  • 郵件不存在(或已過期,保留約 1 小時)返回 20030。
響應說明 外層統一格式

data 為上遊 mail.cx 返回的郵件詳情原始 JSON,含 id / from / from_email / from_name / to / subject / text_body / html_body / attachments / date / created_at 等字段,以實際返回為準。

小影API · 通用 API 聚合服務