Odczytuj wiadomości ze skrzynki pocztowej IMAP przy użyciu danych…
Odczytuj wiadomości ze skrzynki pocztowej IMAP przy użyciu danych uwierzytelniających serwera podanych przez wywołującego, z opcjonalnym filterflat)
Żądanie
- x-api-key: <your-api-key>
- Content-Type: application/json
Odpowiedź
{
"messages": [
{}
],
"status": "success",
"tokensDeducted": 2
}Co robi
Odczytuj wiadomości ze skrzynki pocztowej IMAP przy użyciu danych uwierzytelniających serwera podanych przez wywołującego, z opcjonalnym filterflat)
Żądanie
Treść
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
filter | object | nie | |
↳ attachmentExtensions | array<string> | nie | |
↳ before | string | nie | |
↳ from | string | nie | |
↳ hasAttachment | boolean | nie | |
↳ since | string | nie | |
↳ subject | string | nie | |
↳ unseenOnly | boolean | nie | |
limit | integer | nie | |
mailbox | string | nie | |
markAsRead | boolean | nie | |
server | object | tak | |
↳ host | string | tak | |
↳ password | string | tak | |
↳ port | integer | tak | |
↳ secure | boolean | tak | |
↳ username | string | tak |
Przykładowe żądanie
{
"filter": {},
"limit": 20,
"mailbox": "INBOX",
"markAsRead": false,
"server": {
"host": "example.com",
"password": "correct-horse-battery-staple",
"port": 5,
"secure": true,
"username": "ada"
}
}Odpowiedź
| Pole | Typ | Opis |
|---|---|---|
messages | array<object> | |
status | string | |
tokensDeducted | integer |
Przykładowa odpowiedź
{
"messages": [
{}
],
"status": "success",
"tokensDeducted": 2
}Błędy
Każdy błąd ma tę samą kopertę: status HTTP, kod maszynowy i jedno zdanie.
400 | Treść albo parametr nie przeszły walidacji. Tablica details wskazuje pole. |
401 | Brak klucza, klucz cofnięty albo zły nagłówek. Wyślij x-api-key. |
402 | Portfel nie pokrywa tego wywołania. Doładuj albo poczekaj na miesięczny przydział. |
404 | Zasób nie istnieje albo nie jest Twój. Obie sytuacje odpowiadają identycznie i nic nie kosztują. |
429 | Przekroczony limit na minutę dla Twojego planu. Odczekaj i ponów. |
5xx | Usługa nadrzędna odmówiła albo przekroczyła czas. Wywołanie nie jest rozliczane. |
Kod
curl -X POST 'https://app.castomapi.com/v1/email/read' \
-H 'x-api-key: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{"filter": {}, "limit": 20, "mailbox": "INBOX", "markAsRead": false, "server": {"host": "example.com", "password": "correct-horse-battery-staple", "port": 5, "secure": true, "username": "ada"}}'const res = await fetch('https://app.castomapi.com/v1/email/read', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"filter": {}, "limit": 20, "mailbox": "INBOX", "markAsRead": false, "server": {"host": "example.com", "password": "correct-horse-battery-staple", "port": 5, "secure": true, "username": "ada"}})
});
const data = await res.json();
console.log(data);import { request } from 'node:https';
// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/email/read', {
method: 'POST',
headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
body: JSON.stringify({"filter": {}, "limit": 20, "mailbox": "INBOX", "markAsRead": false, "server": {"host": "example.com", "password": "correct-horse-battery-staple", "port": 5, "secure": true, "username": "ada"}})
});
const data = await res.json();
console.log(data);import requests
res = requests.post(
'https://app.castomapi.com/v1/email/read',
headers={'x-api-key': '<your-api-key>'},
json={"filter": {}, "limit": 20, "mailbox": "INBOX", "markAsRead": False, "server": {"host": "example.com", "password": "correct-horse-battery-staple", "port": 5, "secure": True, "username": "ada"}},
timeout=30,
)
print(res.json())<?php
$ch = curl_init('https://app.castomapi.com/v1/email/read');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode(['filter' => [], 'limit' => 20, 'mailbox' => 'INBOX', 'markAsRead' => false, 'server' => ['host' => 'example.com', 'password' => 'correct-horse-battery-staple', 'port' => 5, 'secure' => true, 'username' => 'ada']]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);Koszt i limity
Ta operacja kosztuje 2 tokenów. Nieudane wywołanie nigdy nie jest rozliczane. Każde konto dostaje 1000 darmowych tokenów miesięcznie; opłacone saldo nie wygasa.
Limity żądań na minutę
| Bez klucza | 10 |
| Free | 60 |
| Pro | 300 |
| Enterprise | 1200 |
Pytania
Ile kosztuje Odczytuj wiadomości ze skrzynki pocztowej IMAP przy użyciu danych…?
2 tokenów za udane wywołanie, pobierane z portfela po odpowiedzi. Nieudane wywołania są bezpłatne. Każde konto dostaje 1000 darmowych tokenów miesięcznie.
Jak się uwierzytelnić?
Wyślij klucz w nagłówku x-api-key. Jeden klucz obejmuje każdy rozliczany endpoint; niczego nie trzeba włączać osobno.
Czy mogę wysłać nagłówek Authorization: Bearer zamiast klucza?
Nie dla rozliczanego endpointu — te przyjmują wyłącznie nagłówek x-api-key. Tokeny Bearer należą do strony konta: panel i API konta przyjmują sesję JWT, a castomapi-auth wydaje je standardowym uzgodnieniem OAuth2, z grantami authorization code, client credentials i refresh. Opisuje to strona usługi auth.
Jakie są limity?
10 żądań na minutę z jednego IP zupełnie bez klucza, 60 na minutę w planie Free, 300 w Pro, 1200 w Enterprise. Powyżej poziomu bez klucza limit jest na konto, łącznie dla wszystkich endpointów.
OpenAPI: https://app.castomapi.com/docs/json