Sie können ein Dokument per E-Mail über die REST-API (auch über die Weboberfläche) versenden. Damit dies funktioniert, müssen Sie eine Verbindung zu einem SMTP-Server einrichten. Fügen Sie die folgenden Werte in die Datei flexibee-server.xml
ein (unter Linux in /etc/flexibee/flexibee-server.xml
):
| Die Adresse des SMTP-Servers, normalerweise |
| SMTP-Server-Port, typischerweise |
| Standardabsender-E-Mail-Adresse |
| Der Sicherheitsmodus der SMTP-Kommunikation:
nosecurity (Standard)starttlsichereKommunikation, wenn vom Server unterstützt |
| Anmeldename, wenn der SMTP-Server eine Authentifizierung erfordert; optional |
| Passwort; optional |
Hinweis: Wenn Sie zusätzliche Konfigurationswerte benötigen, z. B. für SSL, lassen Sie es uns wissen.
Das Senden eines Dokuments über die REST-API auf einem korrekt konfigurierten Server bedeutet dann ein PUT
(oder POST
) an die URL /c/company/invoice-issued/1/send-document.xml
mit den folgenden Parametern:
| Empfänger; weitere Parameter |
| Kopieren; mehrere |
| E-Mail-Betreff |
Es muss mindestens ein Adressat oder Empfänger auf der Kopie angegeben werden; auch der Betreff ist zwingend erforderlich. Der Absender (From-Header
) ist der aktuelle Benutzer, unter dem Sie senden, oder der Standardwert aus der Konfiguration.
Der Körper der Anfrage muss in UTF-8-kodierter Textform vorliegen. Die E-Mail wird in Text und HTML gemäß der Vorlage gesendet, die derzeit in ABRA Flexi enthalten ist. Für die Zukunft ist geplant, benutzerdefinierte Vorlagen zuzulassen.
Als Teil der E-Mail wird ein PDF und ggf. ein ISDOC-Formular des Dokuments als Anhang mitgeschickt.
Ein vollständiges Beispiel für das Senden eines Dokuments über die Befehlszeile mit dem Tool curl
:
curl -k -L -u user:password -X PUT -d 'Hallo, wir senden Ihnen das versprochene Dokument. Mit freundlichen Grüßen ...' "https://localhost:5434/c/firma/faktura-vydana/1/odeslani-dokladu.xml?to=email@example.com&subject=Doklad%20ABC"
Beachten Sie die Betreffzeile - wie üblich müssen die Parameter in der URL richtig kodiert sein.
Hinweis: Sie müssen entweder send-document.xml
oder den Header Accept: text/xml
einschließen.
Anpassen von E-Mail-Nachrichten
In ABRA Flexi können Sie die von Ihnen gesendeten Nachrichten wie folgt anpassen:
Textanpassung - Sie können den Standardtext im Dokumenttyp, der für das Senden von Dokumenten verwendet wird, anpassen.
Anpassen der Vorlage
Anpassen der E-Mail-Nachrichtenvorlage
Der grundlegende Schritt besteht darin, das Entwicklerverzeichnis (developerDirectory) zu aktivieren. Die vollständige Beschreibung ist länger, aber wir sind nur an dem Teil interessiert, in dem es um das Einrichten und anschließende Ändern der Vorlage geht:
Sie müssen die Datei flexibee-server.xml bearbeiten(wo ist sie zu finden?) und dort <entry key="developerDirectory">/devel/</entry>CopyInstead of /devel/ put the directory
where the
data for modification will be (e.g. C:ProjectsFlexiBee) hinzufügen.ABRA Flexi neu starten
In dem angegebenen Verzeichnis müssen Sie ein "Standard"-Verzeichnis (die sogenannte Default-Instanz - ein anderer Wert macht nur im Cloud-Betrieb Sinn) und darin ein Verzeichnis mit der Firmenkennung anlegen (dies ist das gleiche wie über die Weboberfläche). Alternativ können Sie auch den speziellen Bezeichner "!all" (ohne Anführungszeichen) verwenden.
Kopieren Sie die Beispielskripte nach $developerDirectory/$instance/!all und die Dateien aus dem Verzeichnis
mail-templates
sind für uns wichtig.
Automatisch Dokumente versenden
ABRA Flexi unterstützt den automatischen Versand aller nicht gesendeten Dokumente, die zum Versand markiert sind.
Das Senden kann mit dem Befehl erzwungen werden:
curl -H "Accept: application/xml" -u winstrom:winstrom -X PUT -L https://demo.flexibee.eu:5434/c/demo/faktura-vydana/automaticky-odeslat-neodeslane¨