Tài liệu API TempMail

REST API v1 & Webhooks

TempMailg Tài liệu API cho nhà phát triển

Sử dụng tài liệu này để tạo khóa API cá nhân, kết nối máy chủ API người dùng chuyên dụng, đọc tin nhắn hộp thư, quản lý hộp thư thuộc sở hữu và tích hợp Temp Mail vào ứng dụng hoặc tự động hóa của riêng bạn.

Xác thực Bearer Token Webhooks thời gian thực Bí danh Gmail & Outlook Phản hồi JSON
Địa Chỉ Cơ Sở API Người Dùng HTTPS
Định dạng yêu cầu Sử dụng khóa API chỉ trong tiêu đề Authorization Bearer và giữ cho các URL điểm cuối sạch sẽ.

Quản lý hộp thư

Lấy các miền được phép, tạo hoặc chuyển hộp thư, chọn thời gian sống được phép, và xóa các địa chỉ sở hữu.

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

Liệt kê các miền được phép

Liệt kê các miền có sẵn để tạo email tạm thời. Lọc theo loại để chỉ xem các miền miễn phí, cao cấp hoặc tùy chỉnh được hỗ trợ bởi gói đăng ký của bạn.

Tham số 1
Tham số Vị trí Loại Trạng thái Mô Tả
type query string tùy chọn
Bộ lọc cấp độ miền. Bỏ qua sẽ sử dụng tất cả khi quyền truy cập premium-domain được bật, nếu không thì miễn phí. Các giá trị được công nhận: free, basic, pro, premium, custom, ultimate, all
Mặc định: Phụ thuộc vào tài khoản
Lấy miền được phép
curl --request GET \
  --url 'https://v1.tempmailg.com/api/domains?type=free' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
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
            }
        ]
    }
}
Các trường phản hồi
Trường Loại Mô Tả
status boolean
Liệu thao tác có thành công hay không.
data.requested_type string
Đã áp dụng bộ lọc miền.
data.plan string
Thẻ gói hiện tại.
data.plan_name string
Tên dễ đọc của gói hiện tại.
data.allowed_types array<string>
Các bộ lọc miền có sẵn cho tài khoản này. Một bộ lọc đã được công nhận vẫn có thể bị cấm cho gói của bạn.
data.domains array
Các miền có thể chọn sau khi lọc; một mảng trống là hợp lệ.
data.domains[].domain string
Tên miền có thể chọn.
data.domains[].type string
Nhãn cấp độ miền có thể đọc.
data.domains[].custom boolean
Liệu đây có phải là miền tùy chỉnh.
POST https://v1.tempmailg.com/api/emails
#

Tạo Hộp Thư Tạm Thời

Tạo một hộp thư tạm thời thuộc sở hữu. Bỏ qua tên người dùng và miền để tạo ngẫu nhiên, hoặc cung cấp tên người dùng tùy chỉnh được phép và một miền cho phép. Tham số provider có thể chọn tạo bí danh Gmail hoặc Outlook.

Tham số 8
Tham số Vị trí Loại Trạng thái Mô Tả
username body string tùy chọn
Tên người dùng tùy chỉnh tùy chọn: 2 đến 64 ký tự ASCII bao gồm chữ cái, chữ số, dấu chấm, dấu gạch dưới hoặc dấu gạch ngang. Yêu cầu quyền kế hoạch; custom_username cũng được chấp nhận.
Mặc định: Được tạo ngẫu nhiên
domain body string tùy chọn
Một trong các miền được phép trả về bởi GET /domains. Việc bỏ qua sẽ chọn một miền được phép ngẫu nhiên.
Mặc định: Miền cho phép ngẫu nhiên
lifetime body string tùy chọn
các giá trị cho phép:
10m — 10 phút 1h — 1 giờ 2h — 2 giờ 1d — 1 ngày 1w — 1 Tuần 1m — 30 ngày 3m — 90 ngày 6m — 180 ngày 1y — 365 ngày unlimited — Không giới hạn
Mặc định: Thời gian sống mặc định của kế hoạch
provider body string tùy chọn
Nhà cung cấp hộp thư: standard, gmail_alias, hoặc outlook_alias.
Mặc định: standard
pin_enabled body boolean tùy chọn
Bảo vệ PIN tùy chọn cho hộp thư mới, khi gói của bạn cho phép. Nó không thay đổi PIN của hộp thư đã tồn tại.
Mặc định: false
pin body string tùy chọn
Yêu cầu khi pin_enabled là true: một PIN từ 6 đến 8 chữ số, được gửi dưới dạng chuỗi để giữ nguyên các số 0 ở đầu.
pin_confirmation body string tùy chọn
Bắt buộc khi pin_enabled là true. Phải khớp chính xác với pin.
Idempotency-Key header string tùy chọn
Yêu cầu cho việc tạo hoặc xóa được bảo vệ bằng PIN: một khóa ổn định từ 16 đến 128 ký tự. Thử lại yêu cầu giống hệt với cùng một khóa để tránh công việc trùng lặp.
Các tham số body tùy chọn: username (tên người dùng tùy chỉnh nếu được cho phép bởi gói), domain (miền được phép, ví dụ example.com), lifetime (các giá trị cho phép: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Bỏ qua thời gian sống, hoặc để trống, để sử dụng Thời gian sống Email Mặc định được cấu hình cho gói hàng tháng/năm hiện tại của bạn. Gửi một thời gian sống được phép như 1h để ghi đè lên mặc định đó. Không giới hạn chỉ được sử dụng khi được cấu hình làm mặc định của gói hoặc được yêu cầu và cho phép một cách rõ ràng. Các tham số trong phần body mailbox_lifetime và email_lifetime cũng được chấp nhận; giá trị không rỗng đầu tiên sẽ được ưu tiên theo thứ tự: lifetime, mailbox_lifetime, email_lifetime. Các giá trị không hợp lệ hoặc không được phép sẽ trả về HTTP 422 thay vì im lặng chọn giá trị mặc định.
Tạo hộp thư
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
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:11+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:11+00:00",
        "email_token": "encrypted-email-token"
    }
}
Các trường phản hồi
Trường Loại Mô Tả
status boolean
Liệu thao tác có thành công hay không.
data.id integer
ID hộp thư. Các ID, địa chỉ và token được tạo ra khác nhau cho mỗi hộp thư.
data.pin_protected boolean
Cho biết hộp thư này có bảo vệ PIN hay không. Không trả về PIN hoặc hàm băm PIN.
data.email string
Đã tạo địa chỉ hộp thư đầy đủ.
data.domain string
Miền của hộp thư được tạo.
data.provider string
Nhà cung cấp hộp thư: standard, gmail_alias, hoặc outlook_alias.
data.expire_at string|null
Ngày hết hạn hiệu lực dưới dạng dấu thời gian ISO-8601, hoặc null cho hộp thư không giới hạn.
data.expires_in_seconds number|null
Giây còn lại không âm khi tính toán; có thể có giây phân số. Null có nghĩa là không giới hạn, không phải 0.
data.mailbox_state string
Trạng thái hộp thư hiện tại: hoạt động, tạm dừng, đã hết hạn hoặc không hoạt động.
data.receiving_enabled boolean
Liệu hộp thư này hiện có chấp nhận tin nhắn đến hay không.
data.message_count integer
Số lượng tin nhắn tổng cộng đã biết; nó có thể phản ánh lần đồng bộ hộp thư cuối cùng.
data.unread_message_count integer
Số lượng tin nhắn chưa đọc đã biết; nó có thể phản ánh lần đồng bộ hộp thư cuối cùng.
data.last_message_received_at string|null
Thời gian nhận tin nhắn cuối cùng được biết theo định dạng ISO-8601, hoặc null khi không khả dụng.
data.message_count_synced_at string|null
Thời gian đồng bộ đếm tin nhắn cuối cùng ở định dạng ISO-8601, hoặc null trước khi đồng bộ.
data.created_at string|null
Thời gian tạo hộp thư theo định dạng ISO-8601.
data.email_token string
Tham chiếu hộp thư được mã hóa không trong suốt. Nó không thay thế xác thực Bearer, kiểm tra quyền sở hữu hoặc ủy quyền PIN.
data.pin_grant object
Có điều kiện: việc tạo hộp thư bảo vệ bằng PIN đang hoạt động trả về quyền đọc này; việc tạo bình thường không bảo vệ sẽ bỏ qua nó.
data.pin_grant.mailbox_id integer
ID hộp thư mà quyền đọc có điều kiện được gắn vào.
data.pin_grant.unlock_token string
Mã token đọc không trong suốt cho X-Mailbox-Unlock với cùng thông tin xác thực của chủ sở hữu. Giữ nó riêng tư và trong bộ nhớ; quyền đọc không cho phép xóa.
data.pin_grant.scope string
Phạm vi được đọc cho quyền tạo có điều kiện.
data.pin_grant.idle_timeout_seconds integer
Thời gian nhàn rỗi cho quyền đọc được phép, thường là 3600 giây.
data.pin_grant.absolute_timeout_seconds integer
Thời gian sống tối đa của quyền đọc, thường là 86400 giây.
data.pin_grant.expires_at string
Thời hạn cấp quyền đọc hiện tại ở định dạng ISO-8601.
data.pin_grant.absolute_expires_at string
Thời hạn cấp quyền đọc tuyệt đối theo định dạng ISO-8601. Các thay đổi bảo mật có thể thu hồi quyền cấp trước thời hạn.
POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}
#

