Wiki-Quellcode von IMAP-Plugin

Zeige letzte Bearbeiter
1 Mit dem IMAP-Plugin für {{formcycle/}} haben Sie die Möglichkeit, Daten von Formular-Eingängen innerhalb Ihres E-Mail-Programms anzuzeigen, diese zu verwalten und sofort über neue Eingänge informiert zu werden. Hierfür stellt dieses Plugin einen IMAP- und SMTP-Server zur Verfügung welcher in jedem gängigen E-Mail-Programm angebunden werden kann.
2
3 == Funktionalitäten ==
4
5 * **Sofortige Inforamtion**
6 Über die IMAP-Schnittstelle werden Sie sofort über neue oder geänderte Formular-Eingänge informiert
7
8 * **Konfigurierbarer Inhalt**
9 Über entsprechende Vorlagen ist der Inhalt der Benachrichtigungen sowie deren Betreff-, Absender- und Empfänger-Felder frei konfigurierbar. Da hier der [[Platzhalter>>doc:Formcycle.UserInterface.Variables||target="_blank"]]-Mechanismus greift, ist können neben einzelnen Werten oder Meta-Daten des Formular-Eingangs auch Links zur Wiederanzeige direkt innerhalb des Postfachs erzeugt werden.
10
11 * **Bereitstellung von Dateien**
12 Einer Nachricht werden automatisch die innerhalb des Formulars hochgeladenen oder während der Statusverarbeitung erzeugten Dateien angehanden und stehen damit direkt in Ihrem E-Mail-Programm zur Verfügung
13
14 * **Abbildung der verfügbaren Postfach-Struktur**
15 Da für die Abbildung der {{formcycle/}}-Postfächer innerhalb Ihres E-Mail-Programms entsprechende Ordner angelegt werden, hat der Benutzer auch hier nur Zugriff auf Formular-Eingänge die er je nach Benutzergruppen-Konfiguration haben darf. Zusätzlich wird der Ordner "Posteingang" als Sammelpostfach zur Darstellung aller ihm zugänglichen Formular-Eingänge benutzt.
16
17 * **Verwalten von Formular-Eingängen**
18 Neben der eigentlichen Anzeige stehen Ihnen auch die Möglichkeiten der Verwaltung von Formular-Eingängen zur Verfügung. So wird ein Formular-Eingang beim Verschieben einen Ordner in da entsprechenden {{formcycle/}}-Postfach verschoben. Ferner wird der Gelesen-Status ebenso synchronisiert. Das Löschen von Formular-Eingängen ist bei entsprechender Berechtigung ebenso durch das Löschen der zugehörigen Nachricht möglich. Fehlt diese Berechtigung taucht die Nachricht nach wenigen Sekunden wieder in Ihrem E-Mail-Programm auf.
19
20 == Installation und Konfiguration ==
21
22 === Installation ===
23
24 Die Installation des Plugins ist über die dafür vorgesehene Verwaltungsoberfläche von Plugins durchzuführen. Hierbei muss lediglich die entsprechende jar-Datei eingespielt werden. Es macht ferner Sinn das IMAP-Plugin als System-Plugin zu installieren, da es sonst ggf. zu Mehrfachelegung der entsprechenden Ports durch den Server kommen könnte. Ferner kann die erste Installation je nach Anzahl von Formular-Eingängen auf Grund einer kompletten Aufbereitung der Daten für den IMAP-Server mehrere Minuten andauern.
25
26 === Konfiguration des Plugins ===
27
28 {{figure image="config_de.png"}}
29 Plugin-Konfiguration
30 {{/figure}}
31
32 Nach bzw. während der Installation stehen Ihnen die in Abbildung dargestellten Konfigurationsparameter zur Verfügung. Diese dienen hierbei für folgende Einstellungen:
33
34 ==== Konfiguration Mail-Server Service ====
35
36
37 * **smtp.binding.address**
38 Gibt die zu verwendende IP-Adresse des SMPT-Servers an. Der Wert ist hierbei standardmäßig 0.0.0.0 und verwendet hier ein automatisch ermittelte IP. Eine Änderung dieses Wertes ist nur nötig falls mehrere Netzwerk-Adapter im Einsatz sind und/oder die automatische Ermittlung fehlschlägt.
39
40 * **smtp.binding.port**
41 Gibt den zu verwendenten Port des SMPT-Servers an. Der Standardwert ist hierbei 25 und sollte nur geändert werden, falls dieser Port nicht zur Verfügung steht.
42
43 * **imap.binding.address**
44 Gibt die zu verwendende IP-Adresse des IMAP-Servers an. Der Wert ist hierbei standardmäßig 0.0.0.0 und verwendet damit ebenfalls eine automatisch ermittelte IP. Eine Änderung dieses Wertes ist nur nötig falls mehrere Netzwerk-Adapter im Einsatz sind und/oder die automatische Ermittlung fehlschlägt.
45
46 * **imap.binding.port**
47 Gibt den zu verwendenten Port des IMAP-Servers an. Der Standardwert ist hierbei 143 und sollte nur geändert werden, falls dieser Port nicht zur Verfügung steht.
48
49 {{id name="message_files_config"/}}
50
51 ==== Konfiguration Mail Message ====
52
53 * **mail.to.template**
54 Gibt den Namen der Datei an welche unter den Mandant/Projekt-Ressourcen gesucht und als Vorlage für den E-Mail-Empfänger benutzt werden soll. Standard: mail_to.txt
55
56 * **mail.from.template**
57 Gibt den Namen der Datei an welche unter den Mandant/Projekt-Ressourcen gesucht und als Vorlage für den E-Mail-Absender benutzt werden soll. Standard: mail_from.txt
58
59 * **mail.subject.template**
60 Gibt den Namen der Datei an welche unter den Mandant/Projekt-Ressourcen gesucht und als Vorlage für den E-Mail-Betreff benutzt werden soll. Standard: mail_subject.txt
61
62 * **mail.body.template**
63 Gibt den Namen der Datei an welche unter den Mandant/Projekt-Ressourcen gesucht und als Vorlage für den E-Mail-Inhalt benutzt werden soll. Standard: mail_body.txt
64
65 === Konfiguration der E-Mail-Inhalte und Felder ===
66
67 Die Konfiguration der Inhalte und Felder der eigentlichen Nachricht benutzt einen Vorlagen-Mechanismus basierend auf den vier unter [[Konfiguration Mail Message>>||anchor="message_files_config"]] benannten Dateien. Diese werden bei der Installation des Plugins als Mandant-Datei eingespielt und bei der Synchronisation der Nachrichten benutzt. Um eine Projekt-spezifische Anzeige zu gewährleisten ist es möglich gleich benannte Dateien manuell als Projekt-Resource anzulegen und somit die Mandant-Dateien zu überlagern. In allen Dateien ist hierbei der [[Platzhalter>>doc:Formcycle.UserInterface.Variables||target="_blank"]]-Mechanismus aktiv, sodass hier Daten des Formular-Eingangs ausgegeben werden können. Ebenso ist es hierrüber möglich z.B. Link zur Anzeige des ausgefüllten Formulars zu erzeugen.
68
69 * **Inhalt** (mail_body.txt)
70 Definiert den Inhalt der E-Mail-Nachricht. Hier besteht die Möglichkeit HTML zu hinterlegen. Beispiel:
71 {{code language="html"}}<html>
72 <head></head>
73 <body>
74 <p><a href="[%$FORM_INBOX_LINK%]">Link</a> zum Vorgang ([%$PROCESS_ID%]).</p>
75 </body>
76 </html>{{/code}}
77
78 === Konfiguration der E-Mail-Programme ===
79
80
81

Navigation

Copyright 2000-2025