API-documentatie

GPTMail-API

Gebruik de GPTMail API om via HTTPS met een X-API-Key-header tijdelijke inboxen aan te maken, berichten op te vragen en te lezen en e-mail te verwijderen. Geschikt voor geautomatiseerde tests, CI/CD-pipelines en QA-workflows.

Hoe krijg je een API Key

Buy API requests

Purchase API requests with GPTMail points. Earn points through daily check-ins and public domains, or buy points with LDC at a 1:1 rate.

Buy with points / add requests

Optie 2: Voeg je eigen domein toe

Na een geslaagde MX-controle van een publiek domein: ingediend zonder inloggen → API-sleutel (20000 verzoeken); ingediend terwijl je bent ingelogd → 200 punten. Elk domein krijgt slechts één beloning. Belangrijk: zodra het gekoppeld is, wordt dat domeinachtervoegsel een publiek achtervoegsel voor alle gebruikers van deze site, zodat anderen ook mailboxadressen daaronder kunnen maken. Verwijder, vervang of wijzig na activering het MX-record dat dit domein naar onze service wijst niet. Anders kunnen latere controles het domein als verkeerd geconfigureerd zien. Als een latere controle het MX-record ongeldig vindt, wordt het domein gedeactiveerd. Blijft het MX-record 3 opeenvolgende controles ongeldig, dan wordt de bijbehorende API Key ook gedeactiveerd. Wordt het MX-record later weer geldig, dan wordt het domein automatisch opnieuw geactiveerd.

Domeinen

Openbare testsleutel

Gebruik voor tests de gedeelde openbare sleutel hieronder in de header X-API-Key. Deze verandert elke dag en heeft een daglimiet van 200.000 verzoeken, gedeeld door alle gebruikers.

Resterend vandaag

Reset over

Live quotum voor de publieke key laden...

De onderstaande API-referentie kan als Markdown worden gekopieerd voor AI-tools, kennisbanken of een README.

Basis-URL: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Snelstart

  • X-API-Key: YOUR_KEY is de eenvoudigste optie. Gebruik voor snelle tests de dagelijkse openbare sleutel hierboven in plaats van YOUR_KEY.

  • De meeste mailbox-endpoints vereisen een email-parameter, bijvoorbeeld ?email=demo@example.com.

  • GPTMail API-antwoorden gebruiken JSON met de velden success, data en error, plus usage wanneer een API-sleutel wordt gebruikt. Cloudflare-fouten, waaronder antwoorden bij snelheidslimieten, kunnen in plaats daarvan HTML teruggeven. Controleer de HTTP-status en Content-Type voordat u JSON parseert.

  • Als je al een momenteel ondersteund domein op deze site kent, hoef je eerst geen e-mailgeneratie-endpoint aan te roepen. Je kunt prefix@domain lokaal samenstellen en direct de mailbox-API's aanroepen; dat bespaart één API-request.

Snelheidslimieten en nieuwe pogingen

  • GET en POST /api/generate-email delen een limiet van 30 verzoeken per 10 seconden per bron-IP. Dit geldt voor zowel openbare als persoonlijke API-sleutels. Verschillende sleutels en clients achter hetzelfde IP-adres delen deze limiet.

  • Bij overschrijding van deze limiet volgt HTTP 429 en wordt het genereren van e-mailadressen 10 seconden geblokkeerd. Wacht de duur uit Retry-After af voordat u het opnieuw probeert. Ontbreekt deze header, wacht dan minstens 10 seconden en probeer het daarna opnieuw met toenemende wachttijden. Vermijd gelijktijdige nieuwe pogingen van clients die een IP-adres delen.

  • Deze regel geldt niet voor het weergeven van de inbox of het lezen van afzonderlijke e-mails. De dagelijkse en totale quota van API-sleutels gelden daarnaast onafhankelijk. Wachten van 10 seconden herstelt een uitgeput sleutelquotum niet.

Kern-endpoints

POST / GET
/api/generate-email

Genereer een tijdelijke inbox. Gebruik GET voor de eenvoudigste willekeurige inbox-flow, of POST met prefix en domain als je expliciete controle wilt.