Cập nhật / Thay đổi Hộp thư

Tạo hoặc chọn một hộp thư tại tên người dùng và miền mới sau khi xác minh quyền sở hữu của hộp thư hiện tại. Điều này không đổi tên hộp thư cũ hoặc thay đổi thời gian tồn tại của nó tại chỗ. Khi đích khác nhau, hộp thư cũ vẫn còn trong lịch sử và có thể bị tạm dừng bởi giới hạn hộp thư hoạt động. Việc sử dụng lại đích hoạt động của bạn sẽ áp dụng lại thời gian tồn tại yêu cầu hoặc mặc định của gói.

Tham số 9
Tham số Vị trí Loại Trạng thái Mô Tả
email path string bắt buộc
Địa chỉ email đầy đủ hiện tại của hộp thư sở hữu để chuyển đổi. Mã hoá URL mỗi đoạn đường dẫn; mã hoá dấu cộng thành %2B.
username path string bắt buộc
Tên người dùng mới mong muốn: 2 đến 64 ký tự chữ và số; tùy thuộc vào quyền tên người dùng tùy chỉnh.
domain path string bắt buộc
Tên miền được phép mới.
lifetime body string tùy chọn
các giá trị cho phép:
10m — 10 phút 1h — 1 giờ 2h — 2 giờ 1d — 1 ngày 1w — 1 Tuần 1m — 30 ngày 3m — 90 ngày 6m — 180 ngày 1y — 365 ngày unlimited — Không giới hạn
Mặc định: Thời gian sống mặc định của kế hoạch
pin_enabled body boolean tùy chọn
Bảo vệ PIN tùy chọn cho hộp thư mới, khi gói của bạn cho phép. Nó không thay đổi PIN của hộp thư đã tồn tại.
Mặc định: false
pin body string tùy chọn
Yêu cầu khi pin_enabled là true: một PIN từ 6 đến 8 chữ số, được gửi dưới dạng chuỗi để giữ nguyên các số 0 ở đầu.
pin_confirmation body string tùy chọn
Bắt buộc khi pin_enabled là true. Phải khớp chính xác với pin.
Idempotency-Key header string tùy chọn
Yêu cầu cho việc tạo hoặc xóa được bảo vệ bằng PIN: một khóa ổn định từ 16 đến 128 ký tự. Thử lại yêu cầu giống hệt với cùng một khóa để tránh công việc trùng lặp.
X-Mailbox-Unlock header string tùy chọn
Tiêu đề, chỉ dành cho các hộp thư được bảo vệ: sử dụng một unlock_token để đọc. Đầu tiên POST pin và scope=read tới URL mở khóa PIN. Giữ xác thực Bearer thông thường của bạn. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Sử dụng hộp thư đến thuộc sở hữu hiện có trong {email}. Tham số body tùy chọn: lifetime (các giá trị cho phép: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Bỏ qua thời gian sống, hoặc để trống, để sử dụng Thời gian sống Email Mặc định được cấu hình cho gói hàng tháng/năm hiện tại của bạn. Gửi một thời gian sống được phép như 1h để ghi đè lên mặc định đó. Không giới hạn chỉ được sử dụng khi được cấu hình làm mặc định của gói hoặc được yêu cầu và cho phép một cách rõ ràng. Các tham số trong phần body mailbox_lifetime và email_lifetime cũng được chấp nhận; giá trị không rỗng đầu tiên sẽ được ưu tiên theo thứ tự: lifetime, mailbox_lifetime, email_lifetime. Các giá trị không hợp lệ hoặc không được phép sẽ trả về HTTP 422 thay vì im lặng chọn giá trị mặc định.
Cập nhật hộp thư đến thuộc sở hữu
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'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
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:11+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:11+00:00",
        "email_token": "encrypted-email-token"
    }
}
Các trường phản hồi
Trường Loại Mô Tả
status boolean
Liệu thao tác có thành công hay không.
data.id integer
ID hộp thư. Các ID, địa chỉ và token được tạo ra khác nhau cho mỗi hộp thư.
data.pin_protected boolean
Cho biết hộp thư này có bảo vệ PIN hay không. Không trả về PIN hoặc hàm băm PIN.
data.email string
Đã tạo địa chỉ hộp thư đầy đủ.
data.domain string
Miền của hộp thư được tạo.
data.provider string
Nhà cung cấp hộp thư: standard, gmail_alias, hoặc outlook_alias.
data.expire_at string|null
Ngày hết hạn hiệu lực dưới dạng dấu thời gian ISO-8601, hoặc null cho hộp thư không giới hạn.
data.expires_in_seconds number|null
Giây còn lại không âm khi tính toán; có thể có giây phân số. Null có nghĩa là không giới hạn, không phải 0.
data.mailbox_state string
Trạng thái hộp thư hiện tại: hoạt động, tạm dừng, đã hết hạn hoặc không hoạt động.
data.receiving_enabled boolean
Liệu hộp thư này hiện có chấp nhận tin nhắn đến hay không.
data.message_count integer
Số lượng tin nhắn tổng cộng đã biết; nó có thể phản ánh lần đồng bộ hộp thư cuối cùng.
data.unread_message_count integer
Số lượng tin nhắn chưa đọc đã biết; nó có thể phản ánh lần đồng bộ hộp thư cuối cùng.
data.last_message_received_at string|null
Thời gian nhận tin nhắn cuối cùng được biết theo định dạng ISO-8601, hoặc null khi không khả dụng.
data.message_count_synced_at string|null
Thời gian đồng bộ đếm tin nhắn cuối cùng ở định dạng ISO-8601, hoặc null trước khi đồng bộ.
data.created_at string|null
Thời gian tạo hộp thư theo định dạng ISO-8601.
data.email_token string
Tham chiếu hộp thư được mã hóa không trong suốt. Nó không thay thế xác thực Bearer, kiểm tra quyền sở hữu hoặc ủy quyền PIN.
data.pin_grant object
Có điều kiện: việc tạo hộp thư bảo vệ bằng PIN đang hoạt động trả về quyền đọc này; việc tạo bình thường không bảo vệ sẽ bỏ qua nó.
data.pin_grant.mailbox_id integer
ID hộp thư mà quyền đọc có điều kiện được gắn vào.
data.pin_grant.unlock_token string
Mã token đọc không trong suốt cho X-Mailbox-Unlock với cùng thông tin xác thực của chủ sở hữu. Giữ nó riêng tư và trong bộ nhớ; quyền đọc không cho phép xóa.
data.pin_grant.scope string
Phạm vi được đọc cho quyền tạo có điều kiện.
data.pin_grant.idle_timeout_seconds integer
Thời gian nhàn rỗi cho quyền đọc được phép, thường là 3600 giây.
data.pin_grant.absolute_timeout_seconds integer
Thời gian sống tối đa của quyền đọc, thường là 86400 giây.
data.pin_grant.expires_at string
Thời hạn cấp quyền đọc hiện tại ở định dạng ISO-8601.
data.pin_grant.absolute_expires_at string
Thời hạn cấp quyền đọc tuyệt đối theo định dạng ISO-8601. Các thay đổi bảo mật có thể thu hồi quyền cấp trước thời hạn.
DELETE https://v1.tempmailg.com/api/emails/{email}
#

