Přes REST API (i přes webové rozhraní) lze odeslat doklad e-mailem. Aby to fungovalo, je třeba nastavit připojení k SMTP serveru. Do souboru flexibee-server.xml (na Linuxu v /etc/flexibee/flexibee-server.xml) doplňte následující hodnoty:
smtp.host | Adresa SMTP serveru, typicky localhost (SMTP server běží na stejném stroji jako ABRA Flexi Server) |
|---|---|
smtp.port | Port SMTP serveru, typicky 25; nepovinné |
smtp.defaultFrom | Výchozí e-mailová adresa odesílatele |
smtp.encryption | Režim zabezpečení SMTP komunikace:
|
smtp.auth.user | Přihlašovací jméno, pokud SMTP server vyžaduje autentizaci; nepovinné |
smtp.auth.password | Heslo; nepovinné |
Pozn.: pokud potřebujete nějaké další konfigurační hodnoty, např. pro SSL, dejte nám vědět.
Odeslání dokladu přes REST API na správně nakonfigurovaném serveru pak znamená PUT (resp. POST) na URL /c/firma/faktura-vydana/1/odeslani-dokladu.xml s následujícími parametry:
&to=email@example.com | Adresát; parametrů to lze uvést více |
|---|---|
&cc=email@example.com | Kopie; parametrů cc lze uvést více |
&subject=Doklad ABC | Předmět e-mailu |
&sablona=code:SABLONA | Uživatelská e-mailová šablona |
&report-lang=en | Jazyk přílohy PDF |
Musí být zadán alespoň jeden adresát nebo adresát na kopii. Jako odesílatel (hlavička From) bude
uveden aktuální uživatel, pod kterým odeslání provádíte, případně výchozí hodnota z konfigurace.
V těle požadavku může být tělo e-mailu v textové podobě kódované v UTF-8. E-mail bude odeslán v textové nebo HTML variantě podle šablony, která je momentálně nastavená v ABRA Flexi.
V parametru sablona může být uveden identifikátor některého záznamu z
evidence sablona-mail.
Priority použití textů:
- Parametr
subject, resp. tělo požadavku. Pokud je text složený pouze z bílých znaků nebude použit. - Šablona z parametru
sablona. - Šablona z typu dokladu.
- Text z typu dokladu.
- Výchozí šablona pro evidenci.
- Výchozí systémový text.
Jako součást e-mailu bude v příloze odeslána PDF a případně i ISDOC podoba dokladu. Jazyk PDF lze měnit
parametrem report-lang. Pokud není parametr uveden, bude použit výchozí jazyk e-mailu.
Kompletní příklad odeslání dokladu z příkazové řádky použitím nástroje curl:
curl -k -L -u uzivatel:heslo -X PUT -d 'Dobrý den, zasíláme Vám slíbený dokument. S pozdravem ...' "https://localhost:5434/c/firma/faktura-vydana/1/odeslani-dokladu.xml?to=email@example.com&subject=Doklad%20ABC"
Všimněte si zejm. předmětu – jako obvykle, parametry v URL musí být správně zakódovány.
Poznámka: je nutné uvést buď odeslani-dokladu.xml nebo hlavičku Accept: text/xml.
Přizpůsobování e-mailových zpráv
V ABRA Flexi lze upravovat zasílané zprávy takto:
- Přizpůsobení textu – lze upravit v typu dokladu výchozí text, který bude použit pro zasílání dokladů.
- Přizpůsobení šablony
Přizpůsobení šablony e-mailové zprávy
Základem je zapnutí vývojářeského adresáře (developerDirectory). Kompletní popis je delší, ale nás zajímá pouze část s nastavením a následně úpravou šablony:
- Je potřeba upravit flexibee-server.xml (kde jej najít?) a přidat tam
<entry key="developerDirectory">/devel/</entry>
Místo/devel/dejte adresář, kde budou data pro modifikaci (např. C:\Projekty\FlexiBee\). - Restartovat ABRA Flexi
- V daném adresáři je potřeba vytvořit adresář "default" (tzv. výchozí instance - jiná hodnota má smysl pouze v cloudovém provozu) a v něm adresář s identifikátorem firmy (ten je stejný jako přes webové rozhraní). Případně je možné použít speciální identifikátor "!all" (bez uvozovek).
- Nakopírovat ukázkové skripty do $developerDirectory/$instance/!all a pro nás jsou důležité soubory z adresáře
mail-templates.
Automatické odeslání dokladů
ABRA Flexi podporuje automatické odeslání všech neodeslaných dokladů, které jsou označené k odeslání.
Odeslání lze vynutít příkazem:
curl -H "Accept: application/xml" -u winstrom:winstrom -X PUT -L https://demo.flexibee.eu:5434/c/demo/faktura-vydana/automaticky-odeslat-neodeslane