Документація TempMailg API

REST API v1 та Webhooks

TempMailg Документація API для розробників

Використайте цю документацію, щоб згенерувати свій особистий ключ API, підключити окремий хост користувача API, прочитати повідомлення поштової скриньки, керувати своїми поштовими скриньками та інтегрувати Temp Mail у свої власні додатки або автоматизації.

Авторизація за токеном Bearer Вебхуки в реальному часі Gmail & Outlook псевдоніми Відповіді JSON
Базовий URL користувача API HTTPS
Формат запиту Використовуйте свій ключ API тільки у заголовку Authorization Bearer та тримайте чистими URL-адреси ендпоінтів.

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
Отримати дозволені домени
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
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:53:50+00:00",
        "expires_in_seconds": 86400,
        "created_at": "2026-10-29T06:53:50+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.
Оновити поштову скриньку, що належить користувачеві
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-29T07:03:50+00:00",
        "expires_in_seconds": 600,
        "created_at": "2026-10-29T06:53:50+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.
Видалити поштову скриньку, що належить користувачеві
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
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:53:50+00:00",
        "expires_in_seconds": 3600,
        "created_at": "2026-10-29T06:53:50+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
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
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:53:50+00:00",
        "expires_in_seconds": 3600,
        "created_at": "2026-10-29T06:53:50+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.
Параметр запиту електронної пошти повинен належати обліковому запису автентифікованого користувача.
Прочитати повідомлення поштової скриньки
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:53:50",
            "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.
Прочитати одне повідомлення
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:53:50",
        "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.
Видалити одне повідомлення
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.
Завантажити вкладення
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
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.

Захист PIN-коду поштової скриньки

Введіть PIN, щоб продовжити. Ваша поштовий ящик залишається розблокованим, доки він активний у цій сесії веб-сайту.

Ви приймаєте файли cookie?

Ми використовуємо файли cookie для покращення вашого браузингового досвіду. Використовуючи цей сайт, ви погоджуєтеся з нашою політикою використання файлів cookie.

Більше
Loading chat...
Connecting to community chat.