GET
/api/emails?email=...

Haal e-mails op voor een mailbox.

GET
/api/email/{id}?email=...

Haal één e-mail op, inclusief tekst, HTML, ruwe headers en metadata.

DELETE
/api/email/{id}?email=...

Verwijder één e-mail op ID.

DELETE
/api/emails/clear?email=...

Verwijder alle e-mails in een mailbox.

GET
/api/stats

Lees sitewide statistieken.

Voorbeeldflow

Hieronder twee veelvoorkomende patronen: laat de service een inbox voor je genereren, of vraag een vast prefix aan. Als je al een momenteel ondersteund domein kent, kun je het mailboxadres ook lokaal samenstellen en direct opvragen.

1) Genereer een willekeurig tijdelijk e-mailadres

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Voorbeeldresponse
{
  "success": true,
  "data": {
    "email": "a3f9c2b1@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 1,
    "remaining_today": 199999,
    "total_limit": 200000,
    "total_usage": 1,
    "remaining_total": 199999
  }
}

2) Genereren met vast prefix (bijv. demo@example.com)

curl -X POST 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: PUBLIC_API_KEY' \
  -d '{"prefix":"demo"}'
Voorbeeldresponse
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) E-mails in een inbox weergeven

Als je al een ondersteund domein kent, sla stap 1 over en vraag direct op.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Voorbeeldresponse
{
  "success": true,
  "data": {
    "emails": [
      {
        "id": "e5a7f3...",
        "email_address": "demo@example.com",
        "from_address": "noreply@github.com",
        "subject": "Your code: 654321",
        "content": "Your verification code is 654321",
        "html_content": "...",
        "has_html": true,
        "timestamp": 1709654321,
        "created_at": "2024-03-05T12:18:41Z"
      }
    ],
    "count": 1
  }
}

4) Één e-mail lezen — inclusief platte tekst, HTML-body en metadata

Vervang EMAIL_ID door een id uit stap 3. Geef ook het inboxadres mee als email (ook bij verwijderen en bij het downloaden van bijlagen): het bericht wordt dan rechtstreeks uit die inbox gelezen in plaats van op ID te worden gezocht. Met een API-sleutel is de parameter email optioneel, maar meesturen maakt het opzoeken sneller.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Voorbeeldresponse
{
  "success": true,
  "data": {
    "id": "e5a7f3...",
    "email_address": "demo@example.com",
    "from_address": "noreply@github.com",
    "subject": "Your code: 654321",
    "content": "Your verification code is 654321",
    "html_content": "<p>Your code is 654321</p>",
    "has_html": true,
    "timestamp": 1709654321,
    "raw_size": 2048,
    "created_at": "2024-03-05T12:18:41Z"
  }
}

5) Één e-mail verwijderen op ID

Met een API-sleutel is de parameter email optioneel, maar meesturen maakt het opzoeken sneller.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Voorbeeldresponse
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) Hele inbox legen — verwijdert alle e-mails voor dit adres

Elke aanroep verwijdert één batch. Zolang het antwoord "has_more": true bevat, roept u hem opnieuw aan totdat hij false teruggeeft.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/emails/clear?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Voorbeeldresponse
{
  "success": true,
  "data": {
    "message": "Deleted 3 emails",
    "count": 3,
    "has_more": false
  }
}

Response-structuur

Succesvolle responses zien er doorgaans zo uit. Als je met een API Key authenticatieert, let dan op de quotuminformatie in usage.

{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 1,
    "remaining_today": 199999,
    "total_limit": 200000,
    "total_usage": 1,
    "remaining_total": 199999
  }
}

Uitgebreide statistieken

  • /api/statistics/24h geeft één venster van 24 uur met de verdeling per uur terug; gebruik offset=1,2,... voor oudere vensters.
  • /api/statistics/top-subjects geeft de populairste e-mailonderwerpen terug.
  • /api/statistics/top-domains geeft de meest actieve domeinen terug.
  • /api/statistics/top-senders geeft de meest actieve afzenders terug.
GPTMail