Liosta socraithe tobchumtha
- Oscail do leathanach bainistíochta API agus cruthaigh do eochair API pearsanta
- Cóip an URL Bun API Úsáideora a thaispeántar ansin, mar shampla https://v1.tempmailg.com/api.
- Seol gach iarratas chuig an óstach API sin le Authorization: Bearer YOUR_USER_API_KEY agus Accept: application/json.
- Rianaigh do chuóta iarratas míosúil ón leathanach painéil céanna agus ó na ceanntásca chuóta nuair atá siad ar fáil i bhfreagraí API úsáideora. Ní thagann ach iarratais rathúla 2xx san áireamh i gcuóta.
Rochtain eochair API
Logáil isteach chun do eochair API phearsanta a chruthú agus mionsonraí cuóta beo a fháil.
Sruth údaráis
- Cruthaigh do eochair API pearsanta ó leathanach Bainistíochta API an bhord.
- Cuir an eochair ina rochtáin Bearer in gach iarratas.
- Úsáid an Bonn URL API úsáideora atá tiomnaithe a taispeántar ar do leathanach Bainistíochta API.
- Athghintiúnadh an eochair aon uair a theastaíonn uait an ceann sean a dhíchuibhriú agus tosú ag úsáid eochair nua láithreach.
Ceannlínte riachtanacha
Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json
Ceanntásca Teorainn Ráta & Cota
Léiríonn ceanntásca teorainn ráta an buiséad iarratais atá léirithe. Cuirtear ceanntásca cuóta san áireamh nuair atá faisnéis cuóta ar fáil; ní ríomhann diúltacháin teorainn nóiméad do do chuóta míosúil iomlán.
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— Uasmhéid na n-iarratas a cheadaítear in aghaidh an nóiméid (RPM) do do phlean.X-RateLimit-Remaining— Iarratais RPM atá fágtha i bhfuinneog nóiméad reatha.X-RateLimit-Reset— Stampa ama Unix nuair a athshocraítear fuinneog teorainn ráta an nóiméid reatha.X-Quota-Limit— Iomlán na cappaicithe creidmheasa míosúil agus ceannaithe do do chuntas.X-Quota-Remaining— Iarratais API atá fágtha ar fáil sa mhí reatha.X-Quota-Used— Iomlán na n‑iarratas API a chaiteadh le linn na tréimhse billeála reatha.X-Quota-Reset— Stampa ama ISO-8601 nuair a athshocraítear do chuóta míosúil.X-RateLimit-Scope— An buiséad a thuairiscítear ag na ceanntásca: cuntas, ip, status_endpoint, nó bosca poist.X-Mailbox-RateLimit-*— Buiséad cruthú/nuaúite bosca poist ar leith. Coinníonn freagraí bosca poist rathúil RPM an chuntais i X-RateLimit-*; úsáideann diúltú bosca poist amháin raon bosca poist agus a fhuinneog athtriail féin.Retry-After— Soicind go dtí go bhfuil athiarracht ama cuí. D'fhéadfadh sé go dteastaíonn athrú cuntais in ionad plean díchumasaithe nó cóta ídithe, mar sin ní bhíonn an ceanntásc seo i gcónaí i láthair.503 protection_unavailable— Tá stóráil nó comhordú cosanta API gan fáil go sealadach. Bain triail eile as níos déanaí; ní tharla teip íocaíochta ná deibhirt creidmheasa.
Bainistíocht Bosca Poist
Faigh fearainn ceadaithe, cruthaigh nó athraigh boscaí poist, roghnaigh tréimhsí ceadaithe, agus scrios seoltaí úinéireachta.
Liosta na nDomhain Ceadaithe
Liostáil na fearainn atá ar fáil chun ríomhphoist shealadacha a chruthú. Scag de réir chineáil chun féachaint ar na fearainn saor, préimhe, nó saincheaptha a thacaíonn le do phlean síntiúis.
| Paraiméadar | Suíomh | Sorc | Stádas | Cur Síos |
|---|---|---|---|---|
type
|
query | string | roghnach |
Scagaire sraithe fearainn. Úsáidtear gach ceann nuair atá rochtain fearainn phréime cumasaithe, nó saor. Luachanna aitheanta: free, basic, pro, premium, custom, ultimate, all
Réamhshocrú:
Spleách ar chuntas
|
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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
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
}
]
}
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
status |
boolean | Cibé an d'éirigh leis an gníomh. |
data.requested_type |
string | Scagaire fearainn curtha i bhfeidhm. |
data.plan |
string | Clib an phlean reatha. |
data.plan_name |
string | Ainm inléite den phlean reatha. |
data.allowed_types |
array<string> | Scagairí fearainn atá ar fáil don chuntas seo. Is féidir scagaire aitheanta a chur i gcois do phlean. |
data.domains |
array | Fearainn inroghnaithe tar éis scagtha; tá eagar folamh bailí. |
data.domains[].domain |
string | Ainm fearainn inroghnach. |
data.domains[].type |
string | Lipéad sraith fearainn inléite. |
data.domains[].custom |
boolean | Cé acu an bhfuil sé seo ina fhearann saincheaptha. |
Cruthaigh Bosca Ríomhphoist Sealadach
Cruthaigh bosca poist sealadach úinéir. Fág ainm úsáideora agus fearann ar lár le haghaidh gineadh randamach, nó soláthair ainm úsáideora saincheaptha ceadaithe agus fearann ceadaithe. Is féidir leis an bparaiméadar soláthraí Gmail nó Outlook a roghnú le haghaidh gineadh ailias.
| Paraiméadar | Suíomh | Sorc | Stádas | Cur Síos |
|---|---|---|---|---|
username
|
body | string | roghnach |
Ainm úsáideora saincheaptha roghnach: 2 go 64 litir ASCII, digití, poncanna, íoslíne nó fleiscíní. Éilíonn sé cead an phláin; glacann sé le custom_username freisin.
Réamhshocrú:
Gintear go randamach
|
domain
|
body | string | roghnach |
Ceann de na fearainn ceadaithe a thugann GET /domains ar ais. Roghnóidh neamhchur fearann ceadaithe randamach.
Réamhshocrú:
Fearann ceadaithe randamach
|
lifetime
|
body | string | roghnach |
luachanna ceadaithe:
10m — 10 Nóiméad
1h — 1 Uair
2h — Dó uair an chloig
1d — Lá Aon
1w — 1 Seachtain
1m — 30 Lá
3m — 90 lá
6m — 180 Lá
1y — 365 Lá
unlimited — Gan theorainn
Réamhshocrú:
Saolré réamhshocraithe an phlean
|
provider
|
body | string | roghnach |
Soláthraí bosca poist: caighdeánach, gmail_alias, nó outlook_alias.
Réamhshocrú:
standard
|
pin_enabled
|
body | boolean | roghnach |
Cosaint PIN roghnach don bhosca poist nua, nuair a cheadaítear é ag do phlean. Ní athraíonn sé an PIN de bhosca poist atá ann cheana.
Réamhshocrú:
false
|
pin
|
body | string | roghnach |
Éigeantach nuair atá pin_enabled fíor: PIN de 6 go 8 digit, seolta mar teaghrán chun na nialais tosaigh a chaomhnú.
|
pin_confirmation
|
body | string | roghnach |
Éigeantach nuair atá pin_enabled fíor. Ní mór go meaitseáil go cruinn leis an bpin.
|
Idempotency-Key
|
header | string | roghnach |
Riachtanach le haghaidh cruthú nó scriosadh faoi chosaint PIN: eochair chobhsaí 16 go 128 carachtar. Déan an t-iarratas céanna a athdhéanamh leis an eochair chéanna chun obair dhúbailte a sheachaint.
|
username (ainm úsáideora saincheaptha má cheadaítear é ag an bplean), domain (fearann ceadaithe, m.sh. example.com), lifetime (luachanna ceadaithe: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Fág an tréimhse beatha ar lár, nó fág sé folamh, chun an Tréimhse Beatha Ríomhphoist Réamhshocraithe a úsáid atá cumraithe don phlean míosúil/bliantúil reatha. Seol tréimhse beatha ceadaithe mar shampla 1h chun an réamhshocrú sin a shárú. Úsáidtear gan teorainn ach amháin nuair a bhíonn sé cumraithe mar réamhshocrú an phlean nó nuair a iarrtar go sainráite agus tá sé ceadaithe. Glactar freisin le paraiméadair an choirp mailbox_lifetime agus email_lifetime; bíonn an chéad luach neamhfholamh ag bua in ord seo: lifetime, mailbox_lifetime, email_lifetime. Tuairiscíonn luachanna neamhbhailí nó neamhcheadaithe HTTP 422 in ionad roghnú réamhshocraithe go ciúin.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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
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:21+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:21+00:00",
"email_token": "encrypted-email-token"
}
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
status |
boolean | Cibé an d'éirigh leis an gníomh. |
data.id |
integer | ID Bosca Ríomhphoist. Tá IDanna, seoltaí agus comharthaí ginte difriúil do gach bosca ríomhphoist. |
data.pin_protected |
boolean | Cé acu an bhfuil cosaint PIN ag an mbosca poist seo. Ní thugtar PIN ná haon hash PIN ar ais. |
data.email |
string | Seoladh iomlán bosca poist a ghinte. |
data.domain |
string | Fearann an bhosca poist a ghintear. |
data.provider |
string | Soláthraí bosca poist: caighdeánach, gmail_alias, nó outlook_alias. |
data.expire_at |
string|null | Dáta éaga éifeachtach mar timestamp ISO-8601, nó null le haghaidh bosca poist gan teorainn. |
data.expires_in_seconds |
number|null | Soicindí neamh-dhíobhálacha fágtha nuair a ríomhfar; is féidir soicindí codánacha. Null ciallaíonn gan teorainn, ní náid. |
data.mailbox_state |
string | Stádas reatha an bhosca poist: gníomhach, curtha ar sos, caite, nó neamhghníomhach. |
data.receiving_enabled |
boolean | Cé acu an glacann an bosca poist seo teachtaireachtaí isteach faoi láthair. |
data.message_count |
integer | Líon teachtaireachtaí iomlán aitheanta; is féidir leis cur i láthair an sioncrónaithe bosca poist deiridh. |
data.unread_message_count |
integer | Líon na dteachtaireachtaí gan léamh aitheanta; d'fhéadfadh sé léiriú ar an sioncrónú bosca poist is déanaí. |
data.last_message_received_at |
string|null | An t-am deiridh a fuarthas teachtaireacht i bhformáid ISO-8601, nó null nuair nach bhfuil sé ar fáil. |
data.message_count_synced_at |
string|null | Am sioncrónaithe deiridh an chúntais teachtaireachtaí i bhformáid ISO-8601, nó null roimh shioncrónú. |
data.created_at |
string|null | Am cruthaithe bosca poist i bhformáid ISO-8601. |
data.email_token |
string | Tagairt bosca poist criptithe teimhneach. Ní ionadaíonn sé fíordheimhniú Bearer, seiceálacha úinéireachta ná údarú PIN. |
data.pin_grant |
object | Coinníollach: cruthaíonn cruthú bosca poist gníomhach faoi chosaint PIN an cead léite seo; i gcruthú gnáth gan chosaint, ní chuireann sé ar fáil. |
data.pin_grant.mailbox_id |
integer | Aitheantas Bosca Poist a bhfuil an cead léite coinníollach ceangailte leis. |
data.pin_grant.unlock_token |
string | Céad léite teimhneach do X‑Mailbox‑Unlock leis an dintiúir úinéara céanna. Coinnigh é príobháideach agus i gcuimhne; ní údaróidh cead léite scrios. |
data.pin_grant.scope |
string | An raon léite don dheon cruthaithe coinníollach. |
data.pin_grant.idle_timeout_seconds |
integer | Am díomhaoin ceadaithe don cheadúnas léite, de ghnáth 3600 soicind. |
data.pin_grant.absolute_timeout_seconds |
integer | Uasmhéid saoil an chead léite, de ghnáth 86400 soicind. |
data.pin_grant.expires_at |
string | Am éaga reatha an chead léite i bhformáid ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Dáta dlíthe iomlán an chead léite i bhformáid ISO-8601. Is féidir le hathruithe slándála an cead a chúlghairm níos luaithe. |
Nuashonraigh / Athraigh Bosca Poist
Cruthaigh nó roghnaigh bosca poist ag an ainm úsáideora agus an fearann nua tar éis fíorú úinéireachta an bhosca poist reatha. Ní athainmníonn sé seo an bosca poist sean ná ní athraíonn sé a shaolré i láthair. Nuair a bhíonn an sprioc difriúil, fanann an bosca poist sean i stair agus d'fhéadfadh sé a bheith curtha ar sos de réir teorainneacha bosca poist gníomhach. Má athúsáideann tú do sprioc ghníomhach féin, cuirtear ar ais a shaolré iarrtha nó réamhshocrú an phlean.
| Paraiméadar | Suíomh | Sorc | Stádas | Cur Síos |
|---|---|---|---|---|
email
|
path | string | riachtanach |
Seoladh ríomhphoist iomlán reatha den bhosca poist atá i gceannas le hathrú. Códáil URL gach deighleog conair; códáil comhartha plus mar %2B.
|
username
|
path | string | riachtanach |
Ainm úsáideora nua atá ag teastáil: 2 go 64 carachtar alfa-uimhriúil; faoi réir ceadainm úsáideora saincheaptha.
|
domain
|
path | string | riachtanach |
Ainm fearainn nua ceadaithe.
|
lifetime
|
body | string | roghnach |
luachanna ceadaithe:
10m — 10 Nóiméad
1h — 1 Uair
2h — Dó uair an chloig
1d — Lá Aon
1w — 1 Seachtain
1m — 30 Lá
3m — 90 lá
6m — 180 Lá
1y — 365 Lá
unlimited — Gan theorainn
Réamhshocrú:
Saolré réamhshocraithe an phlean
|
pin_enabled
|
body | boolean | roghnach |
Cosaint PIN roghnach don bhosca poist nua, nuair a cheadaítear é ag do phlean. Ní athraíonn sé an PIN de bhosca poist atá ann cheana.
Réamhshocrú:
false
|
pin
|
body | string | roghnach |
Éigeantach nuair atá pin_enabled fíor: PIN de 6 go 8 digit, seolta mar teaghrán chun na nialais tosaigh a chaomhnú.
|
pin_confirmation
|
body | string | roghnach |
Éigeantach nuair atá pin_enabled fíor. Ní mór go meaitseáil go cruinn leis an bpin.
|
Idempotency-Key
|
header | string | roghnach |
Riachtanach le haghaidh cruthú nó scriosadh faoi chosaint PIN: eochair chobhsaí 16 go 128 carachtar. Déan an t-iarratas céanna a athdhéanamh leis an eochair chéanna chun obair dhúbailte a sheachaint.
|
X-Mailbox-Unlock
|
header | string | roghnach |
Ceanntásc, boscaí poist cosanta amháin: bain úsáid as unlock_token léite. Seol POST pin agus scope=read chuig URL unlock PIN. Coinnigh d'fhíordheimhniú Bearer gnách. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
lifetime (luachanna ceadaithe: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Fág an tréimhse beatha ar lár, nó fág sé folamh, chun an Tréimhse Beatha Ríomhphoist Réamhshocraithe a úsáid atá cumraithe don phlean míosúil/bliantúil reatha. Seol tréimhse beatha ceadaithe mar shampla 1h chun an réamhshocrú sin a shárú. Úsáidtear gan teorainn ach amháin nuair a bhíonn sé cumraithe mar réamhshocrú an phlean nó nuair a iarrtar go sainráite agus tá sé ceadaithe. Glactar freisin le paraiméadair an choirp mailbox_lifetime agus email_lifetime; bíonn an chéad luach neamhfholamh ag bua in ord seo: lifetime, mailbox_lifetime, email_lifetime. Tuairiscíonn luachanna neamhbhailí nó neamhcheadaithe HTTP 422 in ionad roghnú réamhshocraithe go ciúin.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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
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:21+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:21+00:00",
"email_token": "encrypted-email-token"
}
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
status |
boolean | Cibé an d'éirigh leis an gníomh. |
data.id |
integer | ID Bosca Ríomhphoist. Tá IDanna, seoltaí agus comharthaí ginte difriúil do gach bosca ríomhphoist. |
data.pin_protected |
boolean | Cé acu an bhfuil cosaint PIN ag an mbosca poist seo. Ní thugtar PIN ná haon hash PIN ar ais. |
data.email |
string | Seoladh iomlán bosca poist a ghinte. |
data.domain |
string | Fearann an bhosca poist a ghintear. |
data.provider |
string | Soláthraí bosca poist: caighdeánach, gmail_alias, nó outlook_alias. |
data.expire_at |
string|null | Dáta éaga éifeachtach mar timestamp ISO-8601, nó null le haghaidh bosca poist gan teorainn. |
data.expires_in_seconds |
number|null | Soicindí neamh-dhíobhálacha fágtha nuair a ríomhfar; is féidir soicindí codánacha. Null ciallaíonn gan teorainn, ní náid. |
data.mailbox_state |
string | Stádas reatha an bhosca poist: gníomhach, curtha ar sos, caite, nó neamhghníomhach. |
data.receiving_enabled |
boolean | Cé acu an glacann an bosca poist seo teachtaireachtaí isteach faoi láthair. |
data.message_count |
integer | Líon teachtaireachtaí iomlán aitheanta; is féidir leis cur i láthair an sioncrónaithe bosca poist deiridh. |
data.unread_message_count |
integer | Líon na dteachtaireachtaí gan léamh aitheanta; d'fhéadfadh sé léiriú ar an sioncrónú bosca poist is déanaí. |
data.last_message_received_at |
string|null | An t-am deiridh a fuarthas teachtaireacht i bhformáid ISO-8601, nó null nuair nach bhfuil sé ar fáil. |
data.message_count_synced_at |
string|null | Am sioncrónaithe deiridh an chúntais teachtaireachtaí i bhformáid ISO-8601, nó null roimh shioncrónú. |
data.created_at |
string|null | Am cruthaithe bosca poist i bhformáid ISO-8601. |
data.email_token |
string | Tagairt bosca poist criptithe teimhneach. Ní ionadaíonn sé fíordheimhniú Bearer, seiceálacha úinéireachta ná údarú PIN. |
data.pin_grant |
object | Coinníollach: cruthaíonn cruthú bosca poist gníomhach faoi chosaint PIN an cead léite seo; i gcruthú gnáth gan chosaint, ní chuireann sé ar fáil. |
data.pin_grant.mailbox_id |
integer | Aitheantas Bosca Poist a bhfuil an cead léite coinníollach ceangailte leis. |
data.pin_grant.unlock_token |
string | Céad léite teimhneach do X‑Mailbox‑Unlock leis an dintiúir úinéara céanna. Coinnigh é príobháideach agus i gcuimhne; ní údaróidh cead léite scrios. |
data.pin_grant.scope |
string | An raon léite don dheon cruthaithe coinníollach. |
data.pin_grant.idle_timeout_seconds |
integer | Am díomhaoin ceadaithe don cheadúnas léite, de ghnáth 3600 soicind. |
data.pin_grant.absolute_timeout_seconds |
integer | Uasmhéid saoil an chead léite, de ghnáth 86400 soicind. |
data.pin_grant.expires_at |
string | Am éaga reatha an chead léite i bhformáid ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Dáta dlíthe iomlán an chead léite i bhformáid ISO-8601. Is féidir le hathruithe slándála an cead a chúlghairm níos luaithe. |
Scrios Bosca Ríomhphoist
Scrios bosca poist úinéir agus cuir i bhfeidhm a ghlanadh teachtaireachtaí agus comhad. D'fhéadfadh taifid bosca poist coimeádta a bheith bog-dealraithe go intí; ní féidir an seoladh a úsáid níos mó tríd an API.
| Paraiméadar | Suíomh | Sorc | Stádas | Cur Síos |
|---|---|---|---|---|
email
|
path | string | riachtanach |
Seoladh ríomhphoist iomlán den bhosca poist úinéir le scriosadh. Códú URL an seoladh; códú comhartha plus mar %2B.
|
X-Mailbox-Unlock
|
header | string | roghnach |
Ceanntásc, boscaí poist cosanta amháin: bain úsáid as an unlock_token scriosadh aon‑úsáid. An chéad POST pin, scope=delete agus an action/target_id a thugtar ar ais ag an bhfreagra 423 chuig an URL unlock PIN. Ní féidir le comhartha léite a scriosadh. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | roghnach |
Riachtanach le haghaidh cruthú nó scriosadh faoi chosaint PIN: eochair chobhsaí 16 go 128 carachtar. Déan an t-iarratas céanna a athdhéanamh leis an eochair chéanna chun obair dhúbailte a sheachaint.
|
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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
status |
boolean | Cibé an d'éirigh leis an gníomh. |
message |
string | Toradh an scriosta. Aimsíonn acmhainn ar iarraidh cód HTTP 404. |
Gmail & Outlook Aliasanna
Gin boscaí ríomhphoist ailias Gmail agus Outlook/Hotmail le dea-cháil.
Cruthaigh Alias Gmail
Cruthaigh ailias Gmail nua, bosca poist sealadach a bhfuil úinéir air an t-úsáideoir fíordheimhnithe.
| Paraiméadar | Suíomh | Sorc | Stádas | Cur Síos |
|---|---|---|---|---|
mode
|
body | string | roghnach |
Mód gineadh: auto, dot, plus, nó plus_dot. Glacann sé freisin le gmail_alias_mode. Mura ceadaítear roghnú stíle, úsáidtear auto.
Réamhshocrú:
auto
|
username
|
body | string | roghnach |
Iarmhír saincheaptha roghnach: 2 go 32 litir ASCII nó digit, caighdeánaithe go dtí an cás íochtair; faoi cheadúnas gné. Glacann sé freisin le custom_username nó alias_username.
Réamhshocrú:
Uatho-ghinte
|
domain
|
body | string | roghnach |
Úsáid randamach, gmail.com nó googlemail.com; glacfar le alias_domain freisin. Má dhéantar neamhaird nó nach bhfuil cead roghnú fearainn ar fáil, úsáidtear randamach.
Réamhshocrú:
random
|
lifetime
|
body | string | roghnach |
luachanna ceadaithe:
10m — 10 Nóiméad
1h — 1 Uair
2h — Dó uair an chloig
1d — Lá Aon
1w — 1 Seachtain
1m — 30 Lá
3m — 90 lá
6m — 180 Lá
1y — 365 Lá
unlimited — Gan theorainn
Réamhshocrú:
Saolré réamhshocraithe an phlean
|
pin_enabled
|
body | boolean | roghnach |
Cosaint PIN roghnach don bhosca poist nua, nuair a cheadaítear é ag do phlean. Ní athraíonn sé an PIN de bhosca poist atá ann cheana.
Réamhshocrú:
false
|
pin
|
body | string | roghnach |
Éigeantach nuair atá pin_enabled fíor: PIN de 6 go 8 digit, seolta mar teaghrán chun na nialais tosaigh a chaomhnú.
|
pin_confirmation
|
body | string | roghnach |
Éigeantach nuair atá pin_enabled fíor. Ní mór go meaitseáil go cruinn leis an bpin.
|
Idempotency-Key
|
header | string | roghnach |
Riachtanach le haghaidh cruthú nó scriosadh faoi chosaint PIN: eochair chobhsaí 16 go 128 carachtar. Déan an t-iarratas céanna a athdhéanamh leis an eochair chéanna chun obair dhúbailte a sheachaint.
|
mode (auto, dot, plus, plus_dot), username (ainm úsáideora alias saincheaptha), domain (m.sh. gmail.com, googlemail.com), lifetime (luachanna ceadaithe: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Fág an tréimhse beatha ar lár, nó fág sé folamh, chun an Tréimhse Beatha Ríomhphoist Réamhshocraithe a úsáid atá cumraithe don phlean míosúil/bliantúil reatha. Seol tréimhse beatha ceadaithe mar shampla 1h chun an réamhshocrú sin a shárú. Úsáidtear gan teorainn ach amháin nuair a bhíonn sé cumraithe mar réamhshocrú an phlean nó nuair a iarrtar go sainráite agus tá sé ceadaithe. Glactar freisin le paraiméadair an choirp mailbox_lifetime agus email_lifetime; bíonn an chéad luach neamhfholamh ag bua in ord seo: lifetime, mailbox_lifetime, email_lifetime. Tuairiscíonn luachanna neamhbhailí nó neamhcheadaithe HTTP 422 in ionad roghnú réamhshocraithe go ciúin.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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
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:21+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:21+00:00",
"email_token": "encrypted-email-token"
}
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
status |
boolean | Cibé an d'éirigh leis an gníomh. |
data.id |
integer | ID Bosca Ríomhphoist. Tá IDanna, seoltaí agus comharthaí ginte difriúil do gach bosca ríomhphoist. |
data.pin_protected |
boolean | Cé acu an bhfuil cosaint PIN ag an mbosca poist seo. Ní thugtar PIN ná haon hash PIN ar ais. |
data.email |
string | Seoladh iomlán bosca poist a ghinte. |
data.domain |
string | Fearann an bhosca poist a ghintear. |
data.provider |
string | Soláthraí bosca poist: caighdeánach, gmail_alias, nó outlook_alias. |
data.expire_at |
string|null | Dáta éaga éifeachtach mar timestamp ISO-8601, nó null le haghaidh bosca poist gan teorainn. |
data.expires_in_seconds |
number|null | Soicindí neamh-dhíobhálacha fágtha nuair a ríomhfar; is féidir soicindí codánacha. Null ciallaíonn gan teorainn, ní náid. |
data.mailbox_state |
string | Stádas reatha an bhosca poist: gníomhach, curtha ar sos, caite, nó neamhghníomhach. |
data.receiving_enabled |
boolean | Cé acu an glacann an bosca poist seo teachtaireachtaí isteach faoi láthair. |
data.message_count |
integer | Líon teachtaireachtaí iomlán aitheanta; is féidir leis cur i láthair an sioncrónaithe bosca poist deiridh. |
data.unread_message_count |
integer | Líon na dteachtaireachtaí gan léamh aitheanta; d'fhéadfadh sé léiriú ar an sioncrónú bosca poist is déanaí. |
data.last_message_received_at |
string|null | An t-am deiridh a fuarthas teachtaireacht i bhformáid ISO-8601, nó null nuair nach bhfuil sé ar fáil. |
data.message_count_synced_at |
string|null | Am sioncrónaithe deiridh an chúntais teachtaireachtaí i bhformáid ISO-8601, nó null roimh shioncrónú. |
data.created_at |
string|null | Am cruthaithe bosca poist i bhformáid ISO-8601. |
data.email_token |
string | Tagairt bosca poist criptithe teimhneach. Ní ionadaíonn sé fíordheimhniú Bearer, seiceálacha úinéireachta ná údarú PIN. |
data.pin_grant |
object | Coinníollach: cruthaíonn cruthú bosca poist gníomhach faoi chosaint PIN an cead léite seo; i gcruthú gnáth gan chosaint, ní chuireann sé ar fáil. |
data.pin_grant.mailbox_id |
integer | Aitheantas Bosca Poist a bhfuil an cead léite coinníollach ceangailte leis. |
data.pin_grant.unlock_token |
string | Céad léite teimhneach do X‑Mailbox‑Unlock leis an dintiúir úinéara céanna. Coinnigh é príobháideach agus i gcuimhne; ní údaróidh cead léite scrios. |
data.pin_grant.scope |
string | An raon léite don dheon cruthaithe coinníollach. |
data.pin_grant.idle_timeout_seconds |
integer | Am díomhaoin ceadaithe don cheadúnas léite, de ghnáth 3600 soicind. |
data.pin_grant.absolute_timeout_seconds |
integer | Uasmhéid saoil an chead léite, de ghnáth 86400 soicind. |
data.pin_grant.expires_at |
string | Am éaga reatha an chead léite i bhformáid ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Dáta dlíthe iomlán an chead léite i bhformáid ISO-8601. Is féidir le hathruithe slándála an cead a chúlghairm níos luaithe. |
Fearainn Alias Outlook
Faigh fearainn alias Outlook / Hotmail gníomhacha atá ar fáil le haghaidh giniúint bosca poist.
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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
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
}
]
}
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
status |
boolean | Cibé an d'éirigh leis an gníomh. |
data.domains |
array | Fearainn Outlook/Hotmail gníomhacha; tá eagar folamh bailí. |
data.domains[].domain |
string | Ainm fearainn ar fáil. |
data.domains[].type |
string | Lipéad soláthraí inléite. |
data.domains[].selectable |
boolean | Cibé ar féidir le do chuntas roghnú go sainráite an fearann seo. |
data.domains[].locked |
boolean | Cé acu an bhfuil roghnú fearainn sainráite faoi ghlas do do chuntas. |
data.domains[].disabled_reason |
string|null | Cúis go bhfuil roghnú fearainn faoi ghlas, nó null nuair is féidir é a roghnú. |
Cruthaigh Alias Outlook
Cruthaigh bosca poist sealadach alias Outlook / Hotmail nua atá i seilbh an úsáideora fíordheimhnithe.
| Paraiméadar | Suíomh | Sorc | Stádas | Cur Síos |
|---|---|---|---|---|
domain
|
body | string | roghnach |
Úsáid randamach nó fearann ó GET /outlook-alias/domains; glacann outlook_alias_domain freisin. Gan cead roghnaithe, úsáidtear randamach.
Réamhshocrú:
Fearann ar fáil randamach
|
username
|
body | string | roghnach |
Iarmhír saincheaptha roghnach: 2 go 32 litir ASCII nó digit, caighdeánaithe go dtí an cás íochtair; faoi cheadúnas gné. Glacann sé freisin le custom_username nó alias_username.
Réamhshocrú:
Uatho-ghinte
|
lifetime
|
body | string | roghnach |
luachanna ceadaithe:
10m — 10 Nóiméad
1h — 1 Uair
2h — Dó uair an chloig
1d — Lá Aon
1w — 1 Seachtain
1m — 30 Lá
3m — 90 lá
6m — 180 Lá
1y — 365 Lá
unlimited — Gan theorainn
Réamhshocrú:
Saolré réamhshocraithe an phlean
|
pin_enabled
|
body | boolean | roghnach |
Cosaint PIN roghnach don bhosca poist nua, nuair a cheadaítear é ag do phlean. Ní athraíonn sé an PIN de bhosca poist atá ann cheana.
Réamhshocrú:
false
|
pin
|
body | string | roghnach |
Éigeantach nuair atá pin_enabled fíor: PIN de 6 go 8 digit, seolta mar teaghrán chun na nialais tosaigh a chaomhnú.
|
pin_confirmation
|
body | string | roghnach |
Éigeantach nuair atá pin_enabled fíor. Ní mór go meaitseáil go cruinn leis an bpin.
|
Idempotency-Key
|
header | string | roghnach |
Riachtanach le haghaidh cruthú nó scriosadh faoi chosaint PIN: eochair chobhsaí 16 go 128 carachtar. Déan an t-iarratas céanna a athdhéanamh leis an eochair chéanna chun obair dhúbailte a sheachaint.
|
domain (m.sh. outlook.com, hotmail.com), username (ainm úsáideora alias saincheaptha), lifetime (luachanna ceadaithe: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Fág an tréimhse beatha ar lár, nó fág sé folamh, chun an Tréimhse Beatha Ríomhphoist Réamhshocraithe a úsáid atá cumraithe don phlean míosúil/bliantúil reatha. Seol tréimhse beatha ceadaithe mar shampla 1h chun an réamhshocrú sin a shárú. Úsáidtear gan teorainn ach amháin nuair a bhíonn sé cumraithe mar réamhshocrú an phlean nó nuair a iarrtar go sainráite agus tá sé ceadaithe. Glactar freisin le paraiméadair an choirp mailbox_lifetime agus email_lifetime; bíonn an chéad luach neamhfholamh ag bua in ord seo: lifetime, mailbox_lifetime, email_lifetime. Tuairiscíonn luachanna neamhbhailí nó neamhcheadaithe HTTP 422 in ionad roghnú réamhshocraithe go ciúin.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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
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:21+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:21+00:00",
"email_token": "encrypted-email-token"
}
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
status |
boolean | Cibé an d'éirigh leis an gníomh. |
data.id |
integer | ID Bosca Ríomhphoist. Tá IDanna, seoltaí agus comharthaí ginte difriúil do gach bosca ríomhphoist. |
data.pin_protected |
boolean | Cé acu an bhfuil cosaint PIN ag an mbosca poist seo. Ní thugtar PIN ná haon hash PIN ar ais. |
data.email |
string | Seoladh iomlán bosca poist a ghinte. |
data.domain |
string | Fearann an bhosca poist a ghintear. |
data.provider |
string | Soláthraí bosca poist: caighdeánach, gmail_alias, nó outlook_alias. |
data.expire_at |
string|null | Dáta éaga éifeachtach mar timestamp ISO-8601, nó null le haghaidh bosca poist gan teorainn. |
data.expires_in_seconds |
number|null | Soicindí neamh-dhíobhálacha fágtha nuair a ríomhfar; is féidir soicindí codánacha. Null ciallaíonn gan teorainn, ní náid. |
data.mailbox_state |
string | Stádas reatha an bhosca poist: gníomhach, curtha ar sos, caite, nó neamhghníomhach. |
data.receiving_enabled |
boolean | Cé acu an glacann an bosca poist seo teachtaireachtaí isteach faoi láthair. |
data.message_count |
integer | Líon teachtaireachtaí iomlán aitheanta; is féidir leis cur i láthair an sioncrónaithe bosca poist deiridh. |
data.unread_message_count |
integer | Líon na dteachtaireachtaí gan léamh aitheanta; d'fhéadfadh sé léiriú ar an sioncrónú bosca poist is déanaí. |
data.last_message_received_at |
string|null | An t-am deiridh a fuarthas teachtaireacht i bhformáid ISO-8601, nó null nuair nach bhfuil sé ar fáil. |
data.message_count_synced_at |
string|null | Am sioncrónaithe deiridh an chúntais teachtaireachtaí i bhformáid ISO-8601, nó null roimh shioncrónú. |
data.created_at |
string|null | Am cruthaithe bosca poist i bhformáid ISO-8601. |
data.email_token |
string | Tagairt bosca poist criptithe teimhneach. Ní ionadaíonn sé fíordheimhniú Bearer, seiceálacha úinéireachta ná údarú PIN. |
data.pin_grant |
object | Coinníollach: cruthaíonn cruthú bosca poist gníomhach faoi chosaint PIN an cead léite seo; i gcruthú gnáth gan chosaint, ní chuireann sé ar fáil. |
data.pin_grant.mailbox_id |
integer | Aitheantas Bosca Poist a bhfuil an cead léite coinníollach ceangailte leis. |
data.pin_grant.unlock_token |
string | Céad léite teimhneach do X‑Mailbox‑Unlock leis an dintiúir úinéara céanna. Coinnigh é príobháideach agus i gcuimhne; ní údaróidh cead léite scrios. |
data.pin_grant.scope |
string | An raon léite don dheon cruthaithe coinníollach. |
data.pin_grant.idle_timeout_seconds |
integer | Am díomhaoin ceadaithe don cheadúnas léite, de ghnáth 3600 soicind. |
data.pin_grant.absolute_timeout_seconds |
integer | Uasmhéid saoil an chead léite, de ghnáth 86400 soicind. |
data.pin_grant.expires_at |
string | Am éaga reatha an chead léite i bhformáid ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Dáta dlíthe iomlán an chead léite i bhformáid ISO-8601. Is féidir le hathruithe slándála an cead a chúlghairm níos luaithe. |
Teachtaireachtaí & Iatáin
Faigh boscaí isteach, léigh teachtaireachtaí iomlána HTML/téacs, agus sruthlaigh iatáin.
Liosta Teachtaireachtaí Bosca Poist
Faigh achoimrí teachtaireachtaí atá ar fáil agus meiteashonraí bosca poist. Cuireann scananna caighdeánacha bosca isteach ar ais beart le déanaí de suas le 25 teachtaireacht; ní críochphointe le stair iomlán leathanach. Úsáid GET /messages/{messageId} le haghaidh corpanna iomlána agus iatáin.
| Paraiméadar | Suíomh | Sorc | Stádas | Cur Síos |
|---|---|---|---|---|
email
|
query | string | riachtanach |
Seoladh iomlán ríomhphoist den bhosca poist atá i do úinéireacht chun teachtaireachtaí a léamh ó. Códú URL an luach iarratais; códú comhartha plus mar %2B.
|
X-Mailbox-Unlock
|
header | string | roghnach |
Ceanntásc, boscaí poist cosanta amháin: bain úsáid as unlock_token léite. Seol POST pin agus scope=read chuig URL unlock PIN. Coinnigh d'fhíordheimhniú Bearer gnách. <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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
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:21",
"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:21+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:21+00:00",
"message_count_synced_at": "2026-11-19T02:18:21+00:00"
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
status |
boolean | Cibé an d'éirigh leis an gníomh. |
mailbox |
string | Seoladh bosca poist a d'iarradh a chuid teachtaireachtaí. |
email_token |
string | Tagairt bosca poist criptithe teimhneach; tá fíordheimhniú caighdeánach fós ag teastáil. |
mailbox_provider |
string | Soláthraí bosca poist: caighdeánach, gmail_alias, nó outlook_alias. |
messages |
array | Achoimre na dteachtaireachtaí. Tuairisceann bosca isteach folamh eagar folamh; aisghabh teachtaireacht amháin chun a chorp agus a iatáin a fháil. |
expire_at |
string|null | Dáta éaga éifeachtach mar timestamp ISO-8601, nó null le haghaidh bosca poist gan teorainn. |
expires_in_seconds |
number|null | Soicindí neamh-dhíobhálacha fágtha nuair a ríomhfar; is féidir soicindí codánacha. Null ciallaíonn gan teorainn, ní náid. |
mailbox_state |
string | Stádas reatha an bhosca poist: gníomhach, curtha ar sos, caite, nó neamhghníomhach. |
receiving_enabled |
boolean | Cé acu an glacann an bosca poist seo teachtaireachtaí isteach faoi láthair. |
message_count |
integer | Líon teachtaireachtaí iomlán aitheanta; is féidir leis cur i láthair an sioncrónaithe bosca poist deiridh. |
unread_message_count |
integer | Líon na dteachtaireachtaí gan léamh aitheanta; d'fhéadfadh sé léiriú ar an sioncrónú bosca poist is déanaí. |
last_message_received_at |
string|null | An t-am deiridh a fuarthas teachtaireacht i bhformáid ISO-8601, nó null nuair nach bhfuil sé ar fáil. |
message_count_synced_at |
string|null | Am sioncrónaithe deiridh an chúntais teachtaireachtaí i bhformáid ISO-8601, nó null roimh shioncrónú. |
mailbox_limit.limit |
integer | Teorainn bosca poist gníomhach don soláthraí seo; ciallaíonn -1 gan teorainn. |
mailbox_limit.limit_label |
string | Lipéad taispeána don teorainn bosca poist. |
mailbox_limit.active_count |
integer | Líon na bhoscaí ríomhphoist gníomhacha don soláthraí seo. |
mailbox_limit.paused_count |
integer | Líon na bboscaí poist curtha ar sos don soláthraí seo. |
mailbox_limit.paused_mailboxes |
array<string> | Seoltaí curtha ar fionraí de bharr teorainn an bhosca poist. |
mailbox_limit.remaining |
integer | Sliotáin bhosca poist gníomhacha atá fágtha; ciallaíonn -1 gan teorainn. Ní é seo an cuóta iarratais API. |
mailbox_limit.remaining_label |
string | Taispeáin lipéad do na sliotáin bosca poist atá fágtha. |
mailbox_limit.reached |
boolean | Cé acu an bhfuil teorainn an bhosca poist gníomhach bainte amach. |
mailbox_limit.blocked |
boolean | Cibé an bhfuil teorainn an bhosca poist gníomhach náid. |
mailbox_limit.provider |
string|null | Soláthraí a gcuirtear teorainn an bhosca poist i bhfeidhm air. |
messages[].id |
string | Opaque message ID used by the single-message, deletion and attachment endpoints. |
messages[].is_seen |
boolean | Cibé an bhfuil an teachtaireacht marcáilte mar léite. |
messages[].subject |
string | Ábhar teachtaireachta. |
messages[].from |
string | Ainm taispeána an tseoltóra nó seoladh. |
messages[].from_email |
string | Seoladh ríomhphoist an tseoltóra. |
messages[].receivedAt |
string | Am faighte i crios ama an fheidhmchláir, formáidithe mar YYYY-MM-DD HH:mm:ss. |
messages[].otp |
string|null | Braitheadh cód aon uair nuair atá sé ar fáil agus ceadaithe; i ngach cás eile, null. |
messages[].otp_locked |
boolean | Cibé an bhfuil cód aon uair amháin braite i bhfolach ag ceadanna na gné. |
messages[].verification_link |
string|null | URL fíoraithe braite nuair atá sé ar fáil agus ceadaithe; i ngach cás eile null. |
messages[].verification_link_locked |
boolean | Cibé an bhfuil nasc fíorúcháin braite i bhfolach de bharr ceadanna gné. |
messages[].from_name |
string|null | Réimse achoimre Outlook: ainm an seoltóra bunaidh. Níl sé i láthair i achoimrí Caighdeánacha agus Gmail. |
messages[].snippet |
string|null | Réimse achoimre Outlook: réamhamharc gearr ar theachtaireacht. |
messages[].received_at |
string|null | Réimse achoimre Outlook: am faighte ISO-8601, nuair a bhfuil sé ar eolas. |
messages[].has_attachments |
boolean | Réimse achoimre Outlook: an bhfuil meiteashonraí iatáin ann. Déantar an infhaighteacht íoslódála a sheiceáil ar leith. |
Faigh Teachtaireacht Aonair
Faigh teachtaireacht úinéireachta de réir a ID teachtaireachta teimhneach. Cuireann sé ar ais formáidí an choirp agus meiteashonraí iatáin. Braitheann réimsí an choirp ar fhormáid na teachtaireachta; cuireann Outlook réimsí ar leith don sholáthraí a liostáil thíos.
| Paraiméadar | Suíomh | Sorc | Stádas | Cur Síos |
|---|---|---|---|---|
messageId
|
path | string | riachtanach |
Aitheantas teachtaireachta uathúil a thugtar ar ais sa liosta teachtaireachtaí.
|
X-Mailbox-Unlock
|
header | string | roghnach |
Ceanntásc, boscaí poist cosanta amháin: bain úsáid as unlock_token léite. Seol POST pin agus scope=read chuig URL unlock PIN. Coinnigh d'fhíordheimhniú Bearer gnách. <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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
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:21",
"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"
}
]
}
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
status |
boolean | Cibé an d'éirigh leis an gníomh. |
data.id |
string | Aitheantas teachtaireachta teimhneach. |
data.is_seen |
boolean | Staid léite teachtaireachta. Is féidir léamh a mharcáil mar fheicthe; d'fhéadfadh sonraí taisce léiriú a dhéanamh ar staid roimhe seo. |
data.subject |
string | Ábhar teachtaireachta. |
data.from |
string | Ainm taispeána an tseoltóra nó seoladh. |
data.from_email |
string | Seoladh ríomhphoist an tseoltóra. |
data.to |
string | Seoladh bosca poist an faighteora. |
data.mailbox_provider |
string | Soláthraí bosca poist: caighdeánach, gmail_alias, nó outlook_alias. |
data.receivedAt |
string | Am faighte i crios ama an fheidhmchláir, formáidithe mar YYYY-MM-DD HH:mm:ss. |
data.html |
boolean | Cé acu an bhfuil corp HTML ag an teachtaireacht. |
data.html_content |
string | Corpa HTML nuair atá sé i láthair. Is féidir le teachtaireachtaí caighdeánacha gan HTML an réimse seo a fhágáil. Caith le hábhar na teachtaireachta mar neamhiontaofa. |
data.text_content |
string | Corpa téacs nuair atá sé i láthair; D’fhéadfadh teachtaireachtaí caighdeánacha téacs éalaithe a bheith i ndéanach pre element nó an réimse seo a fhágáil. |
data.content |
string | Corp roghnaithe le cur i láthair, de ghnáth HTML nuair atá sé ar fáil. |
data.attachments |
array | Attachment metadata, or an empty array. Downloads require normal authentication and applicable PIN authorization. |
data.attachments[].name |
string | Filename to URL-encode as a single path segment when downloading. |
data.attachments[].size |
integer | Méid an cheangáin i mbearta. |
data.attachments[].url |
string | Cuireadh URL íoslódála API an Úsáideora Fíordheimhnithe le hiatáin le comhadainm. Ní ráthaíonn URL go bhfuil an comhad áitiúil ar fáil. |
data.attachments[].extension |
string | Réimse meiteashonraí Caighdeánach/Gmail: iarmhír comhaid nuair a sholáthraítear. |
data.attachments[].id |
string | Outlook metadata field: provider attachment ID. |
data.attachments[].content_type |
string | Réimse meiteashonraí Outlook: cineál ábhair MIME. |
data.from_name |
string|null | Réimse mionsonraí Outlook: ainm an tseoltóra bunaidh. |
data.to_email |
string|null | Réimse sonraí Outlook: seoladh an fhaighteora bunaidh. |
data.received_at |
string|null | Réimse sonraí Outlook: am faighte ISO-8601. |
data.has_html |
boolean | Réimse sonraí Outlook: an bhfuil corp HTML ann. |
Scrios Teachtaireacht
Scríobh teachtaireacht aonair úinéir.
| Paraiméadar | Suíomh | Sorc | Stádas | Cur Síos |
|---|---|---|---|---|
messageId
|
path | string | riachtanach |
Teaghrán ID teachtaireachta uathúil le scriosadh go buan.
|
X-Mailbox-Unlock
|
header | string | roghnach |
Ceanntásc, boscaí poist cosanta amháin: bain úsáid as an unlock_token scriosadh aon‑úsáid. An chéad POST pin, scope=delete agus an action/target_id a thugtar ar ais ag an bhfreagra 423 chuig an URL unlock PIN. Ní féidir le comhartha léite a scriosadh. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | roghnach |
Riachtanach le haghaidh cruthú nó scriosadh faoi chosaint PIN: eochair chobhsaí 16 go 128 carachtar. Déan an t-iarratas céanna a athdhéanamh leis an eochair chéanna chun obair dhúbailte a sheachaint.
|
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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
status |
boolean | Cibé an d'éirigh leis an gníomh. |
message |
string | Toradh an scriosta. Aimsíonn acmhainn ar iarraidh cód HTTP 404. |
Íosluchtaigh iatán
Íoslódáil ceangal ó theachtaireacht úinéir
| Paraiméadar | Suíomh | Sorc | Stádas | Cur Síos |
|---|---|---|---|---|
messageId
|
path | string | riachtanach |
ID an teachtaireachta a bhfuil an comhad ann.
|
filename
|
path | string | riachtanach |
Ainm comhaid agus síneadh an iatáin le híoslódáil.
|
X-Mailbox-Unlock
|
header | string | roghnach |
Ceanntásc, boscaí poist cosanta amháin: bain úsáid as unlock_token léite. Seol POST pin agus scope=read chuig URL unlock PIN. Coinnigh d'fhíordheimhniú Bearer gnách. <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
| Réimse | Sorc | Cur Síos |
|---|---|---|
Content-Disposition |
header | Íoslódálann freagra rathúil an comhadainm iarrtha. |
body |
binary | Bearta comhaid ar rath, ní JSON. Tabharann earráidí JSON le stádas nach bhfuil 2xx. |
Teorainneacha rátaí & cuótaí
Rianaigh buiséid iarratais fíor-ama, teorainneacha rátaí, agus cuótaí cuntais gan creidmheanna a ídiú.
Teorainn ráta & cuóta
Seiceáil do theorainn ráta reatha agus stádas cuóta gan aon úsáid API a ídiú. Tá an críochphointe seo saor ó chuóta agus ní laghdaíonn sé creidmheasanna míosúla API (teorainn cosanta mí-úsáide: 60 iarratas/nóiméad).
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'
Freagra léiriúcháin ag baint úsáide as sonraí sintéiseacha. Tá IDanna, seoltaí, comharthaí, stampaí ama, teorainneacha an phláin agus líonra ag athrú. Ní sháraíonn samplaí saoilréimse réamhshocraithe do phlean. Sonraíonn cur síos ar réimsí freagra na réimsí inbhainte agus na réimsí ar leith don sholáthraí.
Freagra samplach
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"
}
}
}
| Réimse | Sorc | Cur Síos |
|---|---|---|
data.limit |
integer|string | Teorainn iarratais cuntais in aghaidh an nóiméid. Léiríonn an teaghrán unlimited buiséad nóiméad gan teorainn; tá sé seo neamhspleách de chóta míosúil. |
data.remaining |
integer|string | Sliotáin buiséad nóiméad cuntais atá fágtha, nó an teaghrán unlimited. Ní chiallaíonn luach dearfach go bhfuil creidiúintí API fágtha. |
data.reset |
integer | Soicindí don fhuinneog nóiméad an chuntais, ní don athshocrú cóta míosúil. Is féidir le buiséid nóiméad díchumasaithe nó gan teorainn a choinneáil luach nómhais 60 soicind; ní gheallann sé rochtain tar éis fanachta. |
data.plan |
string | Clib an phlean reatha. Cuirtear ainm an phlean inléite ar leith ar fáil i data.quota.plan_name. |
data.quota.enabled |
boolean | Cé acu an bhfuil rochtain API dhomhanda agus plean/creidmheas cumasaithe. Ní thaispeánann sé seo an acmhainn fágtha ná ionadú an lasc API úsáideora. |
data.quota.user_api_status |
boolean | Cé acu an bhfuil an t-úsáideoir tar éis a chasúr API Úsáideora a chumasú. Éilíonn oibríochtaí an casúr seo chomh maith le rochtain chumasaithe agus acmhainn atá ar fáil. |
data.quota.plan_name |
string | Ainm inléite den phlean reatha. |
data.quota.period |
string | Tréimhse úsáide mí na féilire i bhformáid YYYY-MM, ag baint úsáide as crios ama an fheidhmchláir; ní gá go mbeadh sé de dhíth ar an tréimhse billeála síntiús. |
data.quota.base_limit |
integer | Ceadúnas bunúsach an phlean míosúil. Ciallaíonn luach -1 gan teorainn. |
data.quota.extra_requests |
integer | Ceadúnas míosúil breise a deonadh don tréimhse úsáide reatha; ar leithligh ó chreidmheasanna ceannaite. |
data.quota.monthly_limit |
integer | Ceadúnas bunúsach plus iarratais bhreise don tréimhse reatha. Ciallaíonn luach -1 gan teorainn. Ní chuimsítear creidiúintí ceannaite. |
data.quota.monthly_remaining |
integer|null | Leasúnas míosúil teoranta atá fágtha, nó null nuair atá an cuóta míosúil gan teorainn. Níor cheart null a léirmhíniú mar nialas. |
data.quota.used |
integer | Oibríochtaí API rathúla, á n-áireamh sa tréimhse úsáide reatha, lena n-áirítear oibríochtaí a úsáideann creidmheasanna. Ní mhéadaíonn seiceálacha stádais an luach seo. |
data.quota.purchased_credits |
integer | Iarmhéid creidmheas reatha, lena n-áirítear creidmheasanna bonais an phlean gníomhach. Níor cheart creidmheasanna bonais a chur leis an iarmhéid seo dara huair. |
data.quota.bonus_credits |
integer | Cuid bhónas an phlean gníomhach den iarmhéid creidmheasa; scoilsiú de purchased_credits, ní cumas breise. |
data.quota.direct_purchased_credits |
integer | Iarmhéid creidmheasa gan an cuid bónas an phlean gníomhach. Tá an luach seo le bonus_credits cothrom le purchased_credits. |
data.quota.remaining |
integer|null | Ceadúint mhíosúil atá fágtha plus an iarmhéid creidmheasa reatha, gan bonais a dhúbailt. Ciallaíonn Null cquota míosúil gan teorainn. Bíonn ceadanna gnéithe aonair agus teorainneacha iarratais eile fós i bhfeidhm. |
data.quota.unlimited |
boolean | Cé acu an bhfuil cuóta mhíosúil gan teorainn. Ní chuireann sé seo buiséad nóiméad an chuntais ná teorainneacha gné eile gan teorainn. |
data.quota.usage_percent |
integer | Céatadán cruinn ó 0 go 100 atá comhoiriúnach le Painéal: úsáidte roinnte le húsáidte móide an chuid atá fágtha, iolrú le 100. Cuimsíonn sé acmhainn creidmheasa atá ar fáil, mar sin d'fhéadfadh athluchtú an céatadán a ísliú. Tá sé 0 do chuóta gan teorainn nó le linn a bhfuil an linn neamhtheoranta; ní hé seo an céatadán teorainn ráta nó cinneadh rochtana. |
data.quota.reset_at |
string | Stampa ama ISO-8601 le fritháireamh criostaire don athshocrú cuóta an mhí féilire seo chugainn. Ní é seo an dáta críochnaithe an tsíntiús, agus ní athlíonann an athshocrú míosúil na creidmheanna ceannaite. |
status |
string | An rath litriúil don chríochnachas stádais seo. Úsáidtear an luach boolach fíor ag críochnachtaí bosca ríomhphoist rathúla eile. |
data.monthly_limit |
integer | Ailias comhoiriúnachta den réimse data.quota comhfhreagrach; ná cuir leis arís nuair a ríomhann tú iarmhéid. |
data.monthly_remaining |
integer|null | Ailias comhoiriúnachta den réimse data.quota comhfhreagrach; ná cuir leis arís nuair a ríomhann tú iarmhéid. |
data.purchased_credits |
integer | Ailias comhoiriúnachta den réimse data.quota comhfhreagrach; ná cuir leis arís nuair a ríomhann tú iarmhéid. |
Postaí Webhooks (Ionchurthaí Reáltúis)
Instead of repeatedly checking the REST API (GET /messages) for incoming mail, set up Webhooks to send new messages to your server or automation workflow in real time.
Supported Webhook Events
Is féidir le gach webhook a shubscribeadh le ceann nó níos mó de réimseanna h-eachtraí. Faigheann do thoinneoir an nuashonraithe nuair a tharlaíonn aon de na hiontrálacha seo.
Seolta i bhfíor-am nuair a shroicheann teachtaireacht nua an bosca poist roghnaithe.
Seoltar é nuair a théann an bosca poist sealadach as feidhm agus cuireann sé an próiseáil webhook ar sos.
Seolta nuair a athghníomhaíonn bosca poist atá caite arís de réir rialacha an phlean.
Seolta díreach roimh an gcrúca gréasáin agus a bhosca poist a scriosadh.
Ceisteanna & Veirimic HMAC
Cáithfidh gach iontráil webhook ceannairí speisialta a bhaineann le slándáil. Úsáid an ceannairí X-TempMailg-Signature chun aithris a dhéanamh go raibh na hiontrálaí inbhuailte á thugadh go díreach ó TempMailg agus nach raibh siad tógtha.
| Ainm Teas | Samplaí Ábhar | Cur Síos |
|---|---|---|
User-Agent |
TempMailg-Webhooks/1.0 | Aitheantóir caighdeánach don oibrí seachadta webhook. |
X-TempMailg-Event |
email.received | An cineál imeachta a spreag an seachadadh seo. |
X-TempMailg-Event-Id |
e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c | UUID uathúil sannta don iarracht seachadta seo. |
X-TempMailg-Timestamp |
1725192000 | Stampa ama Unix epoch a léiríonn cathain a cuireadh tús leis an iarratas. |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | Síniú HMAC-SHA256 ríofa ó {timestamp}.{raw_body} ag úsáid do rún. |
X-TempMailg-Test |
false | Fíor nuair a sheoltar é ag an ngné "Seol Ping Tástála" i do dheais. |
An t-aimsearadh a dhéanann úsáid as HMAC le SHA256 ar an téacs seo:
hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)
Sampla Íosach Teagmhais (email.received)
Enviado como aplicação/json no corpo da solicitação HTTP POST.
{
"id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"version": "1.0",
"event": "email.received",
"occurred_at": "2026-11-19T02:18:22+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:22+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"
}
}
Samplaí Cur i bhFeidhm an Fhaighteora
Roghnaigh do theanga chun a fheiceáil conas webhooks a fháil agus sínithe HMAC a fhíorú go slán.
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]);
Ardáin Tacaíochta & Comhtháthú Uathoibriú
Oibríonn Webhooks TempMailg as an bosca le críocha HTTPS caighdeánacha agus le hardáin ceannródaíocha gan-chód/ uathoibriú:
Botúin choitianta agus fadhbanna
Seo iad na códanna freagartha is coitianta a bhfuil tú liosta a fheiceáil agus tú ag cur le chéile an API úsáideora.
Token Bearer neamhbhailí, ar iarraidh nó cúlghairthe.
Bhí úinéireacht, ceadanna gné, rochtain fearainn nó méid an cheangail ag cur cosc ar an oibríocht. Seiceáil an cód freagra agus an teachtaireacht.
Níor aimsíodh an acmhainn ar an óstach ceadaithe nó níl sí i seilbh an úsáideora
Athúsáidtear an eochair oibríochta le sonraí difriúla, tá oibríocht eile ar feitheamh, nó d'athraigh slándáil an bosca poist. Scrúdaigh an cód roimh iarracht a dhéanamh arís.
Bosca poist as feidhm nó neamhghníomhach
Paraiméadair neamhbhailí, tréimhse saoil neamhcheadaithe, cumas ailias nach bhfuil ar fáil, socrú PIN neamhbhailí nó eochair Idempotency ar iarraidh/neamhbhailí chuir cosc ar an oibríocht.
Teastaíonn comhartha X‑Mailbox‑Unlock bailí scóipthe ó bhosca poist cosanta. Úsáid an gníomh agus target_id ón bhfreagra chun scriosadh. Ní mór na riachtanais blocála nó athshlánaithe a réiteach sula ndéantar iarracht eile.
Chuir teorainn iarratais, plean díchumasaithe, cuóta ídithe, nó fuarú ar ais an oibríocht. Seiceáil an fáth agus na ceanntásca buiséid atá ar fáil. Tá Retry-After roghnach.
Níorbh fhéidir leis an bhfreastalaí an oibríocht a chríochnú. Le cruthú nó scriosadh cosanta, coinnigh an t-iarratas céanna agus an Idempotency-Key nuair a dhéantar iarracht eile.
Níorbh fhéidir stóráil chosanta nó comhordú a fhíorú. Déan iarracht arís tar éis an moill a léirítear. Ní freagra í seo íocadh teipthe.
Liosta luasmhar
- 401 Unauthorized - Tá an rochtáin Bearer as láthair, mícheart, curtha ar ceal nó cóipithe go mícheart.
- 403 Forbidden - Níl ceart rochtana API úsáideora ag an bplean reatha faoi láthair.
- 404 Not Found - Reachtas nach bhfuil ann nó páirámadar neamhthugtha
- 410 Gone / Expired - Bosca poist nó go bhfuil sí neamhghníomhach.
- 429 Rate Limited - Seiceáil cúis an fhreagra agus na ceanntásca buiséid. Ní bhaintear úsáid as Retry-After ach le teorainneacha ama; d'fhéadfadh creidmheasanna ídithe nó rochtain díchumasaithe athrú cuntais a éileamh.
Chéim dhóchasach ina dhiaidh
Má tá tú logáilte isteach, oscail Bainistíocht API ar dtús agus dearbh do chuid eolais, cuóta, stádas rochtana plean, agus an URL Bunúsach API Úsáideora cruinn sula ndéanfaidh tú debugáil do aip eachtrach.