Virtual mailbox (disposable email): generate a random address to receive mail, handy for sign-up verification, integration testing and automation.
/api/VMEmail_mailcx/
The Email Service provides a virtual (disposable) mailbox: a random local address with no sign-up needed that can receive mail — handy for sign-up verification, integration testing and automation. (The former "send email" feature is now merged into the Message Push Service: POST /api/push/email/send.)
This service requires a project signature.
Temporary mailbox polling is long-polling: when there is no new mail the request hangs for about 25 seconds before returning an empty list. This is expected, so do not treat it as a failure based on a short timeout. Mail is retained for a limited time, so retrieve anything important promptly.
Every endpoint returns the same JSON envelope; the payload is always inside data:
{
"code": 10000,
"msg": "成功",
"data": { ... }
}
Judge success by code, not by the HTTP status code. View all error codes
mail.cx temporary mailbox: the address is generated locally at random with no registration, and the address itself is the unique identifier (mail is kept for about 1 hour); the server keeps no session, so queries must send the address back. Requires a project signature.
/api/VMEmail_mailcx/domains
Total calls: 0
Get all currently available suffix domains, used to specify domain when generating a mailbox.
data is a string array of available suffix domains; falls back to the built-in default domains when the upstream fails.
["ddker.com", "9k3r.com", "uqu.me"]
/api/VMEmail_mailcx/generate
Total calls: 0
Generate a temporary mailbox address (receive only) and return the address and the client ID.
Optional: specify the suffix domain; defaults to uqu.me
Optional: client identifier (X-Client-ID); if omitted the server generates one at random, and reusing an existing value reuses the same identity
| Field | Type | Description |
|---|---|---|
| address | string | Temporary email address |
| domain | string | Suffix Domain |
| client_id | string | Client ID, pass it back when fetching emails |
{"address": "abc123@uqu.me", "domain": "uqu.me", "client_id": "0f8b2e1c-3a4d-4f6e-9c12-7d5a8b3e2f01"}
/api/VMEmail_mailcx/emails
Total calls: 0
Fetch the mail summary list of a mailbox (long polling; hangs for about 25 seconds and returns an empty list when there is no new mail).
Required: mailbox address, from the response of Generate Temporary Mailbox
Optional: non-negative integer timestamp (seconds); if omitted all current mail is returned, otherwise only mail newer than that time
Optional: keep it the same as the client_id used when generating the mailbox
data is the email summary list from the upstream mail.cx service; each item contains fields such as id / from_name / from_email / subject / preview_text / preview_status / size / created_at — refer to the actual response.
/api/VMEmail_mailcx/email_detail
Total calls: 0
Get the full detail by mail id (including the complete body and attachments).
Required: unique mail identifier (max length 128)
Optional: keep it the same as the client_id used when generating the mailbox
data is the raw email-detail JSON returned by the upstream mail.cx service, containing fields such as id / from / from_email / from_name / to / subject / text_body / html_body / attachments / date / created_at — refer to the actual response.