クイックセットアップチェックリスト
- ダッシュボードのAPI管理ページを開き、個人用APIキーを作成します。
- そこに表示される正確なユーザーAPIベースURLをコピーします。例: https://v1.tempmailg.com/api.
- すべてのリクエストをそのAPIホストに送信します Authorization: Bearer YOUR_USER_API_KEY および Accept: application/json.
- 同じダッシュボードページと、ユーザーAPIレスポンスで利用可能な場合はクオータヘッダーから、月間リクエストクォータを追跡します。成功した2xxリクエストのみがクオータにカウントされます。
認証フロー
- ダッシュボードのAPI Managementページから、個人のAPIキーを生成します。
- すべてのリクエストで、キーをBearerトークンとして送信します。
- API Managementページに表示される専用のユーザーAPIベースURLを使用します。
- 古いキーを無効にし、新しいキーをすぐに使用開始するために、いつでもキーを再生成します。
必須ヘッダー
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— プランで許可されている1分あたりの最大リクエスト数 (RPM)。X-RateLimit-Remaining— 現在の1分ウィンドウで残っているRPMリクエスト数。X-RateLimit-Reset— 現在の1分レートリミットウィンドウがリセットされる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保護ストレージまたは調整は一時的に利用できません。後でもう一度お試しください; これは支払い失敗やクレジットデビットではありません。
メールボックス管理
許可されたドメインを取得し、メールボックスを作成または切り替え、許可された有効期限を選択し、所有するアドレスを削除します。
許可されたドメインの一覧
一時的なメールを作成するために利用可能なドメインを一覧表示します。タイプでフィルタリングすると、サブスクリプションプランでサポートされている無料、プレミアム、またはカスタムドメインのみが表示されます。
| パラメータ | 場所 | 種類 | ステータス | 説明 |
|---|---|---|---|---|
type
|
query | string | 任意 |
ドメイン階層フィルター。省略時は、プレミアムドメインアクセスが有効な場合はすべて、そうでなければ無料を使用します。認識される値: free, basic, pro, premium, custom, ultimate, all
デフォルト:
アカウント依存
|
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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
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
}
]
}
}
| フィールド | 種類 | 説明 |
|---|---|---|
status |
boolean | 操作が成功したかどうか。 |
data.requested_type |
string | ドメインフィルタが適用されました。 |
data.plan |
string | 現在のプランタグ。 |
data.plan_name |
string | 現在のプランの読みやすい名前。 |
data.allowed_types |
array<string> | このアカウントで利用可能なドメインフィルタ。認識されたフィルタでも、プランによっては使用できない場合があります。 |
data.domains |
array | フィルタリング後の選択可能なドメイン;空の配列は有効です。 |
data.domains[].domain |
string | 選択可能なドメイン名。 |
data.domains[].type |
string | 読み取り可能なドメイン階層ラベル。 |
data.domains[].custom |
boolean | これはカスタムドメインかどうか。 |
一時的なメールボックスを作成
所有された一時メールボックスを作成します。ランダム生成のためにユーザー名とドメインを省略するか、許可されたカスタムユーザー名と許可されたドメインを指定してください。provider パラメータで Gmail または Outlook のエイリアス生成を選択できます。
| パラメータ | 場所 | 種類 | ステータス | 説明 |
|---|---|---|---|---|
username
|
body | string | 任意 |
オプションのカスタムユーザー名: 2〜64 文字の ASCII の英字、数字、ドット、アンダースコア、またはハイフン。プランの権限が必要です; custom_username も受け付けられます。
デフォルト:
ランダムに生成された
|
domain
|
body | string | 任意 |
GET /domainsで返される許可されたドメインの1つです。省略するとランダムな許可ドメインが選択されます。
デフォルト:
ランダムに許可されたドメイン
|
lifetime
|
body | string | 任意 |
許可される値:
10m — 10 分間
1h — 1時間
2h — 2時間
1d — 1日
1w — 1 週間
1m — 30日間
3m — 90 日
6m — 180日間
1y — 365日間
unlimited — 無制限
デフォルト:
プランのデフォルト有効期間
|
provider
|
body | string | 任意 |
メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。
デフォルト:
standard
|
pin_enabled
|
body | boolean | 任意 |
プランで許可されている場合、新しいメールボックスにオプションの PIN 保護を設定できます。既存のメールボックスの PIN は変更されません。
デフォルト:
false
|
pin
|
body | string | 任意 |
pin_enabled が true の場合に必須: 先頭のゼロを保持するために文字列として送信される、6〜8 桁の PIN。
|
pin_confirmation
|
body | string | 任意 |
pin_enabled が true の場合に必須です。pin と完全に一致する必要があります。
|
Idempotency-Key
|
header | string | 任意 |
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
|
username (プランで許可されている場合のカスタムユーザー名), domain (許可されたドメイン、例: example.com), lifetime (許可される値: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). ライフタイムを省略するか空欄のままにすると、現在の月額/年額プランで設定されたデフォルトのメールライフタイムが使用されます。デフォルトを上書きするには、1h などの許可されたライフタイムを送信してください。Unlimited は、プランのデフォルトとして設定されている場合、または明示的に要求され許可された場合にのみ使用されます。 ボディパラメータ mailbox_lifetime と email_lifetime も受け付けられます; 最初の空でない値が次の順序で優先されます: lifetime, mailbox_lifetime, email_lifetime. 無効または許可されていない値は、デフォルトを黙って選択する代わりに HTTP 422 を返します。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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
200 OK • JSON{
"status": true,
"data": {
"id": 2301,
"pin_protected": false,
"email": "demo123@example.com",
"domain": "example.com",
"provider": "standard",
"expire_at": "2026-11-20T02:18:00+00:00",
"expires_in_seconds": 86399.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:00+00:00",
"email_token": "encrypted-email-token"
}
}
| フィールド | 種類 | 説明 |
|---|---|---|
status |
boolean | 操作が成功したかどうか。 |
data.id |
integer | メールボックス ID。生成された ID、アドレス、トークンはメールボックスごとに異なります。 |
data.pin_protected |
boolean | このメールボックスがPIN保護されているかどうか。PINやPINハッシュは返されません。 |
data.email |
string | 完全なメールボックスアドレスが生成されました。 |
data.domain |
string | 生成されたメールボックスのドメイン。 |
data.provider |
string | メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。 |
data.expire_at |
string|null | 有効期限は ISO-8601 タイムスタンプとして、無制限のメールボックスの場合は null です。 |
data.expires_in_seconds |
number|null | 計算時の残り秒数は負でないです;小数秒も可能です。null はゼロではなく無制限を意味します。 |
data.mailbox_state |
string | 現在のメールボックスの状態: アクティブ、ポーズ中、期限切れ、または非アクティブ。 |
data.receiving_enabled |
boolean | このメールボックスが現在受信メッセージを受け付けているかどうか。 |
data.message_count |
integer | 既知の総メッセージ数;最後のメールボックス同期を反映することがあります。 |
data.unread_message_count |
integer | 既知の未読メッセージ数; 最後のメールボックス同期を反映することがあります。 |
data.last_message_received_at |
string|null | ISO-8601形式の最後に知られている受信メッセージの時間、利用できない場合はnull。 |
data.message_count_synced_at |
string|null | ISO-8601形式の最終メッセージ数同期時刻、同期前はnullです。 |
data.created_at |
string|null | メールボックスの作成時間(ISO-8601形式)。 |
data.email_token |
string | 不透明な暗号化メールボックス参照です。Bearer認証、所有権チェック、またはPIN認証の代わりにはなりません。 |
data.pin_grant |
object | 条件付き: アクティブなPIN保護メールボックスの作成はこの読み取り権限を返します; 通常の保護されていない作成はそれを省略します。 |
data.pin_grant.mailbox_id |
integer | 条件付き読み取り権限がバインドされているメールボックスID。 |
data.pin_grant.unlock_token |
string | 同じ所有者の資格情報を使用した X-Mailbox-Unlock 用の不透明な読み取りトークンです。プライベートに保ち、メモリ内に保持してください; 読み取り権限は削除を許可しません。 |
data.pin_grant.scope |
string | 条件付き作成権限のために読み取られるスコープ。 |
data.pin_grant.idle_timeout_seconds |
integer | 読み取り権限の許容アイドル時間は、通常3600秒です。 |
data.pin_grant.absolute_timeout_seconds |
integer | 読み取り権限の最大有効期間は、通常86400秒です。 |
data.pin_grant.expires_at |
string | ISO-8601 形式の現在の読み取り権限の有効期限。 |
data.pin_grant.absolute_expires_at |
string | ISO-8601形式の絶対的な読み取り権限の有効期限。セキュリティの変更により、権限が早期に取り消されることがあります。 |
メールボックスを更新 / 切り替え
現在のメールボックスの所有権を確認した後、新しいユーザー名とドメインでメールボックスを作成または選択します。これは古いメールボックスの名前を変更したり、存続期間をその場で変更したりするものではありません。宛先が異なる場合、古いメールボックスは履歴に残り、アクティブメールボックスの上限により一時停止されることがあります。自分のアクティブな宛先を再利用すると、要求された存続期間またはプランのデフォルトが再適用されます。
| パラメータ | 場所 | 種類 | ステータス | 説明 |
|---|---|---|---|---|
email
|
path | string | 必須 |
切り替える所有メールボックスの現在の完全なメールアドレス。各パスセグメントをURLエンコードしてください; プラス記号は %2B とエンコードします。
|
username
|
path | string | 必須 |
新しい希望のユーザー名: 2〜64 文字の英数字; カスタムユーザー名権限の対象となります。
|
domain
|
path | string | 必須 |
新しい許可されたドメイン名。
|
lifetime
|
body | string | 任意 |
許可される値:
10m — 10 分間
1h — 1時間
2h — 2時間
1d — 1日
1w — 1 週間
1m — 30日間
3m — 90 日
6m — 180日間
1y — 365日間
unlimited — 無制限
デフォルト:
プランのデフォルト有効期間
|
pin_enabled
|
body | boolean | 任意 |
プランで許可されている場合、新しいメールボックスにオプションの PIN 保護を設定できます。既存のメールボックスの PIN は変更されません。
デフォルト:
false
|
pin
|
body | string | 任意 |
pin_enabled が true の場合に必須: 先頭のゼロを保持するために文字列として送信される、6〜8 桁の PIN。
|
pin_confirmation
|
body | string | 任意 |
pin_enabled が true の場合に必須です。pin と完全に一致する必要があります。
|
Idempotency-Key
|
header | string | 任意 |
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
|
X-Mailbox-Unlock
|
header | string | 任意 |
ヘッダー、保護されたメールボックスのみ: 読み取り用の unlock_token を使用してください。最初に PIN と scope=read を PIN アンロック URL に POST してください。通常の Bearer 認証はそのまま保持してください。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
lifetime(許容値: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited)。 ライフタイムを省略するか空欄のままにすると、現在の月額/年額プランで設定されたデフォルトのメールライフタイムが使用されます。デフォルトを上書きするには、1h などの許可されたライフタイムを送信してください。Unlimited は、プランのデフォルトとして設定されている場合、または明示的に要求され許可された場合にのみ使用されます。 ボディパラメータ mailbox_lifetime と email_lifetime も受け付けられます; 最初の空でない値が次の順序で優先されます: lifetime, mailbox_lifetime, email_lifetime. 無効または許可されていない値は、デフォルトを黙って選択する代わりに HTTP 422 を返します。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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
200 OK • JSON{
"status": true,
"data": {
"id": 2302,
"pin_protected": false,
"email": "demo123@example.com",
"domain": "example.com",
"provider": "standard",
"expire_at": "2026-11-19T02:28:00+00:00",
"expires_in_seconds": 599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:00+00:00",
"email_token": "encrypted-email-token"
}
}
| フィールド | 種類 | 説明 |
|---|---|---|
status |
boolean | 操作が成功したかどうか。 |
data.id |
integer | メールボックス ID。生成された ID、アドレス、トークンはメールボックスごとに異なります。 |
data.pin_protected |
boolean | このメールボックスがPIN保護されているかどうか。PINやPINハッシュは返されません。 |
data.email |
string | 完全なメールボックスアドレスが生成されました。 |
data.domain |
string | 生成されたメールボックスのドメイン。 |
data.provider |
string | メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。 |
data.expire_at |
string|null | 有効期限は ISO-8601 タイムスタンプとして、無制限のメールボックスの場合は null です。 |
data.expires_in_seconds |
number|null | 計算時の残り秒数は負でないです;小数秒も可能です。null はゼロではなく無制限を意味します。 |
data.mailbox_state |
string | 現在のメールボックスの状態: アクティブ、ポーズ中、期限切れ、または非アクティブ。 |
data.receiving_enabled |
boolean | このメールボックスが現在受信メッセージを受け付けているかどうか。 |
data.message_count |
integer | 既知の総メッセージ数;最後のメールボックス同期を反映することがあります。 |
data.unread_message_count |
integer | 既知の未読メッセージ数; 最後のメールボックス同期を反映することがあります。 |
data.last_message_received_at |
string|null | ISO-8601形式の最後に知られている受信メッセージの時間、利用できない場合はnull。 |
data.message_count_synced_at |
string|null | ISO-8601形式の最終メッセージ数同期時刻、同期前はnullです。 |
data.created_at |
string|null | メールボックスの作成時間(ISO-8601形式)。 |
data.email_token |
string | 不透明な暗号化メールボックス参照です。Bearer認証、所有権チェック、またはPIN認証の代わりにはなりません。 |
data.pin_grant |
object | 条件付き: アクティブなPIN保護メールボックスの作成はこの読み取り権限を返します; 通常の保護されていない作成はそれを省略します。 |
data.pin_grant.mailbox_id |
integer | 条件付き読み取り権限がバインドされているメールボックスID。 |
data.pin_grant.unlock_token |
string | 同じ所有者の資格情報を使用した X-Mailbox-Unlock 用の不透明な読み取りトークンです。プライベートに保ち、メモリ内に保持してください; 読み取り権限は削除を許可しません。 |
data.pin_grant.scope |
string | 条件付き作成権限のために読み取られるスコープ。 |
data.pin_grant.idle_timeout_seconds |
integer | 読み取り権限の許容アイドル時間は、通常3600秒です。 |
data.pin_grant.absolute_timeout_seconds |
integer | 読み取り権限の最大有効期間は、通常86400秒です。 |
data.pin_grant.expires_at |
string | ISO-8601 形式の現在の読み取り権限の有効期限。 |
data.pin_grant.absolute_expires_at |
string | ISO-8601形式の絶対的な読み取り権限の有効期限。セキュリティの変更により、権限が早期に取り消されることがあります。 |
メールボックスを削除
所有しているメールボックスを削除し、そのメッセージとファイルのクリーンアップを実行します。保持されたメールボックスレコードは内部的にソフトデリートされる可能性があり、アドレスは API からは使用できなくなります。
| パラメータ | 場所 | 種類 | ステータス | 説明 |
|---|---|---|---|---|
email
|
path | string | 必須 |
削除する所有メールボックスの完全なメールアドレス。アドレスは URL エンコードしてください;プラス記号は %2B とエンコードします。
|
X-Mailbox-Unlock
|
header | string | 任意 |
ヘッダー、保護されたメールボックスのみ:ワンタイム削除用 unlock_token を使用してください。最初に PIN を POST し、scope=delete と 423 応答で返される action/target_id を PIN アンロック URL に送ります。読み取りトークンでは削除できません。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | 任意 |
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
|
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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
| フィールド | 種類 | 説明 |
|---|---|---|
status |
boolean | 操作が成功したかどうか。 |
message |
string | 削除の結果。リソースが見つからない場合は HTTP 404 が返されます。 |
Gmail と Outlook エイリアス
高評価の Gmail および Outlook/Hotmail エイリアスメールボックスを生成します。
Gmail エイリアスを作成
認証されたユーザーが所有する新しい Gmail エイリアスの一時メールボックスを作成する。
| パラメータ | 場所 | 種類 | ステータス | 説明 |
|---|---|---|---|---|
mode
|
body | string | 任意 |
生成モード: auto、dot、plus、または plus_dot。gmail_alias_mode も受け付けます。スタイル選択が許可されていない場合は、auto が使用されます。
デフォルト:
auto
|
username
|
body | string | 任意 |
オプションのカスタムエイリアスサフィックス: 2〜32文字のASCII文字または数字で、小文字に正規化されます; 機能権限の対象です。また、custom_username または alias_username を受け付けます。
デフォルト:
自動生成
|
domain
|
body | string | 任意 |
ランダム、gmail.com または googlemail.com を使用してください; alias_domain も受け入れられます。省略または利用できないドメイン選択権限はランダムを使用します。
デフォルト:
random
|
lifetime
|
body | string | 任意 |
許可される値:
10m — 10 分間
1h — 1時間
2h — 2時間
1d — 1日
1w — 1 週間
1m — 30日間
3m — 90 日
6m — 180日間
1y — 365日間
unlimited — 無制限
デフォルト:
プランのデフォルト有効期間
|
pin_enabled
|
body | boolean | 任意 |
プランで許可されている場合、新しいメールボックスにオプションの PIN 保護を設定できます。既存のメールボックスの PIN は変更されません。
デフォルト:
false
|
pin
|
body | string | 任意 |
pin_enabled が true の場合に必須: 先頭のゼロを保持するために文字列として送信される、6〜8 桁の PIN。
|
pin_confirmation
|
body | string | 任意 |
pin_enabled が true の場合に必須です。pin と完全に一致する必要があります。
|
Idempotency-Key
|
header | string | 任意 |
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
|
mode (auto, dot, plus, plus_dot), username (カスタムエイリアスユーザー名), domain (例: gmail.com, googlemail.com), lifetime (許可される値: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). ライフタイムを省略するか空欄のままにすると、現在の月額/年額プランで設定されたデフォルトのメールライフタイムが使用されます。デフォルトを上書きするには、1h などの許可されたライフタイムを送信してください。Unlimited は、プランのデフォルトとして設定されている場合、または明示的に要求され許可された場合にのみ使用されます。 ボディパラメータ mailbox_lifetime と email_lifetime も受け付けられます; 最初の空でない値が次の順序で優先されます: lifetime, mailbox_lifetime, email_lifetime. 無効または許可されていない値は、デフォルトを黙って選択する代わりに HTTP 422 を返します。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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
200 OK • JSON{
"status": true,
"data": {
"id": 2305,
"pin_protected": false,
"email": "example+alias123@gmail.com",
"domain": "gmail.com",
"provider": "gmail_alias",
"expire_at": "2026-11-19T03:18:00+00:00",
"expires_in_seconds": 3599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:00+00:00",
"email_token": "encrypted-email-token"
}
}
| フィールド | 種類 | 説明 |
|---|---|---|
status |
boolean | 操作が成功したかどうか。 |
data.id |
integer | メールボックス ID。生成された ID、アドレス、トークンはメールボックスごとに異なります。 |
data.pin_protected |
boolean | このメールボックスがPIN保護されているかどうか。PINやPINハッシュは返されません。 |
data.email |
string | 完全なメールボックスアドレスが生成されました。 |
data.domain |
string | 生成されたメールボックスのドメイン。 |
data.provider |
string | メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。 |
data.expire_at |
string|null | 有効期限は ISO-8601 タイムスタンプとして、無制限のメールボックスの場合は null です。 |
data.expires_in_seconds |
number|null | 計算時の残り秒数は負でないです;小数秒も可能です。null はゼロではなく無制限を意味します。 |
data.mailbox_state |
string | 現在のメールボックスの状態: アクティブ、ポーズ中、期限切れ、または非アクティブ。 |
data.receiving_enabled |
boolean | このメールボックスが現在受信メッセージを受け付けているかどうか。 |
data.message_count |
integer | 既知の総メッセージ数;最後のメールボックス同期を反映することがあります。 |
data.unread_message_count |
integer | 既知の未読メッセージ数; 最後のメールボックス同期を反映することがあります。 |
data.last_message_received_at |
string|null | ISO-8601形式の最後に知られている受信メッセージの時間、利用できない場合はnull。 |
data.message_count_synced_at |
string|null | ISO-8601形式の最終メッセージ数同期時刻、同期前はnullです。 |
data.created_at |
string|null | メールボックスの作成時間(ISO-8601形式)。 |
data.email_token |
string | 不透明な暗号化メールボックス参照です。Bearer認証、所有権チェック、またはPIN認証の代わりにはなりません。 |
data.pin_grant |
object | 条件付き: アクティブなPIN保護メールボックスの作成はこの読み取り権限を返します; 通常の保護されていない作成はそれを省略します。 |
data.pin_grant.mailbox_id |
integer | 条件付き読み取り権限がバインドされているメールボックスID。 |
data.pin_grant.unlock_token |
string | 同じ所有者の資格情報を使用した X-Mailbox-Unlock 用の不透明な読み取りトークンです。プライベートに保ち、メモリ内に保持してください; 読み取り権限は削除を許可しません。 |
data.pin_grant.scope |
string | 条件付き作成権限のために読み取られるスコープ。 |
data.pin_grant.idle_timeout_seconds |
integer | 読み取り権限の許容アイドル時間は、通常3600秒です。 |
data.pin_grant.absolute_timeout_seconds |
integer | 読み取り権限の最大有効期間は、通常86400秒です。 |
data.pin_grant.expires_at |
string | ISO-8601 形式の現在の読み取り権限の有効期限。 |
data.pin_grant.absolute_expires_at |
string | ISO-8601形式の絶対的な読み取り権限の有効期限。セキュリティの変更により、権限が早期に取り消されることがあります。 |
Outlook エイリアス ドメイン
メールボックス生成に利用できるアクティブな Outlook / Hotmail エイリアスドメインを取得する。
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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
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
}
]
}
}
| フィールド | 種類 | 説明 |
|---|---|---|
status |
boolean | 操作が成功したかどうか。 |
data.domains |
array | アクティブな Outlook/Hotmail ドメイン; 空の配列は有効です。 |
data.domains[].domain |
string | 利用可能なドメイン名。 |
data.domains[].type |
string | 読み取り可能なプロバイダーラベル。 |
data.domains[].selectable |
boolean | アカウントがこのドメインを明示的に選択できるかどうか。 |
data.domains[].locked |
boolean | アカウントに対して明示的なドメイン選択がロックされているかどうか。 |
data.domains[].disabled_reason |
string|null | ドメイン選択がロックされている理由、または選択可能な場合はnullです。 |
Outlook エイリアスを作成
認証されたユーザーが所有する新しい Outlook / Hotmail エイリアスの一時メールボックスを作成する。
| パラメータ | 場所 | 種類 | ステータス | 説明 |
|---|---|---|---|---|
domain
|
body | string | 任意 |
ランダムまたは GET /outlook-alias/domains から取得したドメインを使用します; outlook_alias_domain も受け付けられます。選択権限がない場合、ランダムが使用されます。
デフォルト:
ランダムな利用可能ドメイン
|
username
|
body | string | 任意 |
オプションのカスタムエイリアスサフィックス: 2〜32文字のASCII文字または数字で、小文字に正規化されます; 機能権限の対象です。また、custom_username または alias_username を受け付けます。
デフォルト:
自動生成
|
lifetime
|
body | string | 任意 |
許可される値:
10m — 10 分間
1h — 1時間
2h — 2時間
1d — 1日
1w — 1 週間
1m — 30日間
3m — 90 日
6m — 180日間
1y — 365日間
unlimited — 無制限
デフォルト:
プランのデフォルト有効期間
|
pin_enabled
|
body | boolean | 任意 |
プランで許可されている場合、新しいメールボックスにオプションの PIN 保護を設定できます。既存のメールボックスの PIN は変更されません。
デフォルト:
false
|
pin
|
body | string | 任意 |
pin_enabled が true の場合に必須: 先頭のゼロを保持するために文字列として送信される、6〜8 桁の PIN。
|
pin_confirmation
|
body | string | 任意 |
pin_enabled が true の場合に必須です。pin と完全に一致する必要があります。
|
Idempotency-Key
|
header | string | 任意 |
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
|
domain (例: outlook.com, hotmail.com), username (カスタムエイリアスユーザー名), lifetime (許可される値: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). ライフタイムを省略するか空欄のままにすると、現在の月額/年額プランで設定されたデフォルトのメールライフタイムが使用されます。デフォルトを上書きするには、1h などの許可されたライフタイムを送信してください。Unlimited は、プランのデフォルトとして設定されている場合、または明示的に要求され許可された場合にのみ使用されます。 ボディパラメータ mailbox_lifetime と email_lifetime も受け付けられます; 最初の空でない値が次の順序で優先されます: lifetime, mailbox_lifetime, email_lifetime. 無効または許可されていない値は、デフォルトを黙って選択する代わりに HTTP 422 を返します。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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
200 OK • JSON{
"status": true,
"data": {
"id": 2306,
"pin_protected": false,
"email": "example+alias45@outlook.com",
"domain": "outlook.com",
"provider": "outlook_alias",
"expire_at": "2026-11-19T03:18:00+00:00",
"expires_in_seconds": 3599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:00+00:00",
"email_token": "encrypted-email-token"
}
}
| フィールド | 種類 | 説明 |
|---|---|---|
status |
boolean | 操作が成功したかどうか。 |
data.id |
integer | メールボックス ID。生成された ID、アドレス、トークンはメールボックスごとに異なります。 |
data.pin_protected |
boolean | このメールボックスがPIN保護されているかどうか。PINやPINハッシュは返されません。 |
data.email |
string | 完全なメールボックスアドレスが生成されました。 |
data.domain |
string | 生成されたメールボックスのドメイン。 |
data.provider |
string | メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。 |
data.expire_at |
string|null | 有効期限は ISO-8601 タイムスタンプとして、無制限のメールボックスの場合は null です。 |
data.expires_in_seconds |
number|null | 計算時の残り秒数は負でないです;小数秒も可能です。null はゼロではなく無制限を意味します。 |
data.mailbox_state |
string | 現在のメールボックスの状態: アクティブ、ポーズ中、期限切れ、または非アクティブ。 |
data.receiving_enabled |
boolean | このメールボックスが現在受信メッセージを受け付けているかどうか。 |
data.message_count |
integer | 既知の総メッセージ数;最後のメールボックス同期を反映することがあります。 |
data.unread_message_count |
integer | 既知の未読メッセージ数; 最後のメールボックス同期を反映することがあります。 |
data.last_message_received_at |
string|null | ISO-8601形式の最後に知られている受信メッセージの時間、利用できない場合はnull。 |
data.message_count_synced_at |
string|null | ISO-8601形式の最終メッセージ数同期時刻、同期前はnullです。 |
data.created_at |
string|null | メールボックスの作成時間(ISO-8601形式)。 |
data.email_token |
string | 不透明な暗号化メールボックス参照です。Bearer認証、所有権チェック、またはPIN認証の代わりにはなりません。 |
data.pin_grant |
object | 条件付き: アクティブなPIN保護メールボックスの作成はこの読み取り権限を返します; 通常の保護されていない作成はそれを省略します。 |
data.pin_grant.mailbox_id |
integer | 条件付き読み取り権限がバインドされているメールボックスID。 |
data.pin_grant.unlock_token |
string | 同じ所有者の資格情報を使用した X-Mailbox-Unlock 用の不透明な読み取りトークンです。プライベートに保ち、メモリ内に保持してください; 読み取り権限は削除を許可しません。 |
data.pin_grant.scope |
string | 条件付き作成権限のために読み取られるスコープ。 |
data.pin_grant.idle_timeout_seconds |
integer | 読み取り権限の許容アイドル時間は、通常3600秒です。 |
data.pin_grant.absolute_timeout_seconds |
integer | 読み取り権限の最大有効期間は、通常86400秒です。 |
data.pin_grant.expires_at |
string | ISO-8601 形式の現在の読み取り権限の有効期限。 |
data.pin_grant.absolute_expires_at |
string | ISO-8601形式の絶対的な読み取り権限の有効期限。セキュリティの変更により、権限が早期に取り消されることがあります。 |
メッセージと添付ファイル
受信トレイを取得し、HTML/テキストメッセージ全体を読み取り、添付ファイルをストリーミングします。
メールボックスメッセージを一覧表示
利用可能なメッセージ要約とメールボックスのメタデータを取得します。標準の受信トレイスキャンは最大25件の最近のメッセージのバッチを返します; これはページングされた全履歴エンドポイントではありません。完全な本文と添付ファイルを取得するには GET /messages/{messageId} を使用してください。
| パラメータ | 場所 | 種類 | ステータス | 説明 |
|---|---|---|---|---|
email
|
query | string | 必須 |
所有するメールボックスの完全なメールアドレス(メッセージを読むため)。クエリ値はURLエンコードしてください;プラス記号は %2B とエンコードします。
|
X-Mailbox-Unlock
|
header | string | 任意 |
ヘッダー、保護されたメールボックスのみ: 読み取り用の unlock_token を使用してください。最初に PIN と scope=read を PIN アンロック URL に POST してください。通常の Bearer 認証はそのまま保持してください。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
200 OK • JSON{
"status": true,
"mailbox": "demo123@example.com",
"email_token": "encrypted-email-token",
"messages": [
{
"is_seen": false,
"subject": "Welcome to Temp Mail",
"from": "Example Sender",
"from_email": "hello@example.org",
"receivedAt": "2026-11-19 02:18:00",
"id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
"otp": null,
"otp_locked": false,
"verification_link": null,
"verification_link_locked": false
}
],
"mailbox_provider": "standard",
"mailbox_state": "active",
"expire_at": "2026-11-20T02:18:00+00:00",
"expires_in_seconds": 86399.75,
"receiving_enabled": true,
"mailbox_limit": {
"limit": 50,
"limit_label": "50",
"active_count": 1,
"paused_count": 0,
"paused_mailboxes": [],
"remaining": 49,
"remaining_label": "49",
"reached": false,
"blocked": false,
"provider": "standard"
},
"message_count": 1,
"unread_message_count": 1,
"last_message_received_at": "2026-11-19T02:18:00+00:00",
"message_count_synced_at": "2026-11-19T02:18:00+00:00"
}
| フィールド | 種類 | 説明 |
|---|---|---|
status |
boolean | 操作が成功したかどうか。 |
mailbox |
string | 要求されたメッセージのメールボックスアドレス。 |
email_token |
string | 不透明な暗号化メールボックス参照;通常の認証は依然として必要です。 |
mailbox_provider |
string | メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。 |
messages |
array | メッセージの要約。空の受信トレイは空の配列を返します; 本文と添付ファイルを取得するには単一のメッセージを取得してください。 |
expire_at |
string|null | 有効期限は ISO-8601 タイムスタンプとして、無制限のメールボックスの場合は null です。 |
expires_in_seconds |
number|null | 計算時の残り秒数は負でないです;小数秒も可能です。null はゼロではなく無制限を意味します。 |
mailbox_state |
string | 現在のメールボックスの状態: アクティブ、ポーズ中、期限切れ、または非アクティブ。 |
receiving_enabled |
boolean | このメールボックスが現在受信メッセージを受け付けているかどうか。 |
message_count |
integer | 既知の総メッセージ数;最後のメールボックス同期を反映することがあります。 |
unread_message_count |
integer | 既知の未読メッセージ数; 最後のメールボックス同期を反映することがあります。 |
last_message_received_at |
string|null | ISO-8601形式の最後に知られている受信メッセージの時間、利用できない場合はnull。 |
message_count_synced_at |
string|null | ISO-8601形式の最終メッセージ数同期時刻、同期前はnullです。 |
mailbox_limit.limit |
integer | このプロバイダーのアクティブメールボックス上限; -1 は無制限を意味します。 |
mailbox_limit.limit_label |
string | メールボックス上限の表示ラベル。 |
mailbox_limit.active_count |
integer | このプロバイダーのアクティブなメールボックスの数。 |
mailbox_limit.paused_count |
integer | このプロバイダーの一時停止されたメールボックスの数。 |
mailbox_limit.paused_mailboxes |
array<string> | メールボックスの上限によりアドレスが一時停止されました。 |
mailbox_limit.remaining |
integer | 残りのアクティブなメールボックススロット数; -1 は無制限を意味します。これは API リクエストクォータではありません。 |
mailbox_limit.remaining_label |
string | 残りのメールボックススロットの表示ラベル。 |
mailbox_limit.reached |
boolean | アクティブなメールボックスの上限に達しているかどうか。 |
mailbox_limit.blocked |
boolean | アクティブなメールボックスの上限がゼロかどうか。 |
mailbox_limit.provider |
string|null | メールボックス制限が適用されるプロバイダー。 |
messages[].id |
string | 単一メッセージ、削除、添付エンドポイントで使用される不透明なメッセージ ID。 |
messages[].is_seen |
boolean | メッセージが既読としてマークされているかどうか。 |
messages[].subject |
string | メッセージの件名。 |
messages[].from |
string | 送信者の表示名またはアドレス。 |
messages[].from_email |
string | 送信者のメールアドレス。 |
messages[].receivedAt |
string | アプリケーションのタイムゾーンでの受信時間、形式は YYYY-MM-DD HH:mm:ss です。 |
messages[].otp |
string|null | 利用可能で許可されている場合はワンタイムコードを検出し、そうでない場合は null。 |
messages[].otp_locked |
boolean | 検出されたワンタイムコードが機能権限によって非表示になるかどうか。 |
messages[].verification_link |
string|null | 利用可能で許可されている場合は検出された検証URLを表示し、そうでない場合はnullです。 |
messages[].verification_link_locked |
boolean | 検出された検証リンクが機能権限によって非表示になっているかどうか。 |
messages[].from_name |
string|null | Outlook の要約フィールド: 元の送信者名。Standard と Gmail の要約には含まれていません。 |
messages[].snippet |
string|null | Outlook のサマリーフィールド: 短いメッセージプレビュー。 |
messages[].received_at |
string|null | Outlook のサマリーフィールド: 既知の場合の ISO-8601 受信時刻。 |
messages[].has_attachments |
boolean | Outlook の概要フィールド: 添付メタデータが存在するかどうか。ダウンロードの可用性は別途確認されます。 |
単一メッセージを取得
不透明なメッセージIDで所有されたメッセージを取得します。本文の形式と添付メタデータを返します。本文フィールドはメッセージ形式に依存します;Outlookは以下に示すプロバイダー固有のフィールドを追加します。
| パラメータ | 場所 | 種類 | ステータス | 説明 |
|---|---|---|---|---|
messageId
|
path | string | 必須 |
メッセージリストで返されるユニークなメッセージID。
|
X-Mailbox-Unlock
|
header | string | 任意 |
ヘッダー、保護されたメールボックスのみ: 読み取り用の unlock_token を使用してください。最初に PIN と scope=read を PIN アンロック URL に POST してください。通常の Bearer 認証はそのまま保持してください。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
200 OK • JSON{
"status": true,
"data": {
"is_seen": true,
"subject": "Welcome to Temp Mail",
"from": "Example Sender",
"from_email": "hello@example.org",
"to": "demo123@example.com",
"mailbox_provider": "standard",
"receivedAt": "2026-11-19 02:18:00",
"id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
"html": true,
"html_content": "<p>Hello from the inbox.</p>",
"text_content": "<pre>Hello from the inbox.</pre>",
"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"
}
]
}
}
| フィールド | 種類 | 説明 |
|---|---|---|
status |
boolean | 操作が成功したかどうか。 |
data.id |
string | 不透明なメッセージ ID。 |
data.is_seen |
boolean | メッセージの既読状態。閲覧すると既読としてマークされる可能性があり、キャッシュされたデータは以前の状態を反映していることがあります。 |
data.subject |
string | メッセージの件名。 |
data.from |
string | 送信者の表示名またはアドレス。 |
data.from_email |
string | 送信者のメールアドレス。 |
data.to |
string | 受信者のメールボックスアドレス。 |
data.mailbox_provider |
string | メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。 |
data.receivedAt |
string | アプリケーションのタイムゾーンでの受信時間、形式は YYYY-MM-DD HH:mm:ss です。 |
data.html |
boolean | メッセージに HTML 本文があるかどうか。 |
data.html_content |
string | HTML本文がある場合。HTMLがない標準メッセージはこのフィールドを省略できます。メッセージ内容は信頼できないものとして扱ってください。 |
data.text_content |
string | テキスト本文が存在する場合; 標準メッセージは pre 要素内のエスケープされたテキストを含むことがあり、このフィールドを省略することもあります。 |
data.content |
string | 表示用の優先本文、利用可能な場合は通常 HTML。 |
data.attachments |
array | 添付ファイルのメタデータ、または空の配列。ダウンロードには通常の認証と該当する PIN 認可が必要です。 |
data.attachments[].name |
string | ダウンロード時に単一のパスセグメントとして URL エンコードするファイル名。 |
data.attachments[].size |
integer | 添付ファイルのサイズ(バイト単位)。 |
data.attachments[].url |
string | 認証済みユーザーAPIのダウンロードURLがファイル名付きの添付ファイルに追加されました。URLがローカルファイルの利用可能性を保証するわけではありません。 |
data.attachments[].extension |
string | 標準/Gmail メタデータフィールド: 提供された場合のファイル拡張子。 |
data.attachments[].id |
string | Outlook メタデータ フィールド: プロバイダー添付ファイル ID。 |
data.attachments[].content_type |
string | Outlook メタデータフィールド: MIME コンテンツタイプ。 |
data.from_name |
string|null | Outlook 詳細フィールド: 元の送信者名。 |
data.to_email |
string|null | Outlook 詳細フィールド: 元の受信者アドレス。 |
data.received_at |
string|null | Outlook 詳細フィールド: ISO-8601 受信時間。 |
data.has_html |
boolean | Outlook 詳細フィールド: HTML 本文が存在するかどうか。 |
メッセージを削除
所有メッセージを1件削除します。
| パラメータ | 場所 | 種類 | ステータス | 説明 |
|---|---|---|---|---|
messageId
|
path | string | 必須 |
永続的に削除するためのユニークなメッセージID文字列。
|
X-Mailbox-Unlock
|
header | string | 任意 |
ヘッダー、保護されたメールボックスのみ:ワンタイム削除用 unlock_token を使用してください。最初に PIN を POST し、scope=delete と 423 応答で返される action/target_id を PIN アンロック URL に送ります。読み取りトークンでは削除できません。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | 任意 |
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
|
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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
| フィールド | 種類 | 説明 |
|---|---|---|
status |
boolean | 操作が成功したかどうか。 |
message |
string | 削除の結果。リソースが見つからない場合は HTTP 404 が返されます。 |
添付ファイルをダウンロード
所有メッセージから添付ファイルをダウンロードします。
| パラメータ | 場所 | 種類 | ステータス | 説明 |
|---|---|---|---|---|
messageId
|
path | string | 必須 |
ファイルを含むメッセージの ID。
|
filename
|
path | string | 必須 |
ダウンロードする添付ファイルのファイル名と拡張子です。
|
X-Mailbox-Unlock
|
header | string | 任意 |
ヘッダー、保護されたメールボックスのみ: 読み取り用の unlock_token を使用してください。最初に PIN と scope=read を PIN アンロック URL に POST してください。通常の Bearer 認証はそのまま保持してください。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
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
| フィールド | 種類 | 説明 |
|---|---|---|
Content-Disposition |
header | 成功したレスポンスは要求されたファイル名をダウンロードします。 |
body |
binary | 成功時はファイルバイトを返し、JSONではありません。エラー時は2xx以外のステータスでJSONを返します。 |
レート制限とクォータ
クレジットを消費せずに、リアルタイムのリクエスト予算、レートリミット、アカウントクォータを監視します。
レートリミットとクォータ
API使用量を消費せずに、現在のレートリミットとクォータステータスを確認してください。このエンドポイントはクォータフリーで、月間APIクレジットを差し引きません(濫用防止制限: 60 リクエスト/分)。
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'
合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。
例レスポンス
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 | アカウントのリクエスト/分制限。文字列 unlimited は無制限の分予算を示します; これは月間クォータとは独立しています。 |
data.remaining |
integer|string | 残りのアカウント分単位予算スロット、または文字列 unlimited。正の値は API クレジットが残っていることを意味しません。 |
data.reset |
integer | アカウントの分ウィンドウの秒数であり、月間クォータリセットではありません。無効または無制限の分予算は名目上60秒の値を保持できますが、待機後のアクセスを保証するものではありません。 |
data.plan |
string | 現在のプランタグです。読みやすいプラン名は data.quota.plan_name に別途提供されます。 |
data.quota.enabled |
boolean | グローバルおよびプラン/クレジットAPIアクセスが有効かどうか。これは残りの容量を示すものでも、ユーザーAPIスイッチの代わりになるものでもありません。 |
data.quota.user_api_status |
boolean | ユーザーがユーザーAPIスイッチを有効にしているかどうか。操作にはこのスイッチと有効なアクセスおよび利用可能な容量が必要です。 |
data.quota.plan_name |
string | 現在のプランの読みやすい名前。 |
data.quota.period |
string | カレンダー月の使用期間はYYYY-MM形式で、アプリケーションのタイムゾーン; 必ずしもサブスクリプションの請求期間とは限りません。 |
data.quota.base_limit |
integer | 基本月間プランの許容量。-1 の値は無制限を意味します。 |
data.quota.extra_requests |
integer | 現在の使用期間に対して追加の月間手当が付与されました; 購入したクレジットとは別です。 |
data.quota.monthly_limit |
integer | 基本割当と現在期間の追加リクエストの合計。-1 の値は無制限を意味します。購入したクレジットは含まれません。 |
data.quota.monthly_remaining |
integer|null | 残りの有限月間割り当て、または月間クォータが無制限の場合は null。null はゼロとして解釈してはなりません。 |
data.quota.used |
integer | 現在の使用期間における成功した、クレジットを使用した操作を含むカウントされた API 操作。ステータスチェックはこの値を増加させません。 |
data.quota.purchased_credits |
integer | 現在のクレジット残高(アクティブプランのボーナスクレジットを含む)。ボーナスクレジットはこの残高に二度追加してはなりません。 |
data.quota.bonus_credits |
integer | クレジット残高のアクティブプランボーナス部分; purchased_credits の内訳であり、追加容量ではありません。 |
data.quota.direct_purchased_credits |
integer | アクティブなプランボーナス部分を除いたクレジット残高。この値に bonus_credits を加えると purchased_credits になります。 |
data.quota.remaining |
integer|null | ボーナスを二重にカウントせず、月間残り許容量に現在のクレジット残高を加算したものです。null は無制限の月間クォータを意味します。個別の機能権限やその他のリクエスト制限は引き続き適用されます。 |
data.quota.unlimited |
boolean | 月間クォータが無制限かどうか。このことは、アカウントの分単位予算や他の機能制限が無制限になることを意味しません。 |
data.quota.usage_percent |
integer | ダッシュボード互換の0から100までの丸められたパーセンテージ:使用量を使用量+残量で割り、100を掛けたものです。利用可能なクレジット容量が含まれるため、再充電するとパーセンテージが下がることがあります。無制限のクォータまたはサイズゼロのプールの場合は0です;分単位のレート制限パーセンテージやアクセス決定ではありません。 |
data.quota.reset_at |
string | 次のカレンダ月のクォータリセットのためのタイムゾーンオフセット付き ISO-8601 タイムスタンプです。これはサブスクリプションの有効期限ではなく、月次リセットは購入済みクレジットを補充しません。 |
status |
string | このステータスエンドポイントの文字通りの成功です。他の成功したメールボックスエンドポイントはブール値のtrueを使用します。 |
data.monthly_limit |
integer | 対応する data.quota フィールドの互換エイリアス; 残高を計算する際に再度追加しないでください。 |
data.monthly_remaining |
integer|null | 対応する data.quota フィールドの互換エイリアス; 残高を計算する際に再度追加しないでください。 |
data.purchased_credits |
integer | 対応する data.quota フィールドの互換エイリアス; 残高を計算する際に再度追加しないでください。 |
メールボックス Webhook(リアルタイムプッシュ)
REST API(GET /messages)を繰り返しポーリングして受信メールを確認する代わりに、Webhook を設定して新しいメールをリアルタイムであなたのサーバーまたは自動化ワークフローにプッシュできます。
サポートされているWebhookイベント
各Webhookは1つ以上のイベントタイプに登録できます。これらのトリガーのいずれかが発火すると、エンドポイントにイベント通知が送信されます。
選択されたメールボックスに新しいメッセージが届くたびにリアルタイムで送信されます。
一時的なメールボックスが期限切れになり、webhook の処理が一時停止したときに送信されます。
期限切れのメールボックスがプランの規則に従って再びアクティブになるときに送信されます。
Webhook とそのメールボックスが削除される直前に送信されます。
リクエストヘッダーとHMAC署名検証
すべてのウェブフック配信には特殊なセキュリティヘッダーが含まれています。X-TempMailg-Signatureヘッダーを使用して、TempMailgから本物のリクエストが送信されたことを確認し、改ざんされていないことを検証してください。
| ヘッダー名 | 例の値 | 説明 |
|---|---|---|
User-Agent |
TempMailg-Webhooks/1.0 | Webhook 配信ワーカーの標準識別子。 |
X-TempMailg-Event |
email.received | この配信をトリガーしたイベントのタイプ。 |
X-TempMailg-Event-Id |
e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c | この配信試行に割り当てられた一意の UUID。 |
X-TempMailg-Timestamp |
1725192000 | リクエストが開始された時点を示すUnixエポックタイムスタンプ。 |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | シークレットを使用して、{timestamp}.{raw_body} から計算された HMAC-SHA256 署名。 |
X-TempMailg-Test |
false | True は、ダッシュボードの「Send Test Ping」機能で送信されたときに適用されます。 |
署名は、次の文字列に対してHMACでSHA256を使用して計算されます:
hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)
サンプルイベントペイロード(email.received)
HTTP POST リクエストボディ内で application/json として送信されます。
{
"id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"version": "1.0",
"event": "email.received",
"occurred_at": "2026-11-19T02:18:02+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-11-19T02:18:02+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 の Webhook は、標準的な HTTPS エンドポイントと主要なノーコード/自動化プラットフォームで、すぐに使用できます:
共通のエラーとトラブルシューティング
これらは、ユーザーAPIを統合する際に表示される可能性のある最も一般的なレスポンスコードです。
無効、欠落、または取り消されたBearerトークンです。
所有権、機能権限、ドメインアクセス、または添付ファイルサイズが操作を妨げました。レスポンスコードとメッセージを確認してください。
リソースは許可されたホストで見つからなかった、またはユーザーに属しません。
操作キーが異なる詳細で再利用されたか、別の操作が保留中であるか、メールボックスのセキュリティが変更されました。再試行する前にコードを確認してください。
メールボックスが期限切れまたは非アクティブです。
無効なパラメータ、許可されていない有効期間、利用できないエイリアス容量、無効なPIN設定、または欠落/無効なIdempotency-Keyが原因で操作が失敗しました。
保護されたメールボックスには有効なスコープ付き X-Mailbox-Unlock トークンが必要です。削除にはレスポンスの action と target_id を使用してください。ロックアウトまたはリカバリ要件は再試行する前に解決する必要があります。
リクエスト制限、無効化されたプラン、クォータの枯渇、またはクールダウンにより操作が阻止されました。理由と利用可能な予算ヘッダーを確認してください。Retry-After はオプションです。
サーバーは操作を完了できませんでした。保護された作成または削除の場合、再試行時に同じリクエストと Idempotency-Key を保持してください。
保護ストレージまたは調整を検証できませんでした。示された遅延後に再試行してください。この応答は支払い失敗ではありません。
クイックチェックリスト
- 401 Unauthorized - Bearerトークンが欠けている、間違っている、取り消された、またはコピーが間違っている。
- 403 Forbidden - 現在のプランには、ユーザーAPIへのアクセス権がありません。
- 404 Not Found - リソースが見つからないか、無効なパラメータです。
- 410 Gone / Expired - メールボックスの有効期限が切れた、またはアクティブではありません。
- 429 Rate Limited - レスポンスの理由と予算ヘッダーを確認してください。Retry-After は時間制限にのみ適用されます。クレジットが枯渇したりアクセスが無効になった場合、アカウントの変更が必要になることがあります。
推奨される次のステップ
サインインしている場合は、API Management を開いて、デバッグを開始する前に、キー、クォータ、プランのアクセス状態、および正確なユーザー API ベース URL を確認してください。