Xóa Hộp Thư

Xóa một hộp thư đã sở hữu và kích hoạt việc dọn dẹp tin nhắn và tệp của nó. Các bản ghi hộp thư được giữ lại có thể bị xóa mềm nội bộ; địa chỉ không còn có thể sử dụng qua API.

Tham số 3
Tham số Vị trí Loại Trạng thái Mô Tả
email path string bắt buộc
Địa chỉ email đầy đủ của hộp thư sở hữu cần xóa. Mã hoá URL địa chỉ; mã hoá dấu cộng thành %2B.
X-Mailbox-Unlock header string tùy chọn
Tiêu đề, chỉ dành cho hộp thư được bảo vệ: sử dụng unlock_token xóa một lần. Đầu tiên POST pin, scope=delete và action/target_id được trả về bởi phản hồi 423 tới URL mở khóa PIN. Token đọc không thể xóa. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string tùy chọn
Yêu cầu cho việc tạo hoặc xóa được bảo vệ bằng PIN: một khóa ổn định từ 16 đến 128 ký tự. Thử lại yêu cầu giống hệt với cùng một khóa để tránh công việc trùng lặp.
Xóa hộp thư đến thuộc sở hữu
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
200 OK • JSON
{
    "status": true,
    "message": "Email has been successfully deleted."
}
Các trường phản hồi
Trường Loại Mô Tả
status boolean
Liệu thao tác có thành công hay không.
message string
Kết quả của việc xóa. Một tài nguyên không tồn tại sẽ trả về HTTP 404.

Bí danh Gmail & Outlook

Tạo hộp thư bí danh Gmail và Outlook/Hotmail có uy tín cao.

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

Tạo bí danh Gmail

Tạo một hộp thư tạm thời alias Gmail mới thuộc sở hữu của người dùng đã xác thực.

