Orodha ya kuweka haraka
- Fungua ukurasa wako wa usimamizi wa API na uunde kibinafsi chenji cha API chako.
- Nakili URL ya msingi ya API ya mtumiaji inayoonyeshwa hapo, kwa mfano https://v1.tempmailg.com/api.
- Tuma ombi zote kwa mwenyeji wa API huo Authorization: Bearer YOUR_USER_API_KEY na Accept: application/json.
- Fuatilia kiasi cha maombi yako ya kila mwezi kutoka kwenye ukurasa huo huo wa dashibodi na kutoka vichwa vya kiasi wakati vinapatikana kwenye majibu ya API ya mtumiaji. Maombi yenye mafanikio ya 2xx pekee yanahesabiwa katika kiasi.
API ufikiaji wa ufunguo
Ingia kwenye mfumo ili kuunda ufunguo wako wa kibinafsi wa API na kuona maelezo ya kiasi halisi.
Mzunguko wa uthibitisho
- Unda ufunguo wako wa kibinafsi wa API kutoka kwenye ukurasa wa Usimamizi wa API wa dasibodi.
- Tuma ufunguo huo kama tokeni ya Bearer kwenye kila ombi.
- Utumie URL msingi wa API ya mtumiaji unaonyeshwa kwenye ukurasa wako wa Usimamizi wa API.
- Endeleza ufunguo wowote unapotaka kuifanya ufunguo wa zamani asiweze kutumika na kuanza kutumia ufunguo mpya mara moja.
Vichwa vinavyohitajika
Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json
Vichwa vya Kikomo cha Kasi na Kiwango
Vichwa vya viwango vya kiwango vinaelezea bajeti ya ombi iliyotajwa. Vichwa vya kiasi vinaingizwa wakati taarifa za kiasi zinapatikana; kukataliwa kwa kiwango cha dakika hakihesabi kiasi chako kamili cha mwezi.
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— Maksimum ya maombi yanayoruhusiwa kwa dakika (RPM) kwa mpango wako.X-RateLimit-Remaining— Maombi ya RPM yaliyobaki katika dirisha la dakika ya sasa.X-RateLimit-Reset— Alama ya muda ya Unix wakati dirisha la kiwango cha dakika ya sasa linapofufuliwa.X-Quota-Limit— Jumla ya uwezo wa mkopo wa kila mwezi na ulioununuliwa kwa akaunti yako.X-Quota-Remaining— Maombi ya API yaliyobaki yanayopatikana katika mwezi huu.X-Quota-Used— Jumla ya maombi ya API yaliyotumika katika kipindi cha bili cha sasa.X-Quota-Reset— Alama ya muda ISO-8601 wakati kiasi chako cha kila mwezi kinapofufuliwa.X-RateLimit-Scope— Bajeti iliyoelezwa na vichwa: akaunti, ip, status_endpoint, au sanduku la barua.X-Mailbox-RateLimit-*— Bajeti ya kuunda/kuongeza sanduku la barua tofauti. Majibu ya sanduku la barua yenye mafanikio yanahifadhi RPM ya akaunti katika X-RateLimit-*; ukatili wa sanduku la barua pekee hutumia wigo wa sanduku la barua na dirisha lake la upya.Retry-After— Sekunde hadi upya wa muda uwe unaofaa. Mpango uliosimamishwa au kiasi kilichokamilika kinaweza kuhitaji mabadiliko ya akaunti badala yake, kwa hivyo kichwa hiki si kila wakati kinapatikana.503 protection_unavailable— Uhifadhi wa ulinzi wa API au uratibu haupatikani kwa muda. Jaribu tena baadiri; hii si kushindwa kwa malipo au deni la mkopo.
Usimamizi wa kisanduku pokezi
Pata vikoa vilivyoruhusiwa, unda au badilisha sanduku la barua, chagua muda wa maisha ulioruhusiwa, na futa anwani zilizomilikiwa.
Orodha ya Vikoa Vilivyoruhusiwa
Orodhesha vikoa vinavyopatikana kwa ajili ya kuunda barua pepe za muda. Chuja kwa aina ili kuona vikoa vya bure, vya premium, au maalum vinavyoungwa mkono na mpango wako wa usajili.
| Kigezo | Mahali | Aina | Status | Maelezo |
|---|---|---|---|---|
type
|
query | string | hiari |
Kichujio cha ngazi ya kikoa. Uachaji hutumia yote wakati ufikiaji wa kikoa cha premium umewezeshwa, vinginevyo bure. Thamani zinazotambuliwa: free, basic, pro, premium, custom, ultimate, all
Chaguo-msingi:
Inategemea akaunti
|
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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
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
}
]
}
}
| Uwanja | Aina | Maelezo |
|---|---|---|
status |
boolean | Je, operesheni ilifanikiwa? |
data.requested_type |
string | Kichujio cha kikoa kimewekwa. |
data.plan |
string | Lebo ya mpango wa sasa. |
data.plan_name |
string | Jina linaloweza kusomwa la mpango wa sasa. |
data.allowed_types |
array<string> | Vichujio vya kikoa vinavyopatikana kwa akaunti hii. Kichujio kilichotambuliwa bado kinaweza kuondolewa kwa mpango wako. |
data.domains |
array | Vikoa vinavyoweza kuchaguliwa baada ya kuchuja; safu tupu ni sahihi. |
data.domains[].domain |
string | Jina la kikoa linaloweza kuchaguliwa. |
data.domains[].type |
string | Lebo ya ngazi ya kikoa inayoweza kusomwa. |
data.domains[].custom |
boolean | Iwapo hii ni kikoa maalum. |
Unda Sanduku la Barua la Muda
Unda kisanduku pokezi cha muda kilicho na mmiliki. Achia jina la mtumiaji na kikoa kwa ajili ya uzalishaji wa nasibu, au toa jina la mtumiaji maalum lililoruhusiwa na kikoa kilichoruhusiwa. Kipengele cha mtoaji kinaweza kuchagua uzalishaji wa jina la utani la Gmail au Outlook.
| Kigezo | Mahali | Aina | Status | Maelezo |
|---|---|---|---|---|
username
|
body | string | hiari |
Jina la mtumiaji la desturi la hiari: herufi 2 hadi 64 za ASCII, nambari, nukta, underscore au dash. Inahitaji ruhusa ya mpango; custom_username pia inakubaliwa.
Chaguo-msingi:
Imetengenezwa kwa nasibu
|
domain
|
body | string | hiari |
Moja ya vikoa vilivyoruhusiwa vinavyorudishwa na GET /domains. Ukosefu wa kuchagua huchagua kikoa kilichoruhusiwa kwa nasibu.
Chaguo-msingi:
Kikoa cha nasibu kilichoruhusiwa
|
lifetime
|
body | string | hiari |
thamani zilizoruhusiwa:
10m — Muda wa dakika 10
1h — Miezi 1
2h — Mwaka wa Sita
1d — Siku moja
1w — Wiki moja
1m — Siku 30
3m — Mwaka Mmoja
6m — Mwaka Mrefu (180 Siku)
1y — Mwaka Mfululizo (365 Siku)
unlimited — Zisizo na Kikomo
Chaguo-msingi:
Muda wa maisha chaguo-msingi wa mpango
|
provider
|
body | string | hiari |
Mtoa huduma wa kisanduku pokezi: standard, gmail_alias, au outlook_alias.
Chaguo-msingi:
standard
|
pin_enabled
|
body | boolean | hiari |
Ulinzi wa PIN wa hiari kwa kisanduku kipya, inapowezeshwa na mpango wako. Haufanyi mabadiliko kwenye PIN ya kisanduku kilichopo.
Chaguo-msingi:
false
|
pin
|
body | string | hiari |
Inahitajika wakati pin_enabled ni true: PIN ya tarakimu 6 hadi 8, imetumwa kama string ili kuhifadhi sifuri za mwanzo.
|
pin_confirmation
|
body | string | hiari |
Inahitajika wakati pin_enabled ni kweli. Lazima ilingane kabisa na pin.
|
Idempotency-Key
|
header | string | hiari |
Inahitajika kwa uundaji au ufutaji uliolindwa na PIN: ufunguo thabiti wa herufi 16 hadi 128. Rudia ombi lile lile kwa ufunguo huo huo ili kuepuka kazi ya kurudia.
|
username (jina la mtumiaji maalum ikiwa kuruhusiwa na mpango), domain (kikoa kilichoruhusiwa, kwa mfano example.com), lifetime (thamani zilizoruhusiwa: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Ondoa muda wa maisha, au uache wazi, ili kutumia Muda wa Maisha wa Barua Pepe Chaguo-msingi uliosetiwa kwa mpango wako wa kila mwezi/kila mwaka wa sasa. Tuma muda wa maisha unaoruhusiwa kama 1h ili kubatilisha chaguo-msingi hicho. Isiyo na kikomo inatumika tu wakati imewekwa kama chaguo-msingi la mpango au imeombwa wazi na kuruhusiwa. Vigezo vya mwili mailbox_lifetime na email_lifetime pia vinakubaliwa; thamani ya kwanza isiyo tupu hushinda katika mpangilio huu: lifetime, mailbox_lifetime, email_lifetime. Thamani zisizo sahihi au zisizoruhusiwa hurudisha HTTP 422 badala ya kuchagua chaguo-msingi kimya.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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
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:15+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:15+00:00",
"email_token": "encrypted-email-token"
}
}
| Uwanja | Aina | Maelezo |
|---|---|---|
status |
boolean | Je, operesheni ilifanikiwa? |
data.id |
integer | Kitambulisho cha sanduku la barua. Vitambulisho vilivyotengenezwa, anwani na tokeni hubadilika kwa kila sanduku la barua. |
data.pin_protected |
boolean | Ikiwa kisanduku pokezi hiki kina ulinzi wa PIN. Hakuna PIN au hash ya PIN inayorudishwa. |
data.email |
string | Anwani kamili ya kisanduku cha barua imeundwa. |
data.domain |
string | Kikoa cha kisanduku pokezi kilichozalishwa. |
data.provider |
string | Mtoa huduma wa kisanduku pokezi: standard, gmail_alias, au outlook_alias. |
data.expire_at |
string|null | Muda wa kumalizika kama alama ya wakati ya ISO-8601, au null kwa kisanduku pokezi kisicho na kikomo. |
data.expires_in_seconds |
number|null | Sekunde zisizo hasi zilizobaki wakati wa kuhesabu; sekunde za sehemu zinawezekana. Null inamaanisha isiyo na kikomo, si sifuri. |
data.mailbox_state |
string | Hali ya kisanduku pokezi ya sasa: hai, imefungwa, imeisha, au haifanyi kazi. |
data.receiving_enabled |
boolean | Je, kisanduku hiki cha barua kinapokea ujumbe unaokuja kwa sasa. |
data.message_count |
integer | Idadi ya jumla ya ujumbe inayojulikana; inaweza kuakisi usawazishaji wa mwisho wa sanduku la barua. |
data.unread_message_count |
integer | Idadi ya ujumbe usiojifungua inayojulikana; inaweza kuakisi usawazishaji wa mwisho wa kisanduku pokezi. |
data.last_message_received_at |
string|null | Muda wa mwisho wa ujumbe uliopokelewa uliojulikana katika muundo wa ISO-8601, au null wakati haupatikani. |
data.message_count_synced_at |
string|null | Muda wa usawazishaji wa idadi ya ujumbe wa mwisho katika muundo wa ISO-8601, au null kabla ya usawazishaji. |
data.created_at |
string|null | Muda wa uundaji wa kisanduku pokezi katika muundo wa ISO-8601. |
data.email_token |
string | Rejea ya kisanduku pokezi iliyosimbwa isiyoeleweka. Haiibadilishi uthibitishaji wa Bearer, ukaguzi wa umiliki, au idhini ya PIN. |
data.pin_grant |
object | Sharti: uundaji wa sanduku la barua lililolindwa na PIN linaloendelea unarejesha ruhusa hii ya kusoma; uundaji wa kawaida usiolindwa unauacha. |
data.pin_grant.mailbox_id |
integer | Kitambulisho cha kisanduku pokezi ambacho ruhusa ya kusoma ya masharti imeunganishwa. |
data.pin_grant.unlock_token |
string | Token ya usomaji isiyoeleweka kwa X-Mailbox-Unlock yenye kitambulisho sawa cha mmiliki. Ike faragha na katika kumbukumbu; ruhusa ya usomaji haidhinishi ufutaji. |
data.pin_grant.scope |
string | Upeo unaosomwa kwa ajili ya ruhusa ya uundaji wa masharti. |
data.pin_grant.idle_timeout_seconds |
integer | Muda wa kupumzika unaoruhusiwa kwa ruhusa ya kusoma, kawaida sekunde 3600. |
data.pin_grant.absolute_timeout_seconds |
integer | Muda wa maisha wa ruhusa ya kusoma, kawaida sekunde 86400. |
data.pin_grant.expires_at |
string | Muda wa kumalizika wa ruhusa ya kusoma wa sasa katika muundo wa ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Muda wa kumalizika kamili wa ruhusa ya kusoma katika muundo wa ISO-8601. Mabadiliko ya usalama yanaweza kubatilisha ruhusa mapema. |
Sasisha / Badilisha Sanduku la Barua
Unda au chagua kisanduku pokezi kwenye jina jipya la mtumiaji na kikoa baada ya kuthibitisha umiliki wa kisanduku pokezi cha sasa. Hii haibadilishi jina la kisanduku pokezi cha zamani wala haibadilishi muda wake wa maisha. Wakati marudio yanatofautiana, kisanduku pokezi cha zamani kinabaki katika historia na kinaweza kusitishwa na vikwazo vya kisanduku pokezi kilichopo. Kutumia tena marudio yako ya kilichopo kunarejesha muda uliotakiwa au chaguo-msingi la mpango.
| Kigezo | Mahali | Aina | Status | Maelezo |
|---|---|---|---|---|
email
|
path | string | Inahitajika |
Anwani kamili ya barua pepe ya kisanduku pokezi kilichomilikiwa kwa sasa ili kubadilisha. URL-encode kila sehemu ya njia; encode ishara ya kuongeza kama %2B.
|
username
|
path | string | Inahitajika |
Jina la mtumiaji jipya linalotakiwa: herufi na nambari 2 hadi 64; linategemea ruhusa ya jina la mtumiaji maalum.
|
domain
|
path | string | Inahitajika |
Jina jipya la kikoa linaloruhusiwa.
|
lifetime
|
body | string | hiari |
thamani zilizoruhusiwa:
10m — Muda wa dakika 10
1h — Miezi 1
2h — Mwaka wa Sita
1d — Siku moja
1w — Wiki moja
1m — Siku 30
3m — Mwaka Mmoja
6m — Mwaka Mrefu (180 Siku)
1y — Mwaka Mfululizo (365 Siku)
unlimited — Zisizo na Kikomo
Chaguo-msingi:
Muda wa maisha chaguo-msingi wa mpango
|
pin_enabled
|
body | boolean | hiari |
Ulinzi wa PIN wa hiari kwa kisanduku kipya, inapowezeshwa na mpango wako. Haufanyi mabadiliko kwenye PIN ya kisanduku kilichopo.
Chaguo-msingi:
false
|
pin
|
body | string | hiari |
Inahitajika wakati pin_enabled ni true: PIN ya tarakimu 6 hadi 8, imetumwa kama string ili kuhifadhi sifuri za mwanzo.
|
pin_confirmation
|
body | string | hiari |
Inahitajika wakati pin_enabled ni kweli. Lazima ilingane kabisa na pin.
|
Idempotency-Key
|
header | string | hiari |
Inahitajika kwa uundaji au ufutaji uliolindwa na PIN: ufunguo thabiti wa herufi 16 hadi 128. Rudia ombi lile lile kwa ufunguo huo huo ili kuepuka kazi ya kurudia.
|
X-Mailbox-Unlock
|
header | string | hiari |
Kichwa, sanduku za barua zilizo salama pekee: tumia unlock_token ya kusoma. Kwanza POST pin na scope=read kwa URL ya kufungua PIN. Endelea kutumia uthibitishaji wako wa Bearer wa kawaida. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
lifetime (thamani zinazoruhusiwa: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Ondoa muda wa maisha, au uache wazi, ili kutumia Muda wa Maisha wa Barua Pepe Chaguo-msingi uliosetiwa kwa mpango wako wa kila mwezi/kila mwaka wa sasa. Tuma muda wa maisha unaoruhusiwa kama 1h ili kubatilisha chaguo-msingi hicho. Isiyo na kikomo inatumika tu wakati imewekwa kama chaguo-msingi la mpango au imeombwa wazi na kuruhusiwa. Vigezo vya mwili mailbox_lifetime na email_lifetime pia vinakubaliwa; thamani ya kwanza isiyo tupu hushinda katika mpangilio huu: lifetime, mailbox_lifetime, email_lifetime. Thamani zisizo sahihi au zisizoruhusiwa hurudisha HTTP 422 badala ya kuchagua chaguo-msingi kimya.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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
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:15+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:15+00:00",
"email_token": "encrypted-email-token"
}
}
| Uwanja | Aina | Maelezo |
|---|---|---|
status |
boolean | Je, operesheni ilifanikiwa? |
data.id |
integer | Kitambulisho cha sanduku la barua. Vitambulisho vilivyotengenezwa, anwani na tokeni hubadilika kwa kila sanduku la barua. |
data.pin_protected |
boolean | Ikiwa kisanduku pokezi hiki kina ulinzi wa PIN. Hakuna PIN au hash ya PIN inayorudishwa. |
data.email |
string | Anwani kamili ya kisanduku cha barua imeundwa. |
data.domain |
string | Kikoa cha kisanduku pokezi kilichozalishwa. |
data.provider |
string | Mtoa huduma wa kisanduku pokezi: standard, gmail_alias, au outlook_alias. |
data.expire_at |
string|null | Muda wa kumalizika kama alama ya wakati ya ISO-8601, au null kwa kisanduku pokezi kisicho na kikomo. |
data.expires_in_seconds |
number|null | Sekunde zisizo hasi zilizobaki wakati wa kuhesabu; sekunde za sehemu zinawezekana. Null inamaanisha isiyo na kikomo, si sifuri. |
data.mailbox_state |
string | Hali ya kisanduku pokezi ya sasa: hai, imefungwa, imeisha, au haifanyi kazi. |
data.receiving_enabled |
boolean | Je, kisanduku hiki cha barua kinapokea ujumbe unaokuja kwa sasa. |
data.message_count |
integer | Idadi ya jumla ya ujumbe inayojulikana; inaweza kuakisi usawazishaji wa mwisho wa sanduku la barua. |
data.unread_message_count |
integer | Idadi ya ujumbe usiojifungua inayojulikana; inaweza kuakisi usawazishaji wa mwisho wa kisanduku pokezi. |
data.last_message_received_at |
string|null | Muda wa mwisho wa ujumbe uliopokelewa uliojulikana katika muundo wa ISO-8601, au null wakati haupatikani. |
data.message_count_synced_at |
string|null | Muda wa usawazishaji wa idadi ya ujumbe wa mwisho katika muundo wa ISO-8601, au null kabla ya usawazishaji. |
data.created_at |
string|null | Muda wa uundaji wa kisanduku pokezi katika muundo wa ISO-8601. |
data.email_token |
string | Rejea ya kisanduku pokezi iliyosimbwa isiyoeleweka. Haiibadilishi uthibitishaji wa Bearer, ukaguzi wa umiliki, au idhini ya PIN. |
data.pin_grant |
object | Sharti: uundaji wa sanduku la barua lililolindwa na PIN linaloendelea unarejesha ruhusa hii ya kusoma; uundaji wa kawaida usiolindwa unauacha. |
data.pin_grant.mailbox_id |
integer | Kitambulisho cha kisanduku pokezi ambacho ruhusa ya kusoma ya masharti imeunganishwa. |
data.pin_grant.unlock_token |
string | Token ya usomaji isiyoeleweka kwa X-Mailbox-Unlock yenye kitambulisho sawa cha mmiliki. Ike faragha na katika kumbukumbu; ruhusa ya usomaji haidhinishi ufutaji. |
data.pin_grant.scope |
string | Upeo unaosomwa kwa ajili ya ruhusa ya uundaji wa masharti. |
data.pin_grant.idle_timeout_seconds |
integer | Muda wa kupumzika unaoruhusiwa kwa ruhusa ya kusoma, kawaida sekunde 3600. |
data.pin_grant.absolute_timeout_seconds |
integer | Muda wa maisha wa ruhusa ya kusoma, kawaida sekunde 86400. |
data.pin_grant.expires_at |
string | Muda wa kumalizika wa ruhusa ya kusoma wa sasa katika muundo wa ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Muda wa kumalizika kamili wa ruhusa ya kusoma katika muundo wa ISO-8601. Mabadiliko ya usalama yanaweza kubatilisha ruhusa mapema. |
Futa kisanduku pokezi
Futa kisanduku pokezi kilichomilikiwa na uanzishe usafi wa ujumbe na faili zake. Rekodi za kisanduku pokezi zilizohifadhiwa zinaweza kufutwa kwa upole ndani ya mfumo; anwani haitakweza tena kutumika kupitia API.
| Kigezo | Mahali | Aina | Status | Maelezo |
|---|---|---|---|---|
email
|
path | string | Inahitajika |
Anuani kamili ya barua pepe ya kisanduku kilichomilikiwa cha kufutwa. Fanya anwani kuwa URL-encoded; encode ishara ya kuongeza kama %2B.
|
X-Mailbox-Unlock
|
header | string | hiari |
Kichwa, sanduku la barua lililolindwa pekee: tumia unlock_token ya kufuta inayotumika mara moja. Kwanza POST pin, scope=delete na action/target_id iliyorudishwa na jibu la 423 kwa PIN unlock URL. Tokeni ya kusoma haiwezi kufuta. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | hiari |
Inahitajika kwa uundaji au ufutaji uliolindwa na PIN: ufunguo thabiti wa herufi 16 hadi 128. Rudia ombi lile lile kwa ufunguo huo huo ili kuepuka kazi ya kurudia.
|
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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
| Uwanja | Aina | Maelezo |
|---|---|---|
status |
boolean | Je, operesheni ilifanikiwa? |
message |
string | Matokeo ya ufutaji. Rasilimali isiyopatikana inarudisha HTTP 404. |
Majina ya utani ya Gmail & Outlook
Tengeneza sanduku la barua pepe la bandia la Gmail na Outlook/Hotmail lenye sifa ya juu.
Unda jina bandia la Gmail
Unda kisanduku pokezi cha muda cha jina la utani la Gmail kilicho na mmiliki mtumiaji aliyethibitishwa.
| Kigezo | Mahali | Aina | Status | Maelezo |
|---|---|---|---|---|
mode
|
body | string | hiari |
Njia ya uzalishaji: auto, dot, plus, au plus_dot. Pia inakubali gmail_alias_mode. Ikiwa uteuzi wa mtindo hairuhusiwi, auto inatumika.
Chaguo-msingi:
auto
|
username
|
body | string | hiari |
Kiambishi cha mwisho cha alias maalum cha hiari: herufi au nambari za ASCII 2 hadi 32, zimebadilishwa kuwa herufi ndogo; inategemea ruhusa ya kipengele. Pia inakubali custom_username au alias_username.
Chaguo-msingi:
Imetengenezwa kiotomatiki
|
domain
|
body | string | hiari |
Tumia random, gmail.com au googlemail.com; alias_domain pia inakubaliwa. Ukosefu au ruhusa ya uteuzi wa kikoa isiyopatikana inatumia random.
Chaguo-msingi:
random
|
lifetime
|
body | string | hiari |
thamani zilizoruhusiwa:
10m — Muda wa dakika 10
1h — Miezi 1
2h — Mwaka wa Sita
1d — Siku moja
1w — Wiki moja
1m — Siku 30
3m — Mwaka Mmoja
6m — Mwaka Mrefu (180 Siku)
1y — Mwaka Mfululizo (365 Siku)
unlimited — Zisizo na Kikomo
Chaguo-msingi:
Muda wa maisha chaguo-msingi wa mpango
|
pin_enabled
|
body | boolean | hiari |
Ulinzi wa PIN wa hiari kwa kisanduku kipya, inapowezeshwa na mpango wako. Haufanyi mabadiliko kwenye PIN ya kisanduku kilichopo.
Chaguo-msingi:
false
|
pin
|
body | string | hiari |
Inahitajika wakati pin_enabled ni true: PIN ya tarakimu 6 hadi 8, imetumwa kama string ili kuhifadhi sifuri za mwanzo.
|
pin_confirmation
|
body | string | hiari |
Inahitajika wakati pin_enabled ni kweli. Lazima ilingane kabisa na pin.
|
Idempotency-Key
|
header | string | hiari |
Inahitajika kwa uundaji au ufutaji uliolindwa na PIN: ufunguo thabiti wa herufi 16 hadi 128. Rudia ombi lile lile kwa ufunguo huo huo ili kuepuka kazi ya kurudia.
|
mode (auto, dot, plus, plus_dot), username (jina la mtumiaji la bandia maalum), domain (e.g. gmail.com, googlemail.com), lifetime (thamani zilizoruhusiwa: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Ondoa muda wa maisha, au uache wazi, ili kutumia Muda wa Maisha wa Barua Pepe Chaguo-msingi uliosetiwa kwa mpango wako wa kila mwezi/kila mwaka wa sasa. Tuma muda wa maisha unaoruhusiwa kama 1h ili kubatilisha chaguo-msingi hicho. Isiyo na kikomo inatumika tu wakati imewekwa kama chaguo-msingi la mpango au imeombwa wazi na kuruhusiwa. Vigezo vya mwili mailbox_lifetime na email_lifetime pia vinakubaliwa; thamani ya kwanza isiyo tupu hushinda katika mpangilio huu: lifetime, mailbox_lifetime, email_lifetime. Thamani zisizo sahihi au zisizoruhusiwa hurudisha HTTP 422 badala ya kuchagua chaguo-msingi kimya.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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
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:15+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:15+00:00",
"email_token": "encrypted-email-token"
}
}
| Uwanja | Aina | Maelezo |
|---|---|---|
status |
boolean | Je, operesheni ilifanikiwa? |
data.id |
integer | Kitambulisho cha sanduku la barua. Vitambulisho vilivyotengenezwa, anwani na tokeni hubadilika kwa kila sanduku la barua. |
data.pin_protected |
boolean | Ikiwa kisanduku pokezi hiki kina ulinzi wa PIN. Hakuna PIN au hash ya PIN inayorudishwa. |
data.email |
string | Anwani kamili ya kisanduku cha barua imeundwa. |
data.domain |
string | Kikoa cha kisanduku pokezi kilichozalishwa. |
data.provider |
string | Mtoa huduma wa kisanduku pokezi: standard, gmail_alias, au outlook_alias. |
data.expire_at |
string|null | Muda wa kumalizika kama alama ya wakati ya ISO-8601, au null kwa kisanduku pokezi kisicho na kikomo. |
data.expires_in_seconds |
number|null | Sekunde zisizo hasi zilizobaki wakati wa kuhesabu; sekunde za sehemu zinawezekana. Null inamaanisha isiyo na kikomo, si sifuri. |
data.mailbox_state |
string | Hali ya kisanduku pokezi ya sasa: hai, imefungwa, imeisha, au haifanyi kazi. |
data.receiving_enabled |
boolean | Je, kisanduku hiki cha barua kinapokea ujumbe unaokuja kwa sasa. |
data.message_count |
integer | Idadi ya jumla ya ujumbe inayojulikana; inaweza kuakisi usawazishaji wa mwisho wa sanduku la barua. |
data.unread_message_count |
integer | Idadi ya ujumbe usiojifungua inayojulikana; inaweza kuakisi usawazishaji wa mwisho wa kisanduku pokezi. |
data.last_message_received_at |
string|null | Muda wa mwisho wa ujumbe uliopokelewa uliojulikana katika muundo wa ISO-8601, au null wakati haupatikani. |
data.message_count_synced_at |
string|null | Muda wa usawazishaji wa idadi ya ujumbe wa mwisho katika muundo wa ISO-8601, au null kabla ya usawazishaji. |
data.created_at |
string|null | Muda wa uundaji wa kisanduku pokezi katika muundo wa ISO-8601. |
data.email_token |
string | Rejea ya kisanduku pokezi iliyosimbwa isiyoeleweka. Haiibadilishi uthibitishaji wa Bearer, ukaguzi wa umiliki, au idhini ya PIN. |
data.pin_grant |
object | Sharti: uundaji wa sanduku la barua lililolindwa na PIN linaloendelea unarejesha ruhusa hii ya kusoma; uundaji wa kawaida usiolindwa unauacha. |
data.pin_grant.mailbox_id |
integer | Kitambulisho cha kisanduku pokezi ambacho ruhusa ya kusoma ya masharti imeunganishwa. |
data.pin_grant.unlock_token |
string | Token ya usomaji isiyoeleweka kwa X-Mailbox-Unlock yenye kitambulisho sawa cha mmiliki. Ike faragha na katika kumbukumbu; ruhusa ya usomaji haidhinishi ufutaji. |
data.pin_grant.scope |
string | Upeo unaosomwa kwa ajili ya ruhusa ya uundaji wa masharti. |
data.pin_grant.idle_timeout_seconds |
integer | Muda wa kupumzika unaoruhusiwa kwa ruhusa ya kusoma, kawaida sekunde 3600. |
data.pin_grant.absolute_timeout_seconds |
integer | Muda wa maisha wa ruhusa ya kusoma, kawaida sekunde 86400. |
data.pin_grant.expires_at |
string | Muda wa kumalizika wa ruhusa ya kusoma wa sasa katika muundo wa ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Muda wa kumalizika kamili wa ruhusa ya kusoma katika muundo wa ISO-8601. Mabadiliko ya usalama yanaweza kubatilisha ruhusa mapema. |
Majina ya Kijina ya Outlook
Pata vikoa vya alias vya Outlook / Hotmail vinavyopatikana kwa ajili ya uundaji wa kisanduku pokezi.
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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
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
}
]
}
}
| Uwanja | Aina | Maelezo |
|---|---|---|
status |
boolean | Je, operesheni ilifanikiwa? |
data.domains |
array | Vikoa vya Outlook/Hotmail vinavyofanya kazi; safu tupu ni sahihi. |
data.domains[].domain |
string | Jina la kikoa linalopatikana. |
data.domains[].type |
string | Lebo ya mtoa huduma inayoweza kusomwa. |
data.domains[].selectable |
boolean | Ikiwa akaunti yako inaweza kuchagua waziwazi kikoa hiki. |
data.domains[].locked |
boolean | Je, uchaguzi wa kikoa wazi umefungwa kwa akaunti yako. |
data.domains[].disabled_reason |
string|null | Sababu ya uteuzi wa kikoa umefungwa, au null wakati unaweza kuchagua. |
Unda Alias ya Outlook
Unda kisanduku pokezi cha muda cha alias ya Outlook / Hotmail kilicho na mmiliki mtumiaji aliyethibitishwa.
| Kigezo | Mahali | Aina | Status | Maelezo |
|---|---|---|---|---|
domain
|
body | string | hiari |
Tumia nasibu au kikoa kutoka GET /outlook-alias/domains; outlook_alias_domain pia inakubaliwa. Bila ruhusa ya uchaguzi, nasibu inatumiwa.
Chaguo-msingi:
Kikoa kinachopatikana cha nasibu
|
username
|
body | string | hiari |
Kiambishi cha mwisho cha alias maalum cha hiari: herufi au nambari za ASCII 2 hadi 32, zimebadilishwa kuwa herufi ndogo; inategemea ruhusa ya kipengele. Pia inakubali custom_username au alias_username.
Chaguo-msingi:
Imetengenezwa kiotomatiki
|
lifetime
|
body | string | hiari |
thamani zilizoruhusiwa:
10m — Muda wa dakika 10
1h — Miezi 1
2h — Mwaka wa Sita
1d — Siku moja
1w — Wiki moja
1m — Siku 30
3m — Mwaka Mmoja
6m — Mwaka Mrefu (180 Siku)
1y — Mwaka Mfululizo (365 Siku)
unlimited — Zisizo na Kikomo
Chaguo-msingi:
Muda wa maisha chaguo-msingi wa mpango
|
pin_enabled
|
body | boolean | hiari |
Ulinzi wa PIN wa hiari kwa kisanduku kipya, inapowezeshwa na mpango wako. Haufanyi mabadiliko kwenye PIN ya kisanduku kilichopo.
Chaguo-msingi:
false
|
pin
|
body | string | hiari |
Inahitajika wakati pin_enabled ni true: PIN ya tarakimu 6 hadi 8, imetumwa kama string ili kuhifadhi sifuri za mwanzo.
|
pin_confirmation
|
body | string | hiari |
Inahitajika wakati pin_enabled ni kweli. Lazima ilingane kabisa na pin.
|
Idempotency-Key
|
header | string | hiari |
Inahitajika kwa uundaji au ufutaji uliolindwa na PIN: ufunguo thabiti wa herufi 16 hadi 128. Rudia ombi lile lile kwa ufunguo huo huo ili kuepuka kazi ya kurudia.
|
domain (kwa mfano outlook.com, hotmail.com), username (jina la mtumiaji la bandia maalum), lifetime (thamani zilizoruhusiwa: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Ondoa muda wa maisha, au uache wazi, ili kutumia Muda wa Maisha wa Barua Pepe Chaguo-msingi uliosetiwa kwa mpango wako wa kila mwezi/kila mwaka wa sasa. Tuma muda wa maisha unaoruhusiwa kama 1h ili kubatilisha chaguo-msingi hicho. Isiyo na kikomo inatumika tu wakati imewekwa kama chaguo-msingi la mpango au imeombwa wazi na kuruhusiwa. Vigezo vya mwili mailbox_lifetime na email_lifetime pia vinakubaliwa; thamani ya kwanza isiyo tupu hushinda katika mpangilio huu: lifetime, mailbox_lifetime, email_lifetime. Thamani zisizo sahihi au zisizoruhusiwa hurudisha HTTP 422 badala ya kuchagua chaguo-msingi kimya.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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
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:15+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:15+00:00",
"email_token": "encrypted-email-token"
}
}
| Uwanja | Aina | Maelezo |
|---|---|---|
status |
boolean | Je, operesheni ilifanikiwa? |
data.id |
integer | Kitambulisho cha sanduku la barua. Vitambulisho vilivyotengenezwa, anwani na tokeni hubadilika kwa kila sanduku la barua. |
data.pin_protected |
boolean | Ikiwa kisanduku pokezi hiki kina ulinzi wa PIN. Hakuna PIN au hash ya PIN inayorudishwa. |
data.email |
string | Anwani kamili ya kisanduku cha barua imeundwa. |
data.domain |
string | Kikoa cha kisanduku pokezi kilichozalishwa. |
data.provider |
string | Mtoa huduma wa kisanduku pokezi: standard, gmail_alias, au outlook_alias. |
data.expire_at |
string|null | Muda wa kumalizika kama alama ya wakati ya ISO-8601, au null kwa kisanduku pokezi kisicho na kikomo. |
data.expires_in_seconds |
number|null | Sekunde zisizo hasi zilizobaki wakati wa kuhesabu; sekunde za sehemu zinawezekana. Null inamaanisha isiyo na kikomo, si sifuri. |
data.mailbox_state |
string | Hali ya kisanduku pokezi ya sasa: hai, imefungwa, imeisha, au haifanyi kazi. |
data.receiving_enabled |
boolean | Je, kisanduku hiki cha barua kinapokea ujumbe unaokuja kwa sasa. |
data.message_count |
integer | Idadi ya jumla ya ujumbe inayojulikana; inaweza kuakisi usawazishaji wa mwisho wa sanduku la barua. |
data.unread_message_count |
integer | Idadi ya ujumbe usiojifungua inayojulikana; inaweza kuakisi usawazishaji wa mwisho wa kisanduku pokezi. |
data.last_message_received_at |
string|null | Muda wa mwisho wa ujumbe uliopokelewa uliojulikana katika muundo wa ISO-8601, au null wakati haupatikani. |
data.message_count_synced_at |
string|null | Muda wa usawazishaji wa idadi ya ujumbe wa mwisho katika muundo wa ISO-8601, au null kabla ya usawazishaji. |
data.created_at |
string|null | Muda wa uundaji wa kisanduku pokezi katika muundo wa ISO-8601. |
data.email_token |
string | Rejea ya kisanduku pokezi iliyosimbwa isiyoeleweka. Haiibadilishi uthibitishaji wa Bearer, ukaguzi wa umiliki, au idhini ya PIN. |
data.pin_grant |
object | Sharti: uundaji wa sanduku la barua lililolindwa na PIN linaloendelea unarejesha ruhusa hii ya kusoma; uundaji wa kawaida usiolindwa unauacha. |
data.pin_grant.mailbox_id |
integer | Kitambulisho cha kisanduku pokezi ambacho ruhusa ya kusoma ya masharti imeunganishwa. |
data.pin_grant.unlock_token |
string | Token ya usomaji isiyoeleweka kwa X-Mailbox-Unlock yenye kitambulisho sawa cha mmiliki. Ike faragha na katika kumbukumbu; ruhusa ya usomaji haidhinishi ufutaji. |
data.pin_grant.scope |
string | Upeo unaosomwa kwa ajili ya ruhusa ya uundaji wa masharti. |
data.pin_grant.idle_timeout_seconds |
integer | Muda wa kupumzika unaoruhusiwa kwa ruhusa ya kusoma, kawaida sekunde 3600. |
data.pin_grant.absolute_timeout_seconds |
integer | Muda wa maisha wa ruhusa ya kusoma, kawaida sekunde 86400. |
data.pin_grant.expires_at |
string | Muda wa kumalizika wa ruhusa ya kusoma wa sasa katika muundo wa ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Muda wa kumalizika kamili wa ruhusa ya kusoma katika muundo wa ISO-8601. Mabadiliko ya usalama yanaweza kubatilisha ruhusa mapema. |
Ujumbe & Viambatisho
Pata visanduku vya barua vinavyokuja, soma ujumbe kamili wa HTML/maandishi, na mtiririko wa viambatisho.
Orodhesha Ujumbe wa Kisanduku Pokezi
Pata muhtasari wa ujumbe unaopatikana na metadata ya kisanduku pokezi. Uchakataji wa kawaida wa kisanduku pokezi hurudisha kundi la hivi karibuni la hadi ujumbe 25; hii si kiunganishi cha kurasa kamili kilichopangwa. Tumia GET /messages/{messageId} kwa miili kamili na viambatisho.
| Kigezo | Mahali | Aina | Status | Maelezo |
|---|---|---|---|---|
email
|
query | string | Inahitajika |
Anwani kamili ya barua pepe ya kisanduku pokezi kilichomilikiwa ili kusoma ujumbe kutoka. URL-encode thamani ya swali; encode ishara ya kuongeza kama %2B.
|
X-Mailbox-Unlock
|
header | string | hiari |
Kichwa, sanduku za barua zilizo salama pekee: tumia unlock_token ya kusoma. Kwanza POST pin na scope=read kwa URL ya kufungua PIN. Endelea kutumia uthibitishaji wako wa Bearer wa kawaida. <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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
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:15",
"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:15+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:15+00:00",
"message_count_synced_at": "2026-11-19T02:18:15+00:00"
}
| Uwanja | Aina | Maelezo |
|---|---|---|
status |
boolean | Je, operesheni ilifanikiwa? |
mailbox |
string | Anwani ya kisanduku pokezi ambayo ujumbe wake ulitakiwa. |
email_token |
string | Rejea ya kisanduku pokezi iliyosimbwa isiyoeleweka; uthibitishaji wa kawaida bado unahitajika. |
mailbox_provider |
string | Mtoa huduma wa kisanduku pokezi: standard, gmail_alias, au outlook_alias. |
messages |
array | Muhtasari wa ujumbe. Kifaa kisicho na barua za kuingia kinarejesha safu tupu; pata ujumbe mmoja kwa mwili wake na viambatisho. |
expire_at |
string|null | Muda wa kumalizika kama alama ya wakati ya ISO-8601, au null kwa kisanduku pokezi kisicho na kikomo. |
expires_in_seconds |
number|null | Sekunde zisizo hasi zilizobaki wakati wa kuhesabu; sekunde za sehemu zinawezekana. Null inamaanisha isiyo na kikomo, si sifuri. |
mailbox_state |
string | Hali ya kisanduku pokezi ya sasa: hai, imefungwa, imeisha, au haifanyi kazi. |
receiving_enabled |
boolean | Je, kisanduku hiki cha barua kinapokea ujumbe unaokuja kwa sasa. |
message_count |
integer | Idadi ya jumla ya ujumbe inayojulikana; inaweza kuakisi usawazishaji wa mwisho wa sanduku la barua. |
unread_message_count |
integer | Idadi ya ujumbe usiojifungua inayojulikana; inaweza kuakisi usawazishaji wa mwisho wa kisanduku pokezi. |
last_message_received_at |
string|null | Muda wa mwisho wa ujumbe uliopokelewa uliojulikana katika muundo wa ISO-8601, au null wakati haupatikani. |
message_count_synced_at |
string|null | Muda wa usawazishaji wa idadi ya ujumbe wa mwisho katika muundo wa ISO-8601, au null kabla ya usawazishaji. |
mailbox_limit.limit |
integer | Kikomo cha kisanduku pokezi kilichowashwa kwa mtoa huduma huyu; -1 ina maana ya isiyo na kikomo. |
mailbox_limit.limit_label |
string | Lebo ya kuonyesha kwa kikomo cha kisanduku pokezi. |
mailbox_limit.active_count |
integer | Idadi ya sanduku la barua pepe linaloendelea kwa mtoa huduma huyu. |
mailbox_limit.paused_count |
integer | Idadi ya sanduku za barua zilizosimamishwa kwa mtoa huduma huyu. |
mailbox_limit.paused_mailboxes |
array<string> | Anwani zimezimwa kwa kikomo cha kisanduku pokezi. |
mailbox_limit.remaining |
integer | Nafasi zilizobaki za kisanduku pokezi vinavyofanya kazi; -1 ina maana ya isiyo na kikomo. Hii si kiasi cha maombi ya API. |
mailbox_limit.remaining_label |
string | Onyesha lebo ya nafasi zilizobaki za sanduku la barua. |
mailbox_limit.reached |
boolean | Ikiwa kikomo cha kisanduku pokezi kilichopo kimefikiwa. |
mailbox_limit.blocked |
boolean | Je, kikomo cha kisanduku pokezi kilichofanya kazi ni sifuri. |
mailbox_limit.provider |
string|null | Mtoa huduma ambako kikomo cha sanduku la barua kinahusishwa. |
messages[].id |
string | Kitambulisho cha ujumbe kisicho wazi kinachotumika na sehemu za ujumbe mmoja, ufutaji, na kiambatisho. |
messages[].is_seen |
boolean | Iwapo ujumbe umewekwa alama ya kusomwa. |
messages[].subject |
string | Mada ya ujumbe. |
messages[].from |
string | Jina la kuonyesha la mtumaji au anwani. |
messages[].from_email |
string | Anwani ya barua pepe ya mtumaji. |
messages[].receivedAt |
string | Muda ulipokelewa katika saa ya programu, umepangwa kama YYYY-MM-DD HH:mm:ss. |
messages[].otp |
string|null | Imetambua msimbo wa mara moja wakati upo na kuruhusiwa; vinginevyo ni null. |
messages[].otp_locked |
boolean | Ikiwa msimbo wa mara moja uliogunduliwa umefichwa na ruhusa za kipengele. |
messages[].verification_link |
string|null | Uliogunduliwa URL ya uthibitishaji inapopatikana na kuruhusiwa; vinginevyo ni null. |
messages[].verification_link_locked |
boolean | Ikiwa kiungo cha uthibitishaji kilichogunduliwa kimefichwa na ruhusa za kipengele. |
messages[].from_name |
string|null | Sehemu ya muhtasari wa Outlook: jina la mtumaji asili. Haipo katika muhtasari wa Standard na Gmail. |
messages[].snippet |
string|null | Sehemu ya muhtasari ya Outlook: hakiki fupi wa ujumbe. |
messages[].received_at |
string|null | Sehemu ya muhtasari wa Outlook: muda ulipokelewa wa ISO-8601, inapojulikana. |
messages[].has_attachments |
boolean | Sehemu ya muhtasari ya Outlook: ikiwa metadata ya kiambatisho ipo. Upatikanaji wa upakuaji hukaguliwa tofauti. |
Pata Ujumbe Mmoja
Pata ujumbe ulio na miliki kwa kutumia kitambulisho chake cha ujumbe kisichoeleweka. Hurejesha muundo wa mwili na metadata ya kiambatisho. Sehemu za mwili zinategemea muundo wa ujumbe; Outlook inaongeza sehemu maalum za mtoa huduma zilizo hapa chini.
| Kigezo | Mahali | Aina | Status | Maelezo |
|---|---|---|---|---|
messageId
|
path | string | Inahitajika |
Kitambulisho cha kipekee cha ujumbe kinachorudishwa katika orodha ya ujumbe.
|
X-Mailbox-Unlock
|
header | string | hiari |
Kichwa, sanduku za barua zilizo salama pekee: tumia unlock_token ya kusoma. Kwanza POST pin na scope=read kwa URL ya kufungua PIN. Endelea kutumia uthibitishaji wako wa Bearer wa kawaida. <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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
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:15",
"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"
}
]
}
}
| Uwanja | Aina | Maelezo |
|---|---|---|
status |
boolean | Je, operesheni ilifanikiwa? |
data.id |
string | Kitambulisho cha ujumbe kisichoonekana. |
data.is_seen |
boolean | Hali ya kusoma ujumbe. Kusoma kunaweza kuashiria kuwa imeonekana; data iliyohifadhiwa kwenye cache inaweza kuonyesha hali ya awali. |
data.subject |
string | Mada ya ujumbe. |
data.from |
string | Jina la kuonyesha la mtumaji au anwani. |
data.from_email |
string | Anwani ya barua pepe ya mtumaji. |
data.to |
string | Anwani ya sanduku la barua la mpokeaji. |
data.mailbox_provider |
string | Mtoa huduma wa kisanduku pokezi: standard, gmail_alias, au outlook_alias. |
data.receivedAt |
string | Muda ulipokelewa katika saa ya programu, umepangwa kama YYYY-MM-DD HH:mm:ss. |
data.html |
boolean | Ikiwa ujumbe una mwili wa HTML. |
data.html_content |
string | Mwili wa HTML unapopatikana. Ujumbe wa kawaida usio na HTML unaweza kuachwa uga huu. Chukulia maudhui ya ujumbe kama yasiyoaminika. |
data.text_content |
string | Mwandiko wa maandishi unapopatikana; Ujumbe wa kawaida unaweza kuwa na maandishi yaliyokwekwa alama katika kipengele cha pre au kuachana na uga huu. |
data.content |
string | Mwili unaopendekezwa kwa ajili ya kuonyesha, kawaida HTML inapopatikana. |
data.attachments |
array | Metadata ya kiambatisho, au safu tupu. Upakuaji unahitaji uthibitishaji wa kawaida na idhini ya PIN inayotumika. |
data.attachments[].name |
string | Jina la faili la ku-URL-encode kama kipande kimoja cha njia wakati wa kupakua. |
data.attachments[].size |
integer | Ukubwa wa kiambatisho kwa bajti. |
data.attachments[].url |
string | URL ya upakuaji ya API ya Mtumiaji Aliyetambulishwa imeongezwa kwa viambatisho na jina la faili. URL haidhihirishi kuwa faili ya ndani inapatikana. |
data.attachments[].extension |
string | Sehemu ya metadata ya Kawaida/Gmail: kiendelezo cha faili kinapowekwa. |
data.attachments[].id |
string | Sehemu ya metadata ya Outlook: kitambulisho cha kiambatisho cha mtoa huduma. |
data.attachments[].content_type |
string | Sehemu ya metadata ya Outlook: aina ya maudhui ya MIME. |
data.from_name |
string|null | Sehemu ya maelezo ya Outlook: jina la mtumaji wa awali. |
data.to_email |
string|null | Sehemu ya maelezo ya Outlook: anwani ya mpokeaji wa awali. |
data.received_at |
string|null | Sehemu ya maelezo ya Outlook: muda ulipokelewa wa ISO-8601. |
data.has_html |
boolean | Sehemu ya maelezo ya Outlook: ikiwa mwili wa HTML upo. |
Ta bort meddelande
Futa ujumbe mmoja ulionunuliwa
| Kigezo | Mahali | Aina | Status | Maelezo |
|---|---|---|---|---|
messageId
|
path | string | Inahitajika |
Mfuatano wa kitambulisho cha ujumbe wa kipekee wa kufuta kabisa.
|
X-Mailbox-Unlock
|
header | string | hiari |
Kichwa, sanduku la barua lililolindwa pekee: tumia unlock_token ya kufuta inayotumika mara moja. Kwanza POST pin, scope=delete na action/target_id iliyorudishwa na jibu la 423 kwa PIN unlock URL. Tokeni ya kusoma haiwezi kufuta. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | hiari |
Inahitajika kwa uundaji au ufutaji uliolindwa na PIN: ufunguo thabiti wa herufi 16 hadi 128. Rudia ombi lile lile kwa ufunguo huo huo ili kuepuka kazi ya kurudia.
|
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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
| Uwanja | Aina | Maelezo |
|---|---|---|
status |
boolean | Je, operesheni ilifanikiwa? |
message |
string | Matokeo ya ufutaji. Rasilimali isiyopatikana inarudisha HTTP 404. |
Pakua Kiambatisho
Piga chapa kwa nyongeza kutoka kwa ujumbe uliomilikiwa.
| Kigezo | Mahali | Aina | Status | Maelezo |
|---|---|---|---|---|
messageId
|
path | string | Inahitajika |
ID ya ujumbe unaojumuisha faili.
|
filename
|
path | string | Inahitajika |
Jina la faili na kiendelezi cha kiambatisho cha kupakuliwa.
|
X-Mailbox-Unlock
|
header | string | hiari |
Kichwa, sanduku za barua zilizo salama pekee: tumia unlock_token ya kusoma. Kwanza POST pin na scope=read kwa URL ya kufungua PIN. Endelea kutumia uthibitishaji wako wa Bearer wa kawaida. <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
| Uwanja | Aina | Maelezo |
|---|---|---|
Content-Disposition |
header | Jibu la mafanikio hupakua jina la faili lililotakiwa. |
body |
binary | Baiti za faili wakati wa mafanikio, si JSON. Makosa hurudisha JSON na hali isiyo ya 2xx. |
Vikomo vya Kiwango na Kikomo
Fuatilia bajeti za maombi ya wakati halisi, viwango vya kiwango, na quota za akaunti bila kutumia mikopo.
Kikomo cha Kiwango na Saida
Angalia kikomo chako cha kiwango cha sasa na hali ya kiasi bila kutumia matumizi yoyote ya API. Sehemu hii ya mwisho haina kikomo cha kiasi na haiondoi mikopo ya API ya kila mwezi (kikomo cha ulinzi dhidi ya matumizi mabaya: 60 requests/min).
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'
Jibu la mfano likitumia data ya bandia. Vitambulisho, anwani, tokeni, alama za wakati, mipaka ya mpango na hesabu hubadilika. Muda wa sampuli hauzidi chaguo-msingi cha mpango wako. Maelezo ya sehemu za jibu yanabainisha sehemu zinazoweza kuwa null na sehemu maalum za mtoa huduma.
Mfano wa jibu
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"
}
}
}
| Uwanja | Aina | Maelezo |
|---|---|---|
data.limit |
integer|string | Kikomo cha maombi kwa dakika ya akaunti. Kamba unlimited inaashiria bajeti ya dakika isiyo na kikomo; hii haitegemei kiasi cha mwezi. |
data.remaining |
integer|string | Nafasi za bajeti ya dakika zilizobaki za akaunti, au kamba unlimited. Thamani chanya haimaanishi kwamba mikopo ya API inabaki. |
data.reset |
integer | Sekunde kwa dirisha la dakika la akaunti, si kwa urejeshaji wa kiasi cha mwezi. Bajeti za dakika zilizozimwa au zisizo na kikomo zinaweza kudumisha thamani ya sekunde 60 ya kawaida; hii haiahidi upatikanaji baada ya kusubiri. |
data.plan |
string | Tagi ya mpango wa sasa. Jina la mpango linaloweza kusomwa linatolewa kando katika data.quota.plan_name. |
data.quota.enabled |
boolean | Ikiwa ufikiaji wa API ya kimataifa na wa mpango/kredi umewezeshwa. Hii haionyeshi uwezo uliobaki wala haibadilishi swichi ya API ya mtumiaji. |
data.quota.user_api_status |
boolean | Ikiwa mtumiaji amewasha swichi ya API ya Mtumiaji. Operesheni zinahitaji swichi hii pamoja na ufikiaji uliowezeshwa na uwezo unaopatikana. |
data.quota.plan_name |
string | Jina linaloweza kusomwa la mpango wa sasa. |
data.quota.period |
string | Kipindi cha matumizi cha kalenda-mwezi katika muundo wa YYYY-MM, ukitumia saa ya programu; si lazima kipindi cha malipo cha usajili. |
data.quota.base_limit |
integer | Kikomo cha msingi cha mpango wa kila mwezi. Thamani ya -1 ina maana ya isiyo na kikomo. |
data.quota.extra_requests |
integer | Ruhusa ya ziada ya kila mwezi imetolewa kwa kipindi cha matumizi cha sasa; tofauti na mikopo iliyonunuliwa. |
data.quota.monthly_limit |
integer | Ruhusa ya msingi pamoja na maombi ya ziada ya kipindi cha sasa. Thamani ya -1 ina maana ya isiyo na kikomo. Salio lililonunuliwa halijumuishi. |
data.quota.monthly_remaining |
integer|null | Kiasi kilichobaki cha kipimo cha mwezi kilichopatikana, au null wakati kiasi cha mwezi hakina kikomo. Null haipaswi kutafsiriwa kama sifuri. |
data.quota.used |
integer | Mafanikio, hesabu ya shughuli za API katika kipindi cha matumizi cha sasa, ikijumuisha shughuli zinazotumia mikopo. Ukaguzi wa hali hauongeza thamani hii. |
data.quota.purchased_credits |
integer | Salio la mkopo wa sasa, likijumuisha mikopo ya ziada ya mpango unaofanya kazi. Mikopo ya ziada haipaswi kuongezwa kwenye salio hili tena. |
data.quota.bonus_credits |
integer | Sehemu ya bonasi ya mpango inayofanya kazi ya salio la mkopo; mgawanyo wa purchased_credits, si uwezo wa ziada. |
data.quota.direct_purchased_credits |
integer | Salio la mkopo isipokuwa sehemu ya bonasi ya mpango inayofanya kazi. Thamani hii pamoja na bonus_credits inalingana na purchased_credits. |
data.quota.remaining |
integer|null | Kiasi kilichobaki cha kila mwezi pamoja na salio la mkopo wa sasa, bila kuhesabu bonasi mara mbili. Null inamaanisha quota isiyo na kikomo kwa mwezi. Ruhusa za kipengele binafsi na vikwazo vingine vya maombi bado vinatumika. |
data.quota.unlimited |
boolean | Ikiwa kiasi cha kila mwezi ni isiyo na kikomo. Hii haifanya bajeti ya dakika ya akaunti au vikwazo vingine vya kipengele kuwa isiyo na kikomo. |
data.quota.usage_percent |
integer | Asilimia iliyokunjwa inayolingana na dashibodi kutoka 0 hadi 100: iliyotumika imegawanywa kwa iliyotumika pamoja na iliyobaki, ikizidishwa kwa 100. Inajumuisha uwezo wa mkopo unaopatikana, hivyo kuchaji tena kunaweza kupunguza asilimia. Ni 0 kwa quota isiyo na kikomo au bwawa usio na ukubwa; si asilimia ya kiwango cha dakika au uamuzi wa ufikiaji. |
data.quota.reset_at |
string | Muda wa alama ya ISO-8601 na tofauti ya ukanda wa saa kwa ajili ya urejeshaji wa kiasi cha mwezi ujao wa kalenda. Hii si tarehe ya kumaliza usajili, na urejeshaji wa kila mwezi haujajaza tena mikopo iliyonunuliwa. |
status |
string | Mafanikio halisi kwa kipengele hiki cha hali. Vituo vingine vya sanduku la barua vinavyofanikiwa hutumia boolean true. |
data.monthly_limit |
integer | Jina la utendaji wa ulinganifu la uga unaolingana wa data.quota; usiliongeze tena wakati wa kuhesabu salio. |
data.monthly_remaining |
integer|null | Jina la utendaji wa ulinganifu la uga unaolingana wa data.quota; usiliongeze tena wakati wa kuhesabu salio. |
data.purchased_credits |
integer | Jina la utendaji wa ulinganifu la uga unaolingana wa data.quota; usiliongeze tena wakati wa kuhesabu salio. |
Webhook za Posta (Push ya Waktu Wake)
Kama kiasi cha kurejelea API ya REST (GET /messages) ili kuangalia barua inayokuja, andika webhooks ili kuondoa barua jipya kwako au katika mfumo wa automasi kwa wakati wa asili.
Maelezo ya Webhook ya Kufanyika
Kila webhook unaweza kujiunga na moja au zaidi ya matukio. Mipango yako inapokea habari ya matukio kila mara moja ya matukio hayo yanayofika.
Imetumwa kwa wakati halisi kila wakati ujumbe mpya unafikia sanduku la barua lililochaguliwa.
Inatuma wakati kisanduku pokezi cha muda kinamalizika na usindikaji wa webhook umesitishwa.
Imetumwa wakati kisanduku pokezi kilichokwisha muda kinakuwa hai tena chini ya sheria za mpango.
Imetumwa kabla ya webhook na kisanduku chake kufutwa.
Rudi za Maombi na Uthibitisho wa Tandawazi ya HMAC
Kila utawala wa webhook ina kipande cha kipindi cha usalama. Pata kipande cha X-TempMailg-Signature ili kuathiriwa kwamba maombi yanayofika yalitolewa kweli nawa na TempMailg na hawakuwa na kuwa na maombi.
| Jina la Kifupi | Misimamo ya Misalani | Maelezo |
|---|---|---|
User-Agent |
TempMailg-Webhooks/1.0 | Kitambulisho cha kawaida kwa mfanyakazi wa utoaji wa webhook. |
X-TempMailg-Event |
email.received | Aina ya tukio lililochochea usambazaji huu. |
X-TempMailg-Event-Id |
e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c | UUID ya kipekee iliyogawiwa kwa jaribio hili la usambazaji. |
X-TempMailg-Timestamp |
1725192000 | Muda wa Unix epoch unaashiria wakati ombi lilipoanzishwa. |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | Sahihi ya HMAC-SHA256 iliyohesabiwa kutoka {timestamp}.{raw_body} kwa kutumia siri yako. |
X-TempMailg-Test |
false | Kweli wakati imetumwa na kipengele cha "Send Test Ping" katika dashibodi yako. |
Tajiri lililoandikwa kwa kutumia HMAC na SHA256 juu ya maneno:
hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)
Mfano wa Data ya Hadithi (email.received)
Tolewa kama application/json katika mfumo wa POST ya HTTP.
{
"id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"version": "1.0",
"event": "email.received",
"occurred_at": "2026-11-19T02:18:16+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:16+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"
}
}
Mifano ya Utekelezaji wa Mpokeaji
Chagua lugha yako ili kuona jinsi ya kupokea webhooks na kuthibitisha sahihi za HMAC kwa usalama.
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]);
Majukwaa Yanayoungwa Mkono & Ushirikiano wa Uendeshaji
Webhooks za TempMailg hufanya kazi moja kwa moja na vifungo vya HTTPS vya kawaida na majukwaa yanayoongoza ya bila-msimbo/automation:
Hitilafu za kawaida na utatuzi
Hizi ndizo viwango vya majibu ya kawaida ambayo unaweza kuwaona wakati wa kujumlisha API ya mtumiaji.
Token ya Bearer isiyo sahihi, haipo, au imebatilishwa.
Umiliki, ruhusa za kipengele, ufikiaji wa kikoa au ukubwa wa kiambatisho kumezuia operesheni. Angalia msimbo wa jibu na ujumbe.
Rasilimali haikutolewa kwenye mwenyeji ulioidhinishwa au haipatikani kwa mtumiaji.
Ufunguo wa operesheni ulitumiwa tena na maelezo tofauti, operesheni nyingine inasubiri, au usalama wa kisanduku pokezi umebadilika. Kagua msimbo kabla ya kujaribu tena.
Sanduku la posta limekufa au halijafanya kazi.
Vigezo batili, muda wa maisha usiokubalika, uwezo wa jina la utani usiopo, usanidi wa PIN batili au ufunguo wa Idempotency-Key unaokosekana/ubatilifu ulizui operesheni.
Kisanduku pokezi kilicholindwa kinahitaji token halali ya X-Mailbox-Unlock yenye kipengele. Tumia kitendo na target_id kutoka kwa jibu kwa ajili ya kufuta. Mahitaji ya kufungwa au urejeshaji lazima yatatuliwe kabla ya kujaribu tena.
Kikomo cha ombi, mpango uliozimwa, kiasi kilichokamilika, au muda wa kupumzika kumezuia operesheni. Angalia sababu na vichwa vya bajeti vinavyopatikana. Retry-After ni hiari.
Seva haikuweza kukamilisha operesheni. Kwa uundaji au ufutaji uliolindwa, hifadhi ombi sawa na Idempotency-Key unapojaribu tena.
Uhifadhi wa ulinzi au uratibu haukuweza kuthibitishwa. Jaribu tena baada ya kuchelewa kilichotajwa. Jibu hili si malipo yaliyofeli.
Orodha ya haraka
- 401 Unauthorized - Tokeni ya Bearer haipo, si sahihi, imenyima au imekopwa vibaya.
- 403 Forbidden - Mpango wa sasa hauwa na haki ya kutumia API ya mtumiaji kwa sasa.
- 404 Not Found - Mfumo halisi haipo au thamini halisi
- 410 Gone / Expired - Sanduku la posta limekufa au halijafanya kazi tena.
- 429 Rate Limited - Angalia sababu ya jibu na vichwa vya bajeti. Retry-After inatumika tu kwa vizingiti vya muda; mikopo iliyokamilika au ufikiaji uliozimwa inaweza kuhitaji mabadiliko ya akaunti.
Hatua inayopendekezwa inayofuata
Ikiwa umeingia, fungua API Management kwanza na uthibitishe ufunguo wako, hali ya ufikiaji wa kiasi, na URL ya msingi ya API ya mtumiaji kabla ya kujaribu matatizo ya programu yako ya nje.