Přeskočit na obsah
Frontmail Docs

Přehled a základní pojmy

Frontmail vám umožní posílat e-maily přímo z frontendu – kontaktní formulář, žádost o rezervaci, potvrzení objednávky – bez vlastního backendu. Připojíte poskytovatele e-mailu, kterého už používáte, v dashboardu navrhnete HTML šablonu s typovanými parametry a zavoláte jedinou funkci:

import { init, send } from '@frontmail/browser';


init({ publicKey: 'pk_4f2a…' });
await send('svc_01J9…', 'tpl_01J9…', { name: 'Jana', message: 'Dobrý den!' });

Požadavek dorazí na Frontmail API, které ho zkontroluje (origin, ochrana proti botům, rate limity, validace parametrů), zarezervuje jeden kredit a zařadí e-mail do fronty. Odesílač pak vyrenderuje šablonu a doručí ji přes vašeho poskytovatele. Události doručení (doručeno, bounce, otevřeno…) se přes webhooky poskytovatele vracejí zpět do historie a statistik.

Stavební kameny

Sekce “Stavební kameny”

Organizace

Sekce “Organizace”

Všechno – klíče, služby, šablony, kredity, členové – patří organizaci. Jeden uživatel může být členem více organizací a přepínat mezi nimi. Každá organizace má svůj tarif a vlastní zůstatek kreditů.

Public key a private key

Sekce “Public key a private key”
Public key pk_… Private key sk_…
Kde žije Ve vašem frontendovém kódu – není to tajemství Jen na vašem serveru – zacházejte s ním jako s heslem
Jak se posílá user_id v těle nebo hlavička X-Frontmail-Public-Key Authorization: Bearer sk_… (nebo accessToken v těle) – nikdy z prohlížeče: požadavky s hlavičkou Origin odmítáme
Co ho chrání Povolené originy, Turnstile, rate limity, ochrana proti botům Jeho utajení – přeskakuje kontroly originu a CAPTCHA
Co umí send, send-form, uploady, čtení stavu vlastních zpráv Vše výše plus send-batch, history, templates

Public key vidí každý, kdo otevře vaši stránku, a proto mu Frontmail nikdy nevěří samotnému. Než spustíte ostrý provoz, přečtěte si Public key a private key.

Služby

Sekce “Služby”

Služba je připojení k poskytovateli e-mailu: SMTP (Seznam, Zoho, vlastní server), Mailgun, Amazon SES, Postmark, SendGrid, Mailjet, Brevo, Resend, Gmail nebo Outlook / Microsoft 365. Přihlašovací údaje jsou šifrované pomocí AWS KMS. Frontmail každou službu kontroluje denně a hned po chybě autentizace. Šablona může mít záložní službu, která převezme odesílání, když primární selže. Viz Přehled služeb.

Šablony

Sekce “Šablony”

Šablona je kompletní HTML e-mail (s automaticky generovanou textovou verzí) plus předmět, příjemci (To, CC, BCC, Reply-To, From) a schéma parametrů. Parametry jsou typované (string, email, number, date, list…) a validují se při každém odeslání. V těle se pro podmínky, cykly a formátovací helpery používá Handlebars. Viz HTML šablony a Parametry a typy.

Kredity

Sekce “Kredity”

Jeden přijatý e-mail = jeden kredit. Kredity pocházejí z grantů:

  • subscription – měsíční kvóta vašeho tarifu (nepřevádí se do dalšího měsíce),
  • pack – předplacené balíčky kreditů s platností 3–12 měsíců, dostupné v každém tarifu včetně Free,
  • bonus – kredity připsané podporou Frontmailu,
  • overdraft – 10% rezerva v placených tarifech, vyúčtovaná na další faktuře.

Kredity se vždy čerpají z grantu, který vyprší nejdřív, overdraft až nakonec. Testovací odeslání z editoru šablon jsou zdarma. Pokud odeslání trvale selže, kredit se vrací. Viz Pořadí čerpání.

Žádný e-mail se tiše neztratí

Sekce “Žádný e-mail se tiše neztratí”

Když vám dojdou kredity, Frontmail e-mail nezahodí. Ve výchozím režimu hold přijme požadavek s odpovědí 202 { "status": "held" }, zprávu uloží a odešle ji automaticky, jakmile budou kredity znovu k dispozici – po nákupu balíčku, auto top-upu, přechodu na vyšší tarif nebo v dalším zúčtovacím období. Přečtěte si Hold frontu.

Životní cyklus zprávy

Sekce “Životní cyklus zprávy”
accepted ─┬─► queued ─► sending ─► sent ─┬─► delivered
          │                              ├─► bounced
          │                              └─► complained
          ├─► held (bez kreditů) ─► queued …   nebo ─► discarded (hold vypršel / ručně)
          └─► (při chybě autentizace u poskytovatele) held_service_error ─► queued … po opravě služby
                                     failed (trvalá chyba, kredit vrácen)

Všechny stavy vysvětluje stránka Stavy zpráv.

Co dál

Sekce “Co dál”