Tham số 8
Tham số Vị trí Loại Trạng thái Mô Tả
mode body string tùy chọn
Chế độ tạo: auto, dot, plus hoặc plus_dot. Cũng chấp nhận gmail_alias_mode. Nếu không cho phép chọn kiểu, sẽ sử dụng auto.
Mặc định: auto
username body string tùy chọn
Tiền tố bí danh tùy chỉnh tùy chọn: 2 đến 32 ký tự ASCII là chữ cái hoặc chữ số, được chuẩn hóa thành chữ thường; phụ thuộc vào quyền tính năng. Cũng chấp nhận custom_username hoặc alias_username.
Mặc định: Tự động tạo
domain body string tùy chọn
Sử dụng ngẫu nhiên, gmail.com hoặc googlemail.com; alias_domain cũng được chấp nhận. Việc bỏ qua hoặc không có quyền chọn miền sẽ sử dụng ngẫu nhiên.
Mặc định: random
lifetime body string tùy chọn
các giá trị cho phép:
10m — 10 phút 1h — 1 giờ 2h — 2 giờ 1d — 1 ngày 1w — 1 Tuần 1m — 30 ngày 3m — 90 ngày 6m — 180 ngày 1y — 365 ngày unlimited — Không giới hạn
Mặc định: Thời gian sống mặc định của kế hoạch
pin_enabled body boolean tùy chọn
Bảo vệ PIN tùy chọn cho hộp thư mới, khi gói của bạn cho phép. Nó không thay đổi PIN của hộp thư đã tồn tại.
Mặc định: false
pin body string tùy chọn
Yêu cầu khi pin_enabled là true: một PIN từ 6 đến 8 chữ số, được gửi dưới dạng chuỗi để giữ nguyên các số 0 ở đầu.
pin_confirmation body string tùy chọn
Bắt buộc khi pin_enabled là true. Phải khớp chính xác với pin.
Idempotency-Key header string tùy chọn
Yêu cầu cho việc tạo hoặc xóa được bảo vệ bằng PIN: một khóa ổn định từ 16 đến 128 ký tự. Thử lại yêu cầu giống hệt với cùng một khóa để tránh công việc trùng lặp.
Yêu cầu quyền Gmail Alias API được bật trên gói đăng ký của bạn hoặc được mở khóa thông qua gói API Credit. Tham số tùy chọn: mode (auto, dot, plus, plus_dot), username (tên người dùng bí danh tùy chỉnh), domain (ví dụ: gmail.com, googlemail.com), lifetime (các giá trị cho phép: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Bỏ qua thời gian sống, hoặc để trống, để sử dụng Thời gian sống Email Mặc định được cấu hình cho gói hàng tháng/năm hiện tại của bạn. Gửi một thời gian sống được phép như 1h để ghi đè lên mặc định đó. Không giới hạn chỉ được sử dụng khi được cấu hình làm mặc định của gói hoặc được yêu cầu và cho phép một cách rõ ràng. Các tham số trong phần body mailbox_lifetime và email_lifetime cũng được chấp nhận; giá trị không rỗng đầu tiên sẽ được ưu tiên theo thứ tự: lifetime, mailbox_lifetime, email_lifetime. Các giá trị không hợp lệ hoặc không được phép sẽ trả về HTTP 422 thay vì im lặng chọn giá trị mặc định.
Tạo hộp thư bí danh Gmail
curl --request POST \
  --url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
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:11+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:11+00:00",
        "email_token": "encrypted-email-token"
    }
}
Các trường phản hồi
Trường Loại Mô Tả
status boolean
Liệu thao tác có thành công hay không.
data.id integer
ID hộp thư. Các ID, địa chỉ và token được tạo ra khác nhau cho mỗi hộp thư.
data.pin_protected boolean
Cho biết hộp thư này có bảo vệ PIN hay không. Không trả về PIN hoặc hàm băm PIN.
data.email string
Đã tạo địa chỉ hộp thư đầy đủ.
data.domain string
Miền của hộp thư được tạo.
data.provider string
Nhà cung cấp hộp thư: standard, gmail_alias, hoặc outlook_alias.
data.expire_at string|null
Ngày hết hạn hiệu lực dưới dạng dấu thời gian ISO-8601, hoặc null cho hộp thư không giới hạn.
data.expires_in_seconds number|null
Giây còn lại không âm khi tính toán; có thể có giây phân số. Null có nghĩa là không giới hạn, không phải 0.
data.mailbox_state string
Trạng thái hộp thư hiện tại: hoạt động, tạm dừng, đã hết hạn hoặc không hoạt động.
data.receiving_enabled boolean
Liệu hộp thư này hiện có chấp nhận tin nhắn đến hay không.
data.message_count integer
Số lượng tin nhắn tổng cộng đã biết; nó có thể phản ánh lần đồng bộ hộp thư cuối cùng.
data.unread_message_count integer
Số lượng tin nhắn chưa đọc đã biết; nó có thể phản ánh lần đồng bộ hộp thư cuối cùng.
data.last_message_received_at string|null
Thời gian nhận tin nhắn cuối cùng được biết theo định dạng ISO-8601, hoặc null khi không khả dụng.
data.message_count_synced_at string|null
Thời gian đồng bộ đếm tin nhắn cuối cùng ở định dạng ISO-8601, hoặc null trước khi đồng bộ.
data.created_at string|null
Thời gian tạo hộp thư theo định dạng ISO-8601.
data.email_token string
Tham chiếu hộp thư được mã hóa không trong suốt. Nó không thay thế xác thực Bearer, kiểm tra quyền sở hữu hoặc ủy quyền PIN.
data.pin_grant object
Có điều kiện: việc tạo hộp thư bảo vệ bằng PIN đang hoạt động trả về quyền đọc này; việc tạo bình thường không bảo vệ sẽ bỏ qua nó.
data.pin_grant.mailbox_id integer
ID hộp thư mà quyền đọc có điều kiện được gắn vào.
data.pin_grant.unlock_token string
Mã token đọc không trong suốt cho X-Mailbox-Unlock với cùng thông tin xác thực của chủ sở hữu. Giữ nó riêng tư và trong bộ nhớ; quyền đọc không cho phép xóa.
data.pin_grant.scope string
Phạm vi được đọc cho quyền tạo có điều kiện.
data.pin_grant.idle_timeout_seconds integer
Thời gian nhàn rỗi cho quyền đọc được phép, thường là 3600 giây.
data.pin_grant.absolute_timeout_seconds integer
Thời gian sống tối đa của quyền đọc, thường là 86400 giây.
data.pin_grant.expires_at string
Thời hạn cấp quyền đọc hiện tại ở định dạng ISO-8601.
data.pin_grant.absolute_expires_at string
Thời hạn cấp quyền đọc tuyệt đối theo định dạng ISO-8601. Các thay đổi bảo mật có thể thu hồi quyền cấp trước thời hạn.
GET https://v1.tempmailg.com/api/outlook-alias/domains
#

Tên miền bí danh Outlook

Lấy các miền bí danh Outlook / Hotmail đang hoạt động có sẵn để tạo hộp thư.

Yêu cầu quyền Outlook Alias API được bật trên gói đăng ký của bạn hoặc được mở khóa thông qua gói API Credit. Cho biết việc lựa chọn miền cụ thể có được mở khóa trong gói của bạn hay không.
Lấy các miền bí danh Outlook
curl --request GET \
  --url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
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
            }
        ]
    }
}
Các trường phản hồi
Trường Loại Mô Tả
status boolean
Liệu thao tác có thành công hay không.
data.domains array
Các miền Outlook/Hotmail đang hoạt động; một mảng trống là hợp lệ.
data.domains[].domain string
Tên miền khả dụng.
data.domains[].type string
Nhãn nhà cung cấp có thể đọc được.
data.domains[].selectable boolean
Liệu tài khoản của bạn có thể chọn một cách rõ ràng miền này hay không.
data.domains[].locked boolean
Liệu việc chọn miền một cách rõ ràng có bị khóa cho tài khoản của bạn hay không.
data.domains[].disabled_reason string|null
Lý do lựa chọn miền bị khóa, hoặc null khi có thể chọn.
POST https://v1.tempmailg.com/api/outlook-alias/emails
#

Tạo bí danh Outlook

Tạo một hộp thư alias tạm thời Outlook / Hotmail mới thuộc sở hữu của người dùng đã xác thực.

