Dokument môžete odoslať e-mailom prostredníctvom rozhrania REST API (aj cez webové rozhranie). Aby to fungovalo, musíte nastaviť pripojenie k serveru SMTP. Pridajte nasledujúce hodnoty do súboru flexibee-server.xml
(v Linuxe do /etc/flexibee/flexibee-server.xml
):
| Adresa servera SMTP, zvyčajne |
| Port servera SMTP, zvyčajne |
| Predvolená e-mailová adresa odosielateľa |
| Režim zabezpečenia komunikácie SMTP:
nosecurity (predvolené)starttlsecurekomunikácia, ak ju server podporuje |
| Prihlasovacie meno, ak server SMTP vyžaduje overenie; nepovinné |
| Heslo; nepovinné |
Poznámka: ak potrebujete ďalšie konfiguračné hodnoty, napr. pre SSL, dajte nám vedieť.
Odoslanie dokumentu prostredníctvom rozhrania REST API na správne nakonfigurovanom serveri potom znamená príkaz PUT
(alebo POST
) na adresu URL /c/company/invoice-issued/1/send-document.xml
s nasledujúcimi parametrami:
| Príjemca; |
| Kopírovať; možno zadať viacero parametrov |
| Predmet e-mailu |
Na kópii musí byť uvedený aspoň jeden adresát alebo adresátka; povinný je aj predmet. Odosielateľ (
hlavička From
) bude aktuálny používateľ, pod ktorým odosielate, alebo predvolená hodnota z konfigurácie.
Telo požiadavky musí byť v textovej forme v kódovaní UTF-8. E-mail sa odošle v textovej a HTML podobe podľa šablóny, ktorá je v súčasnosti súčasťou systému ABRA Flexi. V budúcnosti plánujeme umožniť používanie vlastných šablón.
Súčasťou e-mailu bude príloha vo formáte PDF a prípadne aj vo formáte ISDOC.
Úplný príklad odoslania dokumentu z príkazového riadku pomocou nástroja curl
:
curl -k -L -u user:password -X PUT -d 'Dobrý deň, posielame vám sľúbený dokument. S pozdravom ..." "https://localhost:5434/c/firma/faktura-vydana/1/odeslani-dokladu.xml?to=email@example.com&subject=Doklad%20ABC"
Všimnite si riadok predmetu - ako zvyčajne, parametre v adrese URL musia byť správne zakódované.
Poznámka: musíte uviesť buď send-document.xml
, alebo hlavičku Accept: text/xml
.
Prispôsobenie e-mailových správ
V systéme ABRA Flexi môžete odosielané správy prispôsobiť nasledovne:
Prispôsobenie textu - môžete prispôsobiť predvolený text v type dokumentu, ktorý sa použije na odosielanie dokumentov.
Prispôsobenie šablóny
Prispôsobenie šablóny e-mailovej správy
Základným krokom je povolenie adresára pre vývojárov (developerDirectory). Celý opis je dlhší, ale nás zaujíma len časť o nastavení a následnej úprave šablóny:
Musíte upraviť flexibee-server.xml(kde ho nájsť?) a pridať tam <entry key="developerDirectory">/devel/</entry>CopyNa miesto /devel/ vložte adresár, v
ktorom
budú dáta na úpravu (napr. C:ProjectsFlexiBee).Reštartovanie systému ABRA Flexi
V danom adresári je potrebné vytvoriť "predvolený" adresár (tzv. predvolená inštancia - iná hodnota má zmysel len pri cloudovej prevádzke) a v ňom adresár s identifikátorom firmy (je to rovnaké ako cez webové rozhranie). Prípadne môžete použiť špeciálny identifikátor "!all" (bez úvodzoviek).
Ukážkové skripty skopírujte do adresára $developerDirectory/$instance/!all a súbory z adresára
mail-templates
sú pre nás dôležité.
Automatické odosielanie dokumentov
ABRA Flexi podporuje automatické odosielanie všetkých neodoslaných dokumentov, ktoré sú označené na odoslanie.
Odoslanie je možné vynútiť príkazom:
curl -H "Accept: application/xml" -u winstrom:winstrom -X PUT -L https://demo.flexibee.eu:5434/c/demo/faktura-vydana/automaticky-odeslat-neodeslane¨