Wiki-Quellcode von IMAP-Plugin

Zeige letzte Bearbeiter
1 {{content/}}
2
3 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.
4
5 == Funktionalitäten ==
6
7 * **Sofortige Benachrichtigung**
8 Über die IMAP-Schnittstelle werden Sie sofort über neue oder geänderte Formular-Eingänge informiert
9
10 * **Konfigurierbarer Inhalt**
11 Ü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.
12
13 * **Bereitstellung von Dateien**
14 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
15
16 * **Abbildung der verfügbaren Postfach-Struktur**
17 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.
18
19 * **Verwalten von Formular-Eingängen**
20 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 oder das Verschieben in den Papierkorb möglich. Fehlt diese Berechtigung, taucht die Nachricht nach wenigen Sekunden wieder in Ihrem E-Mail-Programm auf.
21
22 Der zur Verfügung gestellte SMTP-Server ist aktuell ohne Funktionalität, sodass abgesendete Nachrichten von diesem komplett verworfen werden.
23
24 == Installation und Konfiguration ==
25
26 === Installation ===
27
28 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. 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.
29
30 {{info}}
31 Da das IMAP-Plugin bei der Anmeldung und dem Ausliefern von Nachrichten keine Unterscheidung trifft unter welchem Mandant dies installiert ist und somit immer allen Benutzern zur Verfügung steht, ist anzuraten dies als System-Plugin zu installieren. Dies umgeht auch mögliche Probleme mit doppelt belegten Ports und ermöglicht eine zentralere Konfiguration.
32 {{/info}}
33
34
35 === Konfiguration des Plugins ===
36
37 {{figure image="config_de.png"}}
38 Plugin-Konfiguration
39 {{/figure}}
40
41 Nach bzw. während der Installation stehen Ihnen die in Abbildung dargestellten Konfigurationsparameter zur Verfügung. Diese dienen hierbei für folgende Einstellungen:
42
43 {{id name="server_config"/}}
44
45 ==== Konfiguration Mail-Server Service ====
46
47
48 * **smtp.binding.address** (Standard: 0.0.0.0)
49 Gibt die zu verwendende IP-Adresse des SMPT-Servers an. Der Standardwert ist 0.0.0.0 und verwendet damit 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.
50
51 * **smtp.binding.port** (Standard: 25)
52 Gibt den zu verwendenten Port des SMPT-Servers an. Der Standardwert sollte nur geändert werden, falls dieser Port nicht zur Verfügung steht.
53
54 * **imap.binding.address** (Standard: 0.0.0.0)
55 Gibt die zu verwendende IP-Adresse des IMAP-Servers an. Der Standardwert ist 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.
56
57 * **imap.binding.port** (Standard: 143)
58 Gibt den zu verwendenten Port des IMAP-Servers an. Der Standardwert sollte nur geändert werden, falls dieser Port nicht zur Verfügung steht.
59
60 {{id name="message_files_config"/}}
61
62 ==== Konfiguration Mail Message ====
63
64
65 * **mail.to.template** (Standard: mail_to.txt)
66 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.
67
68 * **mail.from.template** (Standard: mail_from.txt)
69 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.
70
71 * **mail.subject.template** (Standard: mail_subject.txt)
72 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.
73
74 * **mail.body.template** (Standard: mail_body.txt)
75 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.
76
77 === Konfiguration der E-Mail-Inhalte und Felder ===
78
79 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.
80
81 * **Inhalt** (mail_body.txt)
82 Definiert den Inhalt der E-Mail-Nachricht. Hier besteht als einziges die Möglichkeit HTML zu hinterlegen.
83 //Beispiel: //
84 {{code language="html"}}<html>
85 <head></head>
86 <body>
87 <p><a href="[%$FORM_INBOX_LINK%]">Link</a> zum Vorgang ([%$PROCESS_ID%]).</p>
88 </body>
89 </html>{{/code}}
90
91 * **Betreff** (mail_subject.txt)
92 Definiert den Betreff der Nachricht.
93 //Beispiel: //{{code language="none"}}ID: [%$RECORD_ID%] - [%$STATUS_NAME%]{{/code}}
94
95 * **Empfänger** (mail_to.txt)
96 Definiert den Empfänger der Nachricht. Dieser ist nach dem Muster //Name <user@example.com>// anzugeben und hat keinerlei Auswirkungen auf den eigentlichen Empfang der Nachricht.
97 //Beispiel: //{{code language="none"}}XIMA FORMCYCLE <no-reply@example.com>{{/code}}
98
99 * **Absender** (mail_from.txt)
100 Definiert den Absender der Nachricht. Dieser ist nach dem Muster //Name <user@example.com>// anzugeben und hat keinerlei Auswirkungen auf das Absenden derNachricht.
101 //Beispiel: //{{code language="none"}}[%$PROJECT_NAME%] <[%$PROJECT_NAME%]@example.com>{{/code}}
102
103 === Konfiguration der E-Mail-Programme ===
104
105 Für die Konfiguration des E-Mail-Programms sind neben der Adresse des Servers die unter [[Konfiguration Mail-Server Service>>||anchor="server_config"]] hinerlegten Ports zu verwenden. Die kompletten zu verwendenden Anmeldedaten setzen sich demnach wie folgt zusammen:
106
107 * **SMPT-Server:** //<Server-Adresse>//
108 * **SMPT-Port:** //siehe //[[Konfiguration Mail-Server Service>>||anchor="server_config"]]
109 * **IMAP-Server:** //<Server-Adresse>//
110 * **IMAP-Port:** //siehe //[[Konfiguration Mail-Server Service>>||anchor="server_config"]]
111 * **Benutzername:** //<FORMCYCLE-Benutzer>@<FORMCYCLE-Mandantname>//
112 * **Passwort:** //<FORMCYCLE-Benutzer-Passwort>//
113 * **Authentifizierung:** Passwort, normal
114 * **SSL/Verschlüsselung/Verbindungssicherheit:** keine
115
116 ==== Beispielkonfiguration Thunderbird ====
117
118
119 1. Die Verwaltung der E-Mail-Konten über Extras > Konto-Einstellungen öffnen.{{lightbox image="thunderbird_1.png" group="g0" width="200"/}}
120 1. Über Konto-Aktionen > E-Mail-Konto hinzufügen... den Dialog zum Konfigurieren eines neuen Kontos öffnen.{{lightbox image="thunderbird_2.png" group="g0" width="200"/}}
121 1. Initial versucht Thunderbird anhand der eingetragenen E-Mail-Adresse (hier //user@imap.de//) einen Server automatisch zu ermitteln. Da dies hier nicht möglich ist, kann dies über die Schaltfläche "Manuell bearbeiten" abgebrochen werden.{{lightbox image="thunderbird_3.png" group="g0" width="200"/}}
122 1. In darauf folgenden Oberfläche der Server-Konfiguration können nun die entsprechenden Daten eingetragen werden. Im Beispiel lautet der Mandantname //imap.de// und der Benutzer-Name //user// und es werden die Standard-Ports benutzt.{{lightbox image="thunderbird_4.png" group="g0" width="200"/}}
123 1. Nach Fertigstellung der Konfiguration erscheinen nun die entsprechenden Postfächer des Benutzers als Ordner (hier //Zentrales Postfach// und //Demopostfach//) und die darin enthaltenen Nachrichten der vorhandenen Formular-Eingänge.{{lightbox image="thunderbird_5.png" group="g0" width="200"/}}

Navigation

Copyright 2000-2025