Tham số 7
Tham số Vị trí Loại Trạng thái Mô Tả
domain body string tùy chọn
Sử dụng ngẫu nhiên hoặc một miền từ GET /outlook-alias/domains; outlook_alias_domain cũng được chấp nhận. Nếu không có quyền chọn, sẽ sử dụng ngẫu nhiên.
Mặc định: Miền khả dụng ngẫu nhiên
username body string tùy chọn
Tiền tố bí danh tùy chỉnh tùy chọn: 2 đến 32 ký tự ASCII là chữ cái hoặc chữ số, được chuẩn hóa thành chữ thường; phụ thuộc vào quyền tính năng. Cũng chấp nhận custom_username hoặc alias_username.
Mặc định: Tự động tạo
lifetime body string tùy chọn
các giá trị cho phép:
10m — 10 phút 1h — 1 giờ 2h — 2 giờ 1d — 1 ngày 1w — 1 Tuần 1m — 30 ngày 3m — 90 ngày 6m — 180 ngày 1y — 365 ngày unlimited — Không giới hạn
Mặc định: Thời gian sống mặc định của kế hoạch
pin_enabled body boolean tùy chọn
Bảo vệ PIN tùy chọn cho hộp thư mới, khi gói của bạn cho phép. Nó không thay đổi PIN của hộp thư đã tồn tại.
Mặc định: false
pin body string tùy chọn
Yêu cầu khi pin_enabled là true: một PIN từ 6 đến 8 chữ số, được gửi dưới dạng chuỗi để giữ nguyên các số 0 ở đầu.
pin_confirmation body string tùy chọn
Bắt buộc khi pin_enabled là true. Phải khớp chính xác với pin.
Idempotency-Key header string tùy chọn
Yêu cầu cho việc tạo hoặc xóa được bảo vệ bằng PIN: một khóa ổn định từ 16 đến 128 ký tự. Thử lại yêu cầu giống hệt với cùng một khóa để tránh công việc trùng lặp.
Yêu cầu quyền Outlook Alias API được bật trên gói đăng ký của bạn hoặc được mở khóa thông qua gói API Credit. Tham số tùy chọn: domain (ví dụ: outlook.com, hotmail.com), username (tên người dùng bí danh tùy chỉnh), lifetime (các giá trị cho phép: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Bỏ qua thời gian sống, hoặc để trống, để sử dụng Thời gian sống Email Mặc định được cấu hình cho gói hàng tháng/năm hiện tại của bạn. Gửi một thời gian sống được phép như 1h để ghi đè lên mặc định đó. Không giới hạn chỉ được sử dụng khi được cấu hình làm mặc định của gói hoặc được yêu cầu và cho phép một cách rõ ràng. Các tham số trong phần body mailbox_lifetime và email_lifetime cũng được chấp nhận; giá trị không rỗng đầu tiên sẽ được ưu tiên theo thứ tự: lifetime, mailbox_lifetime, email_lifetime. Các giá trị không hợp lệ hoặc không được phép sẽ trả về HTTP 422 thay vì im lặng chọn giá trị mặc định.
Tạo hộp thư bí danh Outlook
curl --request POST \
  --url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
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:11+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:11+00:00",
        "email_token": "encrypted-email-token"
    }
}
Các trường phản hồi
Trường Loại Mô Tả
status boolean
Liệu thao tác có thành công hay không.
data.id integer
ID hộp thư. Các ID, địa chỉ và token được tạo ra khác nhau cho mỗi hộp thư.
data.pin_protected boolean
Cho biết hộp thư này có bảo vệ PIN hay không. Không trả về PIN hoặc hàm băm PIN.
data.email string
Đã tạo địa chỉ hộp thư đầy đủ.
data.domain string
Miền của hộp thư được tạo.
data.provider string
Nhà cung cấp hộp thư: standard, gmail_alias, hoặc outlook_alias.
data.expire_at string|null
Ngày hết hạn hiệu lực dưới dạng dấu thời gian ISO-8601, hoặc null cho hộp thư không giới hạn.
data.expires_in_seconds number|null
Giây còn lại không âm khi tính toán; có thể có giây phân số. Null có nghĩa là không giới hạn, không phải 0.
data.mailbox_state string
Trạng thái hộp thư hiện tại: hoạt động, tạm dừng, đã hết hạn hoặc không hoạt động.
data.receiving_enabled boolean
Liệu hộp thư này hiện có chấp nhận tin nhắn đến hay không.
data.message_count integer
Số lượng tin nhắn tổng cộng đã biết; nó có thể phản ánh lần đồng bộ hộp thư cuối cùng.
data.unread_message_count integer
Số lượng tin nhắn chưa đọc đã biết; nó có thể phản ánh lần đồng bộ hộp thư cuối cùng.
data.last_message_received_at string|null
Thời gian nhận tin nhắn cuối cùng được biết theo định dạng ISO-8601, hoặc null khi không khả dụng.
data.message_count_synced_at string|null
Thời gian đồng bộ đếm tin nhắn cuối cùng ở định dạng ISO-8601, hoặc null trước khi đồng bộ.
data.created_at string|null
Thời gian tạo hộp thư theo định dạng ISO-8601.
data.email_token string
Tham chiếu hộp thư được mã hóa không trong suốt. Nó không thay thế xác thực Bearer, kiểm tra quyền sở hữu hoặc ủy quyền PIN.
data.pin_grant object
Có điều kiện: việc tạo hộp thư bảo vệ bằng PIN đang hoạt động trả về quyền đọc này; việc tạo bình thường không bảo vệ sẽ bỏ qua nó.
data.pin_grant.mailbox_id integer
ID hộp thư mà quyền đọc có điều kiện được gắn vào.
data.pin_grant.unlock_token string
Mã token đọc không trong suốt cho X-Mailbox-Unlock với cùng thông tin xác thực của chủ sở hữu. Giữ nó riêng tư và trong bộ nhớ; quyền đọc không cho phép xóa.
data.pin_grant.scope string
Phạm vi được đọc cho quyền tạo có điều kiện.
data.pin_grant.idle_timeout_seconds integer
Thời gian nhàn rỗi cho quyền đọc được phép, thường là 3600 giây.
data.pin_grant.absolute_timeout_seconds integer
Thời gian sống tối đa của quyền đọc, thường là 86400 giây.
data.pin_grant.expires_at string
Thời hạn cấp quyền đọc hiện tại ở định dạng ISO-8601.
data.pin_grant.absolute_expires_at string
Thời hạn cấp quyền đọc tuyệt đối theo định dạng ISO-8601. Các thay đổi bảo mật có thể thu hồi quyền cấp trước thời hạn.

Tin nhắn & Tệp đính kèm

Lấy các hộp thư đến, đọc toàn bộ tin nhắn HTML/văn bản, và truyền luồng tệp đính kèm.

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

Liệt kê tin nhắn hộp thư

Truy xuất các bản tóm tắt tin nhắn có sẵn và siêu dữ liệu hộp thư. Các quét hộp đến tiêu chuẩn trả về một lô tin nhắn gần đây lên tới 25 tin; đây không phải là endpoint phân trang toàn bộ lịch sử. Sử dụng GET /messages/{messageId} để lấy nội dung đầy đủ và tệp đính kèm.

