INTEGRITY Dokumentace

REST API

REST API umožňuje odesílat e-maily z libovolné aplikace pomocí standardního HTTP požadavku na POST /accounts/{account_id}/email/sending/send. Můžete ho použít z jakéhokoli backendu, serverless funkce nebo kanálu CI/CD, vazba Cloudflare Workers není potřeba.

Úplnou specifikaci OpenAPI najdete v Referenční dokumentace k API Email Sending.

Cloudflare také poskytuje oficiální SDK pro REST API: Node, Python, a Go.

Ověřování

Ověřte se pomocí Token Cloudflare API s oprávněním odesílat e-maily. Zahrňte jej do Authorization hlavičku:

Authorization: Bearer <API_TOKEN>

Odeslání e-mailu

curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/send" \
  --header "Authorization: Bearer <API_TOKEN>" \
  --header "Content-Type: application/json" \
  --data '{
    "to": "[email protected]",
    "from": "[email protected]",
    "subject": "Welcome to our service!",
    "html": "<h1>Welcome!</h1><p>Thanks for signing up.</p>",
    "text": "Welcome! Thanks for signing up."
  }'

Informace o více příjemcích, CC/BCC a pojmenovaných adresách najdete v Zadání příjemců.

Přílohy

Soubory odešlete tak, že obsah zakódovaný v base64 zahrnete do attachments pole. Celková velikost zprávy nesmí překročit 5 MiB (včetně příloh).

curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/send" \
  --header "Authorization: Bearer <API_TOKEN>" \
  --header "Content-Type: application/json" \
  --data '{
    "to": "[email protected]",
    "from": "[email protected]",
    "subject": "Your Invoice",
    "html": "<h1>Invoice attached</h1><p>Please find your invoice attached.</p>",
    "attachments": [
      {
        "content": "JVBERi0xLjQKJeLjz9MK...",
        "filename": "invoice-12345.pdf",
        "type": "application/pdf",
        "disposition": "attachment"
      }
    ]
  }'

Informace o vložených obrázcích a nahrávání souborů najdete v E-mailové přílohy.

Vlastní hlavičky

Nastavte vlastní hlavičky pro vlákna zpráv, správu seznamů nebo sledování. Více informací najdete v referenční přehled hlaviček e-mailu pro úplný seznam povolených hlaviček.

curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/send" \
  --header "Authorization: Bearer <API_TOKEN>" \
  --header "Content-Type: application/json" \
  --data '{
    "to": "[email protected]",
    "from": "[email protected]",
    "subject": "Your weekly digest",
    "html": "<h1>Weekly Digest</h1>",
    "headers": {
      "List-Unsubscribe": "<https://yourdomain.com/unsubscribe?id=abc123>",
      "List-Unsubscribe-Post": "List-Unsubscribe=One-Click",
      "X-Campaign-ID": "weekly-digest-2026-03"
    }
  }'

Odpověď

Úspěšná odpověď vrací stav doručení pro každého příjemce:

{
	"success": true,
	"errors": [],
	"messages": [],
	"result": {
		"delivered": ["[email protected]"],
		"permanent_bounces": [],
		"queued": []
	}
}

Zpracování chyb

REST API vrací standardní chybové odpovědi Cloudflare API. Neúspěšný požadavek vrátí errors pole s číselnými chybovými kódy a strojově čitelnými zprávami:

{
	"success": false,
	"errors": [
		{
			"code": 10001,
			"message": "email.sending.error.invalid_request_schema"
		}
	],
	"messages": [],
	"result": null
}

Chybové kódy REST API:

Stav HTTP Kód Zpráva Popis
400 10001 email.sending.error.invalid_request_schema Neplatný formát požadavku
400 10200 email.sending.error.email.too_big E-mail překračuje limit velikosti
400 10201 email.sending.error.email.no_content_length Chybí délka obsahu
400 10202 email.sending.error.email.invalid Neplatný obsah e-mailu
401 10101 email.sending.error.authentication.unauthorized Chybí nebo je neplatný token API
401 10103 email.sending.error.authentication.bad_token_type Nesprávný typ tokenu pro tento endpoint
403 10102 email.sending.error.authentication.forbidden Token nemá oprávnění k odesílání
403 10105 email.sending.error.authentication.not_entitled Účet nemá oprávnění používat Email Sending
403 10203 email.sending.error.email.sending_disabled Odesílání je pro tuto zónu nebo účet zakázáno
404 10000 email.sending.error.not_found Prostředek nenalezen
429 10004 email.sending.error.throttled Překročen limit rychlosti
500 10002 email.sending.error.internal_server Interní chyba serveru
500 10003 email.sending.error.not_implemented Operace nebyla implementována
503 10100 email.sending.error.authentication.upstream Autentizační služba je dočasně nedostupná

Další kroky