快速设置清单

打开您的仪表板API管理页面并创建您的个人API密钥。
复制显示的确切用户API基URL，例如 https://v1.tempmailg.com/api.
将每个请求发送到该API主机，使用 Authorization: Bearer YOUR_USER_API_KEY 和 Accept: application/json.
在同一仪表板页面以及在用户 API 响应中可用的配额标头中跟踪您的每月请求配额。只有成功的 2xx 请求计入配额。

如果 API 返回 404 确保您正在调用专用的用户 API 主机，且调用方式与 API 管理页面中显示的方式完全相同。

API 密钥访问

登录以创建您的个人 API 密钥并查看实时配额详细信息。

登录注册

身份验证流程

从仪表板 API 管理页面生成您的个人 API 密钥。
在每个请求中将密钥作为 Bearer 令牌发送。
使用在 API 管理页面中显示的专用用户 API 基本 URL。
任何时候您想要使旧密钥失效并立即开始使用新密钥时重新生成密钥。

密钥可见性 您的用户 API 密钥将在您重新生成或吊销之前保持在您的 API 管理页面中可见。

必需头部

Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json

速率限制和配额标头

速率限制标头描述指示的请求配额。当配额信息可用时会包含配额标头；分钟限制的拒绝不计算您的完整月度配额。

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1729520000
X-Quota-Limit: 50000
X-Quota-Remaining: 48210
X-Quota-Used: 1790
X-Quota-Reset: 2026-11-01T00:00:00+00:00
X-RateLimit-Scope: account
Retry-After: 42 (when a timed retry is available)

X-RateLimit-Limit — 每分钟允许的最大请求数 (RPM)（适用于您的计划）。
X-RateLimit-Remaining — 当前分钟窗口中剩余的 RPM 请求。
X-RateLimit-Reset — 当前分钟速率限制窗口重置时的 Unix 时间戳。
X-Quota-Limit — 您账户的每月总信用额度和已购买的信用容量。
X-Quota-Remaining — 本月剩余可用的 API 请求次数。
X-Quota-Used — 当前计费周期内已消耗的 API 请求总数。
X-Quota-Reset — 每月配额重置时的 ISO-8601 时间戳。
X-RateLimit-Scope — 预算由以下标题描述：account、ip、status_endpoint 或 mailbox。
X-Mailbox-RateLimit-* — 单独的邮箱创建/更新预算。成功的邮箱响应在 X-RateLimit-* 中保留账户 RPM；仅邮箱的拒绝使用邮箱范围及其自己的重试窗口。
Retry-After — 在适当的时间重试之前的秒数。禁用的计划或配额耗尽可能需要更改账户，因此此标头并不总是出现。
503 protection_unavailable — API 保护存储或协调暂时不可用。请稍后重试；这不是支付失败或信用扣款。

Mailbox Management

Fetch allowed domains, create, update lifetimes, switch, and delete temporary email addresses.

GET https://v1.tempmailg.com/api/domains?type={type}

List Allowed Domains

List available domains for creating temporary emails. Filter by type to see only free, premium, or custom domains supported by your subscription plan.

参数 1

参数	位置	类型	状态	描述
`type`	query	string	可选	Domain tier filter. Allowed values: free, basic, pro, premium, custom, ultimate, all 默认： `free`

获取允许的域