Tham số 2
Tham số Vị trí Loại Trạng thái Mô Tả
email query string bắt buộc
Địa chỉ email đầy đủ của hộp thư sở hữu để đọc tin nhắn. Mã hoá URL cho giá trị truy vấn; mã hoá dấu cộng thành %2B.
X-Mailbox-Unlock header string tùy chọn
Tiêu đề, chỉ dành cho các hộp thư được bảo vệ: sử dụng một unlock_token để đọc. Đầu tiên POST pin và scope=read tới URL mở khóa PIN. Giữ xác thực Bearer thông thường của bạn. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Email phải thuộc về tài khoản của bạn. Các bản tóm tắt tiêu chuẩn và Gmail chứa các trường OTP và verification-link; Outlook cũng bao gồm from_name, snippet, received_at và has_attachments. Đồng bộ và bộ nhớ đệm của nhà cung cấp có thể làm chậm các tin nhắn và số lượng mới.
Đọc tin nhắn hộp thư
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'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
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:11",
            "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:11+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:11+00:00",
    "message_count_synced_at": "2026-11-19T02:18:11+00:00"
}
Các trường phản hồi
Trường Loại Mô Tả
status boolean
Liệu thao tác có thành công hay không.
mailbox string
Địa chỉ hộp thư mà các tin nhắn đã được yêu cầu.
email_token string
Tham chiếu hộp thư được mã hóa không trong suốt; vẫn cần xác thực bình thường.
mailbox_provider string
Nhà cung cấp hộp thư: standard, gmail_alias, hoặc outlook_alias.
messages array
Tóm tắt tin nhắn. Hộp thư rỗng trả về một mảng trống; lấy một tin nhắn duy nhất để có nội dung và tệp đính kèm.
expire_at string|null
Ngày hết hạn hiệu lực dưới dạng dấu thời gian ISO-8601, hoặc null cho hộp thư không giới hạn.
expires_in_seconds number|null
Giây còn lại không âm khi tính toán; có thể có giây phân số. Null có nghĩa là không giới hạn, không phải 0.
mailbox_state string
Trạng thái hộp thư hiện tại: hoạt động, tạm dừng, đã hết hạn hoặc không hoạt động.
receiving_enabled boolean
Liệu hộp thư này hiện có chấp nhận tin nhắn đến hay không.
message_count integer
Số lượng tin nhắn tổng cộng đã biết; nó có thể phản ánh lần đồng bộ hộp thư cuối cùng.
unread_message_count integer
Số lượng tin nhắn chưa đọc đã biết; nó có thể phản ánh lần đồng bộ hộp thư cuối cùng.
last_message_received_at string|null
Thời gian nhận tin nhắn cuối cùng được biết theo định dạng ISO-8601, hoặc null khi không khả dụng.
message_count_synced_at string|null
Thời gian đồng bộ đếm tin nhắn cuối cùng ở định dạng ISO-8601, hoặc null trước khi đồng bộ.
mailbox_limit.limit integer
Giới hạn hộp thư hoạt động cho nhà cung cấp này; -1 có nghĩa là không giới hạn.
mailbox_limit.limit_label string
Nhãn hiển thị cho giới hạn hộp thư.
mailbox_limit.active_count integer
Số lượng hộp thư hoạt động cho nhà cung cấp này.
mailbox_limit.paused_count integer
Số lượng hộp thư bị tạm dừng cho nhà cung cấp này.
mailbox_limit.paused_mailboxes array<string>
Địa chỉ bị tạm dừng do giới hạn hộp thư.
mailbox_limit.remaining integer
Số khe hộp thư hoạt động còn lại; -1 có nghĩa là không giới hạn. Đây không phải là hạn ngạch yêu cầu API.
mailbox_limit.remaining_label string
Hiển thị nhãn cho các khe hộp thư còn lại.
mailbox_limit.reached boolean
Liệu giới hạn hộp thư hoạt động đã đạt được chưa.
mailbox_limit.blocked boolean
Liệu giới hạn hộp thư hoạt động có bằng không hay không.
mailbox_limit.provider string|null
Nhà cung cấp mà giới hạn hộp thư áp dụng.
messages[].id string
ID tin nhắn không rõ được sử dụng bởi các điểm cuối tin nhắn đơn, xóa và tệp đính kèm.
messages[].is_seen boolean
Liệu tin nhắn có được đánh dấu là đã đọc hay không.
messages[].subject string
Tiêu đề tin nhắn.
messages[].from string
Tên hiển thị hoặc địa chỉ của người gửi.
messages[].from_email string
Địa chỉ email người gửi.
messages[].receivedAt string
Thời gian nhận theo múi giờ của ứng dụng, định dạng YYYY-MM-DD HH:mm:ss.
messages[].otp string|null
Phát hiện mã một lần khi có sẵn và được phép; nếu không thì null.
messages[].otp_locked boolean
Liệu mã một lần được phát hiện có bị ẩn bởi quyền tính năng hay không.
messages[].verification_link string|null
Phát hiện URL xác minh khi có sẵn và được phép; nếu không thì null.
messages[].verification_link_locked boolean
Liệu liên kết xác minh được phát hiện có bị ẩn bởi quyền tính năng hay không.
messages[].from_name string|null
Trường tóm tắt Outlook: tên người gửi gốc. Không có trong tóm tắt tiêu chuẩn và Gmail.
messages[].snippet string|null
Trường tóm tắt Outlook: bản xem trước tin nhắn ngắn.
messages[].received_at string|null
Trường tóm tắt Outlook: thời gian nhận theo chuẩn ISO-8601, nếu biết.
messages[].has_attachments boolean
Trường tóm tắt Outlook: liệu có siêu dữ liệu tệp đính kèm hay không. Tính khả dụng tải xuống được kiểm tra riêng.
GET https://v1.tempmailg.com/api/messages/{messageId}
#

Lấy tin nhắn đơn

Truy xuất một tin nhắn thuộc sở hữu bằng ID tin nhắn không rõ ràng của nó. Trả về các định dạng nội dung và siêu dữ liệu tệp đính kèm. Các trường nội dung phụ thuộc vào định dạng tin nhắn; Outlook thêm các trường đặc thù của nhà cung cấp được liệt kê bên dưới.

