https://github.com/vitexsoftware/abraflexi-mailer
Document Sender for AbraFlexi
https://github.com/vitexsoftware/abraflexi-mailer
abraflexi document-sender-app mailer
Last synced: 6 months ago
JSON representation
Document Sender for AbraFlexi
- Host: GitHub
- URL: https://github.com/vitexsoftware/abraflexi-mailer
- Owner: VitexSoftware
- License: mit
- Created: 2020-12-19T12:34:36.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-27T10:43:43.000Z (10 months ago)
- Last Synced: 2025-02-14T22:37:35.481Z (8 months ago)
- Topics: abraflexi, document-sender-app, mailer
- Language: FreeMarker
- Homepage: https://multiflexi.eu/
- Size: 963 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.cs.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Odesílač dokladů pro AbraFlexi
==============================
K dispozici jsou skripty pro odesílání dokladů:
[SendUnsent.php](src/SendUnsent.php) - hromadně odešle neodeslané standartním způsobem přímo z AbraFlexi
[SendUnsentAttachments.php](src/SendUnsentAttachments.php) - najde neodeslané, připojí k nim přílohy a odešle přes výchozí mailer PHP, nebo SMTP
Doklady jsou odesílány na adresy dle následujícího klíče:
1. "kontaktEmail" z dokladu
2. email firmy
3. email primárního kontaktu
4. email kontaktu
Pokud je v poznámce dokladu nalezena adresa s prefixem cc např.: "cc:emailova@adresa.cz, cc:kopii@sem.com", odešle se kopie i na tyto maily.
Konfigurace
-----------
S provádí uvedenín direktiv do .env souboru, jejich definicí jako konstant, nebo nastavením proměnných prostředí.
Debianí balíček konfiurák očekává ve složce /etc/abraflexi-mailer, kde je k dispozici vzorový sobor .env.template
```env
APP_NAME=AbraFlexiMailer - název aplikace v syslogu
APP_DEBUG=true - zapnutí ladícího režimu
MUTE=true - neodesílat zprávy příjemcům ale na
EASE_MAILTO=info@vitexsoftware.cz - sem se posílají zprávy je-li mute aktivní
ABRAFLEXI_URL="https://demo.abraflexi.eu:5434"
ABRAFLEXI_LOGIN="winstrom"
ABRAFLEXI_PASSWORD="winstrom"
ABRAFLEXI_COMPANY="demo"
ABRAFLEXI_CUSTOMER="demo"
ADD_LOGO=true - vkládat do mailu i logo firmy
ADD_QRCODE=true - vkládat do mailu i Obrázek pro QR platbu
MAIL_CC=info@vitexsoftware.cz - všechny maily odesílat také v kopii na tuto adresu
MAIL_FROM=office@vitexsoftware.cz - adresa odesilatele
EASE_LOGGER="console|syslog" - způsob logování
SEND_LOCKED=False - pokusi se dočasně odemknout zamknutý doklad
DRY_RUN=False - je-li povoleno nezapisuje do dokladů datum a stav odeslání
```
Šablony
-------
Předpokládá se že šablona se jmenuje dle evidence. např. **faktura-vydana.ftl**
a je uložena ve složce "templates" ( /usr/share/abraflexi-mailer/templates v Debianu )
V šablonách je možné použít následující proměnné:
* ${application} – Název aplikace, tedy "AbraFlexi BulkMail"
* ${user} – Objekt uživatele, se kterým můžeme dále pracovat
* ${company} – Nastavení firmy
* ${uzivatelJmeno} – Vaše křestní jméno
* ${uzivatelPrijmeni} – Vaše příjmení
* ${titulJmenoPrijmeni} – Vaše celé jméno, včetně dosažených titulů
* ${nazevFirmy} – Název firmy
* ${doklad} – Doklad určený k odeslání
Hromadný rozesílač
------------------
Pokud chceme obeslat všechny klienty z Pražské nerudovy ulice:
```shell
abraflexi-bulkmail templates/template.ftl "(mesto='Praha' AND ulice='Nerudova')"
```
Při použití v [šabloně](tests/test.ftl) se proměnné pro každou odeslanou zprávu
naplní z https://demo.flexibee.eu/c/demo_de/adresar/properties
Závislosti
----------
Tento nástroj ke svojí funkci využívá následující knihovny:
* [**EasePHP Framework**](https://github.com/VitexSoftware/php-ease-core) - pomocné funkce např. logování
* [**AbraFlexi**](https://github.com/Spoje-NET/php-abraflexi) - komunikace s [AbraFlexi](https://flexibee.eu/)
* [**AbraFlexi Bricks**](https://github.com/VitexSoftware/AbraFlexi-Bricks) - používají se třídy Zákazníka, Upomínky a Upomínače
Poděkování
----------
Tento software by nevznikl pez podpory:
[  ](https://spoje.net/)
Další software pro AbraFlexi
---------------------------
* [Pravidelné reporty z AbraFlexi](https://github.com/VitexSoftware/AbraFlexi-Digest)
* [Odesílač upomínek](https://github.com/VitexSoftware/php-abraflexi-reminder)
* [Klientská Zóna pro AbraFlexi](https://github.com/VitexSoftware/AbraFlexi-ClientZone)
* [Nástroje pro testování a správu AbraFlexi](https://github.com/VitexSoftware/AbraFlexi-TestingTools)
* [Monitoring funkce AbraFlexi serveru](https://github.com/VitexSoftware/monitoring-plugins-abraflexi)
* [AbraFlexi server bez grafických závislostí](https://github.com/VitexSoftware/abraflexi-server-deb)
MultiFlexi
----------
AbraFlexi Mailer is ready for run as [MultiFlexi](https://multiflexi.eu) application.
See the full list of ready-to-run applications within the MultiFlexi platform on the [application list page](https://www.multiflexi.eu/apps.php).
[](https://www.multiflexi.eu/apps.php)
Debian/Ubuntu
-------------
Pro Linux jsou k dispozici .deb balíčky. Prosím použijte repo:
```shell
echo "deb http://repo.vitexsoftware.com $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/vitexsoftware.list
sudo wget -O /etc/apt/trusted.gpg.d/vitexsoftware.gpg http://repo.vitexsoftware.cz/keyring.gpg
sudo apt update
sudo apt install abraflexi-mailer
```
Po instalaci balíku jsou v systému k dispozici tyto nové příkazy:
* **abraflexi-send** - odešle doklad (TODO)
* **abraflexi-send-unsent** - odešle neodeslané
* **abraflexi-send-attachments** - odešle doklad s přílohami (TODO)
* **abraflexi-send-unsent-attachments** - odešle neodeslané s přílohami
* **abraflexi-show-unsent** - vypíše neodeslané doklady
* **abraflexi-bulkmail** - hromadně odešle maily kontaktům z adresáře