const response = await fetch('https://v1.tempmailg.com/api/domains?type=free', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.get('https://v1.tempmailg.com/api/domains?type=free', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/domains?type=free');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request GET \
  --url 'https://v1.tempmailg.com/api/domains?type=free' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": true,
    "data": {
        "requested_type": "free",
        "plan": "pro",
        "plan_name": "Pro Plan",
        "allowed_types": [
            "free",
            "basic",
            "pro",
            "premium",
            "custom",
            "ultimate",
            "all"
        ],
        "domains": [
            {
                "domain": "example.com",
                "type": "Free",
                "custom": false
            }
        ]
    }
}

POST https://v1.tempmailg.com/api/emails

Create Temporary Mailbox

Create a new temporary email address. By default, a random email address is generated. You can customize the email username, domain, or domain type by providing the appropriate parameters in the JSON request body.

参数 4

参数	位置	类型	状态	描述
`username`	body	string	可选	Custom mailbox username prefix (subject to plan custom username permissions). 默认： `Randomly generated`
`domain`	body	string	可选	One of the allowed domains returned by GET /domains. 默认： `Default allowed domain`
`lifetime`	body	string	可选	Mailbox duration: 10m, 1h, 2h, 1d, 1w, 1m, or unlimited (also accepts mailbox_lifetime or email_lifetime). 默认： `Plan default lifetime`
`provider`	body	string	可选	Mailbox provider: standard, gmail_alias, or outlook_alias. 默认： `standard`

Optional body parameters: username (custom username if allowed by plan), domain (allowed domain, e.g. example.com), lifetime (allowed values: 10m, 1h, 2h, 1d, 1w, 1m, unlimited), provider (standard, gmail_alias, outlook_alias). Omit lifetime, or leave it empty, to use the Default Email Lifetime configured for your current monthly/yearly plan. Send a permitted lifetime such as 1h to override that default. Unlimited is used only when configured as the plan default or explicitly requested and permitted. The body parameters mailbox_lifetime and email_lifetime are also accepted; the first non-empty value wins in this order: lifetime, mailbox_lifetime, email_lifetime. Invalid or disallowed values return HTTP 422 instead of silently selecting a default.

Create mailbox

const response = await fetch('https://v1.tempmailg.com/api/emails', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.post('https://v1.tempmailg.com/api/emails', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/emails');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": true,
    "data": {
        "id": 2301,
        "email": "customuser@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-10-30T06:08:57+00:00",
        "expires_in_seconds": 86400,
        "created_at": "2026-10-29T06:08:57+00:00",
        "email_token": "encrypted-email-token"
    }
}

POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}

Update / Switch Mailbox

Update or switch an existing owned mailbox to a new username and allowed domain. This operation applies only to mailboxes owned by the authenticated user.

参数 4

参数	位置	类型	状态	描述
`email`	path	string	必需	Current full email address of the owned mailbox to switch.
`username`	path	string	必需	New desired username prefix.
`domain`	path	string	必需	New allowed domain name.
`lifetime`	body	string	可选	Optional new mailbox lifetime duration. 默认： `Current remaining / plan default`

使用属于自己的邮箱邮箱 {email}。 Optional body parameter: lifetime (allowed values: 10m, 1h, 2h, 1d, 1w, 1m, unlimited). Omit lifetime, or leave it empty, to use the Default Email Lifetime configured for your current monthly/yearly plan. Send a permitted lifetime such as 1h to override that default. Unlimited is used only when configured as the plan default or explicitly requested and permitted. The body parameters mailbox_lifetime and email_lifetime are also accepted; the first non-empty value wins in this order: lifetime, mailbox_lifetime, email_lifetime. Invalid or disallowed values return HTTP 422 instead of silently selecting a default.

更新属于自己的邮箱

const response = await fetch('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.post('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": true,
    "data": {
        "id": 2302,
        "email": "demo123@example.com",
        "domain": "example.com",
        "expire_at": "2026-10-29T06:18:57+00:00",
        "expires_in_seconds": 600,
        "created_at": "2026-10-29T06:08:57+00:00",
        "email_token": "encrypted-email-token"
    }
}

DELETE https://v1.tempmailg.com/api/emails/{email}

Delete Mailbox

Delete a temporary email address. The email address is immediately marked as expired and soft-deleted, along with all its associated messages.

参数 1

参数	位置	类型	状态	描述
`email`	path	string	必需	Full email address of the owned mailbox to delete.

删除属于自己的邮箱

const response = await fetch('https://v1.tempmailg.com/api/emails/demo123@example.com', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.delete('https://v1.tempmailg.com/api/emails/demo123@example.com', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/emails/demo123@example.com');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": true,
    "message": "Email has been successfully deleted."
}

Gmail 与 Outlook 别名

Generate high-reputation Gmail and Outlook/Hotmail alias mailboxes.

POST https://v1.tempmailg.com/api/gmail-alias/emails

Create Gmail Alias

Create a new Gmail alias temporary mailbox owned by the authenticated user.

参数 4

参数	位置	类型	状态	描述
`mode`	body	string	可选	Generation mode: auto, dot, plus, or plus_word. 默认： `auto`
`username`	body	string	可选	Custom alias username prefix. 默认： `Auto-generated`
`domain`	body	string	可选	Allowed domain: gmail.com or googlemail.com. 默认： `gmail.com`
`lifetime`	body	string	可选	Duration: 10m, 1h, 2h, 1d, 1w, 1m, or unlimited. 默认： `Plan default lifetime`

Requires the Gmail Alias API permission to be enabled on your subscription plan or unlocked via an API Credit package. Optional parameters: mode (auto, dot, plus, plus_word), username (custom alias username), domain (e.g. gmail.com, googlemail.com), lifetime (allowed values: 10m, 1h, 2h, 1d, 1w, 1m, unlimited). Omit lifetime, or leave it empty, to use the Default Email Lifetime configured for your current monthly/yearly plan. Send a permitted lifetime such as 1h to override that default. Unlimited is used only when configured as the plan default or explicitly requested and permitted. The body parameters mailbox_lifetime and email_lifetime are also accepted; the first non-empty value wins in this order: lifetime, mailbox_lifetime, email_lifetime. Invalid or disallowed values return HTTP 422 instead of silently selecting a default.

Create Gmail alias mailbox

const response = await fetch('https://v1.tempmailg.com/api/gmail-alias/emails', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.post('https://v1.tempmailg.com/api/gmail-alias/emails', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/gmail-alias/emails');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request POST \
  --url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": true,
    "data": {
        "id": 2305,
        "email": "myname.alias123@gmail.com",
        "domain": "gmail.com",
        "provider": "gmail_alias",
        "expire_at": "2026-10-29T07:08:58+00:00",
        "expires_in_seconds": 3600,
        "created_at": "2026-10-29T06:08:58+00:00",
        "email_token": "encrypted-email-token"
    }
}

GET https://v1.tempmailg.com/api/outlook-alias/domains

Outlook Alias Domains

Fetch active Outlook / Hotmail alias domains available for mailbox generation.

Requires the Outlook Alias API permission to be enabled on your subscription plan or unlocked via an API Credit package. Indicates whether specific domain selection is unlocked on your plan.

Get Outlook alias domains

const response = await fetch('https://v1.tempmailg.com/api/outlook-alias/domains', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.get('https://v1.tempmailg.com/api/outlook-alias/domains', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/outlook-alias/domains');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request GET \
  --url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": true,
    "data": {
        "domains": [
            {
                "domain": "outlook.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            },
            {
                "domain": "hotmail.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            }
        ]
    }
}

POST https://v1.tempmailg.com/api/outlook-alias/emails

Create Outlook Alias

Create a new Outlook / Hotmail alias temporary mailbox owned by the authenticated user.

参数 3

参数	位置	类型	状态	描述
`domain`	body	string	可选	Target Outlook domain, e.g. outlook.com or hotmail.com. 默认： `First available`
`username`	body	string	可选	Custom alias prefix if allowed by subscription. 默认： `Auto-generated`
`lifetime`	body	string	可选	Duration: 10m, 1h, 2h, 1d, 1w, 1m, or unlimited. 默认： `Plan default lifetime`

Requires the Outlook Alias API permission to be enabled on your subscription plan or unlocked via an API Credit package. Optional parameters: domain (e.g. outlook.com, hotmail.com), username (custom alias username), lifetime (allowed values: 10m, 1h, 2h, 1d, 1w, 1m, unlimited). Omit lifetime, or leave it empty, to use the Default Email Lifetime configured for your current monthly/yearly plan. Send a permitted lifetime such as 1h to override that default. Unlimited is used only when configured as the plan default or explicitly requested and permitted. The body parameters mailbox_lifetime and email_lifetime are also accepted; the first non-empty value wins in this order: lifetime, mailbox_lifetime, email_lifetime. Invalid or disallowed values return HTTP 422 instead of silently selecting a default.

Create Outlook alias mailbox

const response = await fetch('https://v1.tempmailg.com/api/outlook-alias/emails', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.post('https://v1.tempmailg.com/api/outlook-alias/emails', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/outlook-alias/emails');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request POST \
  --url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": true,
    "data": {
        "id": 2306,
        "email": "fastuser_alias45@outlook.com",
        "domain": "outlook.com",
        "provider": "outlook_alias",
        "expire_at": "2026-10-29T07:08:59+00:00",
        "expires_in_seconds": 3600,
        "created_at": "2026-10-29T06:08:59+00:00",
        "email_token": "encrypted-email-token"
    }
}

Messages & Attachments

Fetch incoming inboxes, read full HTML/text messages, and stream attachments.

GET https://v1.tempmailg.com/api/messages?email={email}

List Mailbox Messages

Retrieve all messages from a temporary email inbox. Returns message details, including message ID, sender, subject, received date, read status, and email preview.

参数 1

参数	位置	类型	状态	描述
`email`	query	string	必需	Full email address of the owned mailbox to read messages from.

电子邮件查询参数必须属于已验证的用户账户。

读取邮箱消息

const response = await fetch('https://v1.tempmailg.com/api/messages?email=demo123@example.com', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.get('https://v1.tempmailg.com/api/messages?email=demo123@example.com', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/messages?email=demo123@example.com');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages?email=demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": true,
    "mailbox": "randombox@example.com",
    "messages": [
        {
            "is_seen": false,
            "subject": "Welcome to Temp Mail",
            "from": "Example Sender",
            "from_email": "hello@example.org",
            "to": "randombox@example.com",
            "receivedAt": "2026-10-29 06:08:59",
            "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
            "html": true,
            "content": "<p>Hello from the inbox.</p>",
            "attachments": [
                {
                    "name": "file.txt",
                    "extension": "txt",
                    "size": 91,
                    "url": "https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt"
                }
            ]
        }
    ]
}

GET https://v1.tempmailg.com/api/messages/{messageId}

Get Single Message

Retrieve a specific email message by its ID (`hash_id`). Returns the full message content, including the HTML body and attachments.

参数 1

参数	位置	类型	状态	描述
`messageId`	path	string	必需	Unique message ID returned in the message list.

读取一条消息

const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.get('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": true,
    "data": {
        "is_seen": true,
        "subject": "Welcome to Temp Mail",
        "from": "Example Sender",
        "from_email": "hello@example.org",
        "to": "randombox@example.com",
        "receivedAt": "2026-10-29 06:08:59",
        "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
        "html": true,
        "content": "<p>Hello from the inbox.</p>",
        "attachments": [
            {
                "name": "file.txt",
                "extension": "txt",
                "size": 91,
                "url": "https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt"
            }
        ]
    }
}

DELETE https://v1.tempmailg.com/api/messages/{messageId}

删除消息

删除一个属于自己的消息。

参数 1

参数	位置	类型	状态	描述
`messageId`	path	string	必需	Unique message ID string to permanently delete.

删除一条消息

const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.delete('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": true,
    "message": "Message was deleted successfully."
}

GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}

Download Attachment

从属于自己的消息中下载附件。

参数 2

参数	位置	类型	状态	描述
`messageId`	path	string	必需	ID of the message containing the file.
`filename`	path	string	必需	Filename and extension of the attachment to download.

This endpoint downloads the file directly. Downloads are subject to the maximum attachment size (MB) limit configured for your plan; oversized files return HTTP 403.

下载附件

const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const blob = await response.blob();
const downloadUrl = window.URL.createObjectURL(blob);
const link = document.createElement('a');
link.href = downloadUrl;
link.download = 'file.txt';
document.body.appendChild(link);
link.click();
link.remove();
window.URL.revokeObjectURL(downloadUrl);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.get('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt', headers=headers, stream=True, timeout=30)
response.raise_for_status()

with open('file.txt', 'wb') as handle:
    for chunk in response.iter_content(chunk_size=8192):
        if chunk:
            handle.write(chunk)

<?php

$fileHandle = fopen('file.txt', 'w');
$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_FILE => $fileHandle,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

if (curl_exec($ch) === false) {
    fclose($fileHandle);
    throw new RuntimeException(curl_error($ch));
}

curl_close($ch);
fclose($fileHandle);

curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY' \
  --output file.txt

下载行为 此端点直接返回请求的文件，而不是 JSON 正文。

Rate Limits & Quotas

Monitor real-time request budgets, rate limits, and account quotas without consuming credits.

GET https://v1.tempmailg.com/api/rate-limit

Rate Limit & Quota

Check your current rate limit and quota status without consuming any API usage. This endpoint is quota-free and does not deduct monthly API credits (abuse protection limit: 60 requests/min).

X-RateLimit-* describes the indicated request budget; X-Quota-* describes monthly and purchased capacity when available. X-Mailbox-RateLimit-* reports the separate mailbox creation/update budget. A mailbox-only rejection uses mailbox scope and its own retry window. Minute-limit rejections may omit quota information. Retry-After is included only for a timed retry; disabled access may require an account change. In this successful status response, data.limit, data.remaining and data.reset describe the account minute budget, not spendable credits. The data.quota object describes monthly allowance, credit balances and usage. The existing data.monthly_limit, data.monthly_remaining and data.purchased_credits fields remain aliases of the corresponding quota fields. A successful status check does not authorize another API operation. Operations still require enabled access, available quota and admission through all applicable limits. The quota snapshot does not promise capacity already reserved by an in-progress request.

Check rate limit status

const response = await fetch('https://v1.tempmailg.com/api/rate-limit', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.get('https://v1.tempmailg.com/api/rate-limit', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/rate-limit');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request GET \
  --url 'https://v1.tempmailg.com/api/rate-limit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

示例响应

200 OK • JSON

{
    "status": "success",
    "data": {
        "limit": 60,
        "remaining": 45,
        "reset": 32,
        "plan": "premium",
        "monthly_limit": 50000,
        "monthly_remaining": 48210,
        "purchased_credits": 5000,
        "quota": {
            "enabled": true,
            "user_api_status": true,
            "plan_name": "Premium Plan",
            "period": "2026-10",
            "base_limit": 50000,
            "extra_requests": 0,
            "monthly_limit": 50000,
            "monthly_remaining": 48210,
            "used": 1790,
            "purchased_credits": 5000,
            "bonus_credits": 1000,
            "direct_purchased_credits": 4000,
            "remaining": 53210,
            "unlimited": false,
            "usage_percent": 3,
            "reset_at": "2026-11-01T00:00:00+00:00"
        }
    }
}

响应字段

字段	类型	描述
`data.limit`	integer\|string	Account requests-per-minute limit. The string unlimited denotes an unlimited minute budget; this is independent of monthly quota.
`data.remaining`	integer\|string	Remaining account minute-budget slots, or the string unlimited. A positive value does not mean that API credits remain.
`data.reset`	integer	Seconds for the account minute window, not the monthly quota reset. Disabled or unlimited minute budgets can retain a nominal 60-second value; this does not promise access after waiting.
`data.plan`	string	Current plan tag. The readable plan name is provided separately in data.quota.plan_name.
`data.quota.enabled`	boolean	Whether global and plan/credit API access is enabled. This does not indicate remaining capacity or replace the user API switch.
`data.quota.user_api_status`	boolean	Whether the user has enabled their User API switch. Operations require this switch as well as enabled access and available capacity.
`data.quota.plan_name`	string	Readable name of the current plan.
`data.quota.period`	string	Calendar-month usage period in YYYY-MM format, using the application timezone; not necessarily the subscription billing period.
`data.quota.base_limit`	integer	Base monthly plan allowance. A value of -1 means unlimited.
`data.quota.extra_requests`	integer	Additional monthly allowance granted for the current usage period; separate from purchased credits.
`data.quota.monthly_limit`	integer	Base allowance plus current-period extra requests. A value of -1 means unlimited. Purchased credits are not included.
`data.quota.monthly_remaining`	integer\|null	Remaining finite monthly allowance, or null when monthly quota is unlimited. Null must not be interpreted as zero.
`data.quota.used`	integer	Successful, counted API operations in the current usage period, including operations using credits. Status checks do not increase this value.
`data.quota.purchased_credits`	integer	Current credit balance, including active plan bonus credits. Bonus credits must not be added to this balance a second time.
`data.quota.bonus_credits`	integer	Active plan-bonus portion of the credit balance; a breakdown of purchased_credits, not additional capacity.
`data.quota.direct_purchased_credits`	integer	Credit balance excluding the active plan-bonus portion. This value plus bonus_credits equals purchased_credits.
`data.quota.remaining`	integer\|null	Monthly remaining allowance plus the current credit balance, without double-counting bonuses. Null means unlimited monthly quota. Individual feature permissions and other request limits still apply.
`data.quota.unlimited`	boolean	Whether monthly quota is unlimited. This does not make the account minute budget or other feature limits unlimited.
`data.quota.usage_percent`	integer	Dashboard-compatible rounded percentage from 0 to 100: used divided by used plus remaining, multiplied by 100. It includes available credit capacity, so recharging can lower the percentage. It is 0 for unlimited quota or a zero-sized pool; it is not the minute rate-limit percentage or an access decision.
`data.quota.reset_at`	string	ISO-8601 timestamp with timezone offset for the next calendar-month quota reset. This is not the subscription expiry date, and the monthly reset does not refill purchased credits.

邮箱网钩（实时推送）

不必反复轮询 REST API（GET /messages）来检查收到的邮件，而是可以配置 Webhook 将新邮件实时推送到您的服务器或自动化工作流程。

登录以设置网络钩子

协议 HTTPS POST

有效载荷格式 JSON

安全性 HMAC-SHA256

可用性付费计划

支持的 Webhook 事件

每个 webhook 可以订阅一个或多个事件类型。当其中任意触发器触发时，您的端点会收到事件通知。

email.received 收到新邮件

Dispatched in real time whenever a new message reaches the selected mailbox.

mailbox.expired Mailbox Expired

Dispatched when the temporary mailbox expires and webhook processing is paused.

mailbox.reactivated Mailbox Reactivated

Dispatched when an expired mailbox becomes active again under plan rules.

mailbox.deleted Mailbox Deleted

Dispatched right before the webhook and its mailbox are deleted.

请求头部与 HMAC 签名验证

每个网钩（webhook）传递都包含特殊的安全头部。使用 **X-TempMailg-Signature** 头部验证，以确保收到的请求确实由 TempMailg 合法发送，且未被篡改。

标题名称	示例值	描述
`User-Agent`	TempMailg-Webhooks/1.0	Standard identifier for the webhook delivery worker.
`X-TempMailg-Event`	email.received	The type of event that triggered this delivery.
`X-TempMailg-Event-Id`	e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c	Unique UUID assigned to this delivery attempt.
`X-TempMailg-Timestamp`	1725192000	Unix epoch timestamp indicating when the request was initiated.
`X-TempMailg-Signature`	sha256=d7a8fbb307d7809469ca933b02d82941...	HMAC-SHA256 signature calculated from {timestamp}.{raw_body} using your secret.
`X-TempMailg-Test`	false	True when dispatched by the "Send Test Ping" feature in your dashboard.

签名验证的工作原理

签名是通过 HMAC 使用 SHA256 对字符串计算得到的： hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)

在验证签名之前始终使用端点的原始请求体字节，而不是解析 JSON。

示例事件有效载荷（email.received）

以 application/json 格式在 HTTP POST 请求体中发送

{
    "id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
    "version": "1.0",
    "event": "email.received",
    "occurred_at": "2026-10-29T06:09:03+00:00",
    "test": false,
    "mailbox": {
        "id": 1024,
        "email": "developer@v1.tempmailg.com"
    },
    "data": {
        "message_id": "7a8b9c0d1e2f",
        "subject": "Your Verification Code: 948201",
        "from": "auth@service.com",
        "to": "developer@v1.tempmailg.com",
        "date": "2026-10-29T06:09:03+00:00",
        "attachments_count": 0,
        "text_preview": "Hello, your one-time verification code is 948201. It will expire in 10 minutes.",
        "email_url": "https://tempmailg.com/mailbox/1024?message=7a8b9c0d1e2f",
        "inbox_url": "https://tempmailg.com/mailbox/1024"
    }
}

接收器实现示例

选择您的语言以查看如何安全地接收 webhook 并验证 HMAC 签名。

const express = require('express');
const crypto = require('crypto');

const app = express();
const WEBHOOK_SECRET = 'your_webhook_signing_secret';

// Capture raw body buffer for HMAC-SHA256 signature verification
app.use(express.json({
  verify: (req, res, buf) => {
    req.rawBody = buf.toString('utf8');
  }
}));

app.post('/webhook', (req, res) => {
  const timestamp = req.headers['x-tempmailg-timestamp'];
  const signatureHeader = req.headers['x-tempmailg-signature'] || '';

  // Calculate HMAC-SHA256 signature
  const expectedSignature = 'sha256=' + crypto
    .createHmac('sha256', WEBHOOK_SECRET)
    .update(`${timestamp}.${req.rawBody}`)
    .digest('hex');

  // Verify signature
  if (signatureHeader !== expectedSignature) {
    return res.status(401).json({ error: 'Invalid webhook signature' });
  }

  const { event, mailbox, data } = req.body;
  console.log(`[Event: ${event}] Mailbox: ${mailbox.email}`);

  if (event === 'email.received') {
    console.log(`From: ${data.from}`);
    console.log(`Subject: ${data.subject}`);
    console.log(`Preview: ${data.text_preview}`);
  }

  // Acknowledge receipt with HTTP 200
  res.status(200).json({ received: true });
});

app.listen(3000, () => console.log('Webhook receiver running on port 3000'));

from flask import Flask, request, jsonify
import hmac
import hashlib

app = Flask(__name__)
WEBHOOK_SECRET = b"your_webhook_signing_secret"

@app.route("/webhook", methods=["POST"])
def handle_webhook():
    timestamp = request.headers.get("X-TempMailg-Timestamp", "")
    signature_header = request.headers.get("X-TempMailg-Signature", "")

    # Calculate expected HMAC-SHA256 signature
    raw_body = request.get_data()
    signed_payload = f"{timestamp}.".encode("utf-8") + raw_body
    expected_signature = "sha256=" + hmac.new(
        WEBHOOK_SECRET, signed_payload, hashlib.sha256
    ).hexdigest()

    # Verify signature securely
    if not hmac.compare_digest(signature_header, expected_signature):
        return jsonify({"error": "Invalid signature"}), 401

    payload = request.get_json()
    event = payload.get("event")
    mailbox = payload.get("mailbox", {}).get("email")
    data = payload.get("data", {})

    print(f"[{event}] Mailbox: {mailbox}")
    if event == "email.received":
        print(f"From: {data.get('from')}")
        print(f"Subject: {data.get('subject')}")
        print(f"Preview: {data.get('text_preview')}")

    # Return 200 OK to acknowledge receipt
    return jsonify({"received": True}), 200

if __name__ == "__main__":
    app.run(port=5000)

<?php

$secret = 'your_webhook_signing_secret';
$rawBody = file_get_contents('php://input');
$timestamp = $_SERVER['HTTP_X_TEMPMAILG_TIMESTAMP'] ?? '';
$receivedSignature = $_SERVER['HTTP_X_TEMPMAILG_SIGNATURE'] ?? '';

// Calculate HMAC-SHA256 signature
$expectedSignature = 'sha256=' . hash_hmac('sha256', $timestamp . '.' . $rawBody, $secret);

// Verify signature
if (!hash_equals($expectedSignature, $receivedSignature)) {
    http_response_code(401);
    echo json_encode(['error' => 'Invalid signature']);
    exit;
}

$payload = json_decode($rawBody, true);
$event = $payload['event'] ?? '';
$mailbox = $payload['mailbox']['email'] ?? '';
$data = $payload['data'] ?? [];

if ($event === 'email.received') {
    $sender = $data['from'] ?? '';
    $subject = $data['subject'] ?? '';
    $preview = $data['text_preview'] ?? '';
    // Process new incoming email...
}

// Acknowledge receipt
http_response_code(200);
echo json_encode(['received' => true]);

受支持的平台和自动化集成

TempMailg Webhooks 开箱即用，支持标准 HTTPS 端点和领先的无代码/自动化平台：

Custom HTTP POST / JSON Discord Slack Mattermost Microsoft Teams Google Chat Zapier Make.com Pipedream n8n much more

常见错误和故障排除

这些是您在集成用户 API 时可能看到的最常见的响应代码。

纯文本响应而非 JSON 类似 \"Cannot GET /\" 的响应并不是成功的用户 API 响应，即使其状态码是 200。请检查完整的请求 URL，并保留 Base URL 中显示的 API 路径。

401 Unauthorized

无效或缺少Bearer令牌。

403 Forbidden

当前用户计划禁用了用户API访问。

404 Not Found

资源未在允许的主机上找到，或不属于用户。

410 Gone / Expired

邮箱已过期或不活动。

422 Validation Error

验证失败或请求的邮箱/域不允许。

429 Rate Limited / Quota Exhausted

A request limit, disabled plan, exhausted quota, or cooldown prevented the operation. Check the reason and available budget headers. Retry-After is optional.

503 API Protection Temporarily Unavailable

Protection storage or coordination could not be verified. Retry after the indicated delay. This response is not a failed payment.

快速清单

401 Unauthorized - Bearer 令牌缺失、错误、吊销或复制错误。
403 Forbidden - 当前计划不具备用户 API 访问权限。
404 Not Found - 资源未找到或参数无效
410 Gone / Expired - 邮箱已过期或不再活跃。
429 Rate Limited - 已达到月度信用限额 — 购买信用或等待重置