Tham số 2
Tham số Vị trí Loại Trạng thái Mô Tả
messageId path string bắt buộc
ID tin nhắn duy nhất được trả về trong danh sách tin nhắn.
X-Mailbox-Unlock header string tùy chọn
Tiêu đề, chỉ dành cho các hộp thư được bảo vệ: sử dụng một unlock_token để đọc. Đầu tiên POST pin và scope=read tới URL mở khóa PIN. Giữ xác thực Bearer thông thường của bạn. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Đọc một tin nhắn
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
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:11",
        "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"
            }
        ]
    }
}
Các trường phản hồi
Trường Loại Mô Tả
status boolean
Liệu thao tác có thành công hay không.
data.id string
ID tin nhắn không công khai.
data.is_seen boolean
Trạng thái đã đọc của tin nhắn. Đọc có thể đánh dấu là đã xem; dữ liệu đã lưu trong bộ nhớ đệm có thể phản ánh trạng thái trước đó.
data.subject string
Tiêu đề tin nhắn.
data.from string
Tên hiển thị hoặc địa chỉ của người gửi.
data.from_email string
Địa chỉ email người gửi.
data.to string
Địa chỉ hộp thư người nhận.
data.mailbox_provider string
Nhà cung cấp hộp thư: standard, gmail_alias, hoặc outlook_alias.
data.receivedAt string
Thời gian nhận theo múi giờ của ứng dụng, định dạng YYYY-MM-DD HH:mm:ss.
data.html boolean
Liệu tin nhắn có phần thân HTML hay không.
data.html_content string
Thân HTML khi có. Các tin nhắn tiêu chuẩn không có HTML có thể bỏ qua trường này. Xem nội dung tin nhắn là không đáng tin cậy.
data.text_content string
Nội dung văn bản khi có; Các tin nhắn tiêu chuẩn có thể chứa văn bản đã được escape trong phần tử pre hoặc bỏ qua trường này.
data.content string
Nội dung ưu tiên để hiển thị, thường là HTML khi có sẵn.
data.attachments array
Siêu dữ liệu tệp đính kèm, hoặc một mảng rỗng. Tải xuống yêu cầu xác thực bình thường và ủy quyền PIN áp dụng.
data.attachments[].name string
Tên tệp để mã hóa URL thành một đoạn đường dẫn duy nhất khi tải xuống.
data.attachments[].size integer
Kích thước tệp đính kèm tính bằng byte.
data.attachments[].url string
URL tải xuống API Người dùng đã xác thực được thêm vào các tệp đính kèm với tên tệp. URL không đảm bảo rằng tệp cục bộ có sẵn.
data.attachments[].extension string
Trường siêu dữ liệu Standard/Gmail: phần mở rộng tệp khi được cung cấp.
data.attachments[].id string
Trường siêu dữ liệu Outlook: ID tệp đính kèm của nhà cung cấp.
data.attachments[].content_type string
Trường siêu dữ liệu Outlook: loại nội dung MIME.
data.from_name string|null
Trường chi tiết Outlook: tên người gửi gốc.
data.to_email string|null
Trường chi tiết Outlook: địa chỉ người nhận gốc.
data.received_at string|null
Trường chi tiết Outlook: thời gian nhận theo chuẩn ISO-8601.
data.has_html boolean
Trường chi tiết Outlook: liệu có tồn tại phần thân HTML hay không.
DELETE https://v1.tempmailg.com/api/messages/{messageId}
#

Xóa tin nhắn

Xóa một tin nhắn thuộc sở hữu đơn lẻ.

Tham số 3
Tham số Vị trí Loại Trạng thái Mô Tả
messageId path string bắt buộc
Chuỗi ID tin nhắn duy nhất để xóa vĩnh viễn.
X-Mailbox-Unlock header string tùy chọn
Tiêu đề, chỉ dành cho hộp thư được bảo vệ: sử dụng unlock_token xóa một lần. Đầu tiên POST pin, scope=delete và action/target_id được trả về bởi phản hồi 423 tới URL mở khóa PIN. Token đọc không thể xóa. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string tùy chọn
Yêu cầu cho việc tạo hoặc xóa được bảo vệ bằng PIN: một khóa ổn định từ 16 đến 128 ký tự. Thử lại yêu cầu giống hệt với cùng một khóa để tránh công việc trùng lặp.
Xóa một tin nhắn
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
200 OK • JSON
{
    "status": true,
    "message": "Message was deleted successfully."
}
Các trường phản hồi
Trường Loại Mô Tả
status boolean
Liệu thao tác có thành công hay không.
message string
Kết quả của việc xóa. Một tài nguyên không tồn tại sẽ trả về HTTP 404.
GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}
#

Tải xuống tệp đính kèm

Tải xuống tệp đính kèm từ tin nhắn thuộc sở hữu.

Tham số 3
Tham số Vị trí Loại Trạng thái Mô Tả
messageId path string bắt buộc
ID của tin nhắn chứa tệp.
filename path string bắt buộc
Tên tệp và phần mở rộng của tệp đính kèm để tải xuống.
X-Mailbox-Unlock header string tùy chọn
Tiêu đề, chỉ dành cho các hộp thư được bảo vệ: sử dụng một unlock_token để đọc. Đầu tiên POST pin và scope=read tới URL mở khóa PIN. Giữ xác thực Bearer thông thường của bạn. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Thành công trả về byte của tệp, không phải JSON. Các tệp quá lớn trả về HTTP 403; các tệp địa phương bị thiếu hoặc không khả dụng trả về HTTP 404. URL-encode tên tệp như một đoạn đường dẫn duy nhất. Siêu dữ liệu đính kèm một mình không đảm bảo khả năng tải xuống.
Tải xuống tệp đính kèm
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
Hành vi tải xuống Điểm cuối này trả về tệp được yêu cầu trực tiếp thay vì một cơ thể JSON.
Các trường phản hồi
Trường Loại Mô Tả
Content-Disposition header
Phản hồi thành công tải xuống tên tệp đã yêu cầu.
body binary
Dữ liệu tệp dưới dạng byte khi thành công, không phải JSON. Lỗi trả về JSON với trạng thái không phải 2xx.

Giới hạn tốc độ & Hạn ngạch

Giám sát ngân sách yêu cầu thời gian thực, giới hạn tốc độ và hạn ngạch tài khoản mà không tiêu tốn tín dụng.

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

Giới hạn tốc độ & Hạn ngạch

Kiểm tra giới hạn tốc độ và trạng thái hạn ngạch hiện tại của bạn mà không tiêu tốn bất kỳ lượt sử dụng API nào. Điểm cuối này không tính vào hạn ngạch và không trừ tín dụng API hàng tháng (giới hạn bảo vệ lạm dụng: 60 yêu cầu/phút).

