Přes REST API (i přes webové rozhraní) lze odeslat doklad e-mailem.
Aby bylo odesílání funkční, 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:
| Adresa SMTP serveru, typicky |
| Port SMTP serveru, typicky |
| Výchozí e-mailová adresa odesílatele |
| Režim zabezpečení SMTP komunikace:
nonebez zabezpečení (výchozí)starttlszabezpečená komunikace, pokud ji server podporuje (příkaz |
| Přihlašovací jméno, pokud SMTP server vyžaduje autentizaci; nepovinné |
| Heslo; nepovinné |
Poznámka:
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:
| Adresát; parametrů |
| Kopie; parametrů |
| Předmět e-mailu |
| |
| Jazyk PDF přílohy |
Musí být zadán alespoň jeden adresát nebo adresát na kopii, předmět je také povinný. 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 musí být tělo e-mailu v textové podobě kódované v UTF-8. E-mail bude odeslán v textové i HTML variantě podle šablony, která je momentálně součástí ABRA Flexi. Do budoucna plánujeme možnost uživatelských šablon.
Jako součást e-mailu bude v příloze odeslána PDF a případně i ISDOC podoba dokladu.
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ářské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>CopyMísto
/devel/
dejte adresář, kde budou data pro modifikaci (např. C:ProjektyFlexiBee).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í. Jsou to tedy ty doklady, které mají v poli Stav Mailu zadanou hodnotu "Odeslat".
Odeslání lze vynutit 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
Místo demo je potřeba zadat název Vaší instance v cloudu. Pokud provozujete Flexi na vlastním serveru, tak místo demo.flexibee.eu je nutné vyplnit adresu Vašeho serveru. Místo firma je potřeba zadat systémový název Vaší firmy ve Flexi. Ten můžete vidět například v URL při přihlášení do webového rozhraní.
__________________________________________________________________