X-RateLimit-* mô tả ngân sách yêu cầu được chỉ định; X-Quota-* mô tả dung lượng hàng tháng và đã mua khi có sẵn. X-Mailbox-RateLimit-* báo cáo ngân sách tạo/cập nhật hộp thư riêng biệt. Một việc từ chối chỉ dành cho hộp thư sử dụng phạm vi hộp thư và cửa sổ thử lại riêng của nó. Các từ chối giới hạn phút có thể bỏ qua thông tin quota. Retry-After chỉ được bao gồm cho lần thử lại có thời gian; việc truy cập bị vô hiệu hoá có thể yêu cầu thay đổi tài khoản. Trong phản hồi trạng thái thành công này, data.limit, data.remaining và data.reset mô tả ngân sách phút của tài khoản, không phải tín dụng có thể chi tiêu. Đối tượng data.quota mô tả hạn mức hàng tháng, số dư tín dụng và việc sử dụng. Các trường data.monthly_limit, data.monthly_remaining và data.purchased_credits hiện có vẫn là bí danh của các trường quota tương ứng. Kiểm tra trạng thái thành công không cho phép thực hiện một thao tác API khác. Các thao tác vẫn yêu cầu quyền truy cập đã bật, hạn ngạch khả dụng và được chấp nhận qua tất cả các giới hạn áp dụng. Bản sao hạn ngạch không đảm bảo dung lượng đã được đặt trước bởi một yêu cầu đang tiến hành.
Kiểm tra trạng thái giới hạn tốc độ
curl --request GET \
  --url 'https://v1.tempmailg.com/api/rate-limit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Phản hồi minh họa sử dụng dữ liệu tổng hợp. ID, địa chỉ, token, dấu thời gian, giới hạn và số lượng kế hoạch thay đổi. Thời gian sống mẫu không ghi đè mặc định kế hoạch của bạn. Mô tả các trường phản hồi xác định các trường có thể null và các trường đặc thù của nhà cung cấp.

Ví dụ về phản hồi
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"
        }
    }
}
Các trường phản hồi
Trường Loại Mô Tả
data.limit integer|string
Giới hạn yêu cầu tài khoản mỗi phút. Chuỗi unlimited biểu thị ngân sách phút không giới hạn; điều này độc lập với hạn mức hàng tháng.
data.remaining integer|string
Số khe ngân sách phút còn lại trong tài khoản, hoặc chuỗi unlimited. Giá trị dương không có nghĩa là còn lại tín dụng API.
data.reset integer
Giây cho cửa sổ phút của tài khoản, không phải việc đặt lại hạn ngạch hàng tháng. Ngân sách phút bị vô hiệu hoá hoặc không giới hạn có thể giữ giá trị danh nghĩa 60 giây; điều này không hứa hẹn quyền truy cập sau khi chờ đợi.
data.plan string
Thẻ gói hiện tại. Tên gói có thể đọc được được cung cấp riêng trong data.quota.plan_name.
data.quota.enabled boolean
Cho biết việc truy cập API toàn cầu và theo gói/điểm tín dụng có được bật hay không. Điều này không cho biết dung lượng còn lại hoặc thay thế công tắc API của người dùng.
data.quota.user_api_status boolean
Liệu người dùng đã bật công tắc API Người dùng của họ hay chưa. Các hoạt động yêu cầu công tắc này cũng như quyền truy cập đã bật và dung lượng khả dụng.
data.quota.plan_name string
Tên dễ đọc của gói hiện tại.
data.quota.period string
Thời gian sử dụng theo tháng lịch ở định dạng YYYY-MM, sử dụng múi giờ của ứng dụng; không nhất thiết là kỳ thanh toán của thuê bao.
data.quota.base_limit integer
Hạn mức gói hàng tháng cơ bản. Giá trị -1 có nghĩa là không giới hạn.
data.quota.extra_requests integer
Phép dùng hàng tháng bổ sung được cấp cho kỳ sử dụng hiện tại; tách biệt khỏi các tín dụng đã mua.
data.quota.monthly_limit integer
Phép cho phép cơ bản cộng với các yêu cầu bổ sung trong kỳ hiện tại. Giá trị -1 có nghĩa là không giới hạn. Tín dụng đã mua không được bao gồm.
data.quota.monthly_remaining integer|null
Số dư hạn mức hàng tháng có giới hạn còn lại, hoặc null khi hạn mức hàng tháng không giới hạn. Null không được hiểu là zero.
data.quota.used integer
Các hoạt động API thành công, được tính trong khoảng thời gian sử dụng hiện tại, bao gồm các hoạt động sử dụng tín dụng. Kiểm tra trạng thái không làm tăng giá trị này.
data.quota.purchased_credits integer
Số dư tín dụng hiện tại, bao gồm tín dụng thưởng của gói đang hoạt động. Tín dụng thưởng không được cộng thêm vào số dư này lần thứ hai.
data.quota.bonus_credits integer
Phần thưởng kế hoạch hoạt động của số dư tín dụng; chi tiết của purchased_credits, không phải dung lượng bổ sung.
data.quota.direct_purchased_credits integer
Số dư tín dụng không bao gồm phần thưởng gói đang hoạt động. Giá trị này cộng với bonus_credits bằng purchased_credits.
data.quota.remaining integer|null
Số dư hạn mức hàng tháng còn lại cộng với số dư tín dụng hiện tại, không tính trùng lặp các phần thưởng. Null có nghĩa là hạn mức hàng tháng không giới hạn. Quyền tính năng cá nhân và các giới hạn yêu cầu khác vẫn áp dụng.
data.quota.unlimited boolean
Liệu hạn mức hàng tháng có không giới hạn hay không. Điều này không làm cho ngân sách phút của tài khoản hoặc các giới hạn tính năng khác trở nên không giới hạn.
data.quota.usage_percent integer
Phần trăm làm tròn tương thích với bảng điều khiển từ 0 đến 100: đã sử dụng chia cho (đã sử dụng + còn lại), nhân với 100. Nó bao gồm khả năng tín dụng khả dụng, vì vậy việc nạp lại có thể làm giảm phần trăm. Giá trị là 0 cho hạn ngạch không giới hạn hoặc pool có kích thước bằng 0; nó không phải là phần trăm giới hạn tốc độ mỗi phút hoặc quyết định truy cập.
data.quota.reset_at string
Dấu thời gian ISO-8601 kèm độ lệch múi giờ cho lần đặt lại hạn ngạch tháng lịch tiếp theo. Đây không phải là ngày hết hạn đăng ký, và việc đặt lại hàng tháng không làm đầy lại các tín dụng đã mua.
status string
Kết quả thành công nguyên văn cho điểm cuối trạng thái này. Các điểm cuối hộp thư thành công khác sử dụng giá trị boolean true.
data.monthly_limit integer
Bí danh tương thích của trường data.quota tương ứng; không thêm lại khi tính toán số dư.
data.monthly_remaining integer|null
Bí danh tương thích của trường data.quota tương ứng; không thêm lại khi tính toán số dư.
data.purchased_credits integer
Bí danh tương thích của trường data.quota tương ứng; không thêm lại khi tính toán số dư.

Bảo vệ PIN hộp thư

Nhập PIN để tiếp tục. Hộp thư của bạn sẽ được mở khóa trong suốt phiên làm việc trên trang web này.

Bạn có chấp nhận cookie không?

Chúng tôi sử dụng cookie để nâng cao trải nghiệm duyệt web của bạn. Bằng cách sử dụng trang web này, bạn đồng ý với chính sách cookie của chúng tôi.

Nhiều hơn