Wiki-Quellcode von IMAP-Plugin

Verstecke letzte Bearbeiter

version	line-number	content
35.1	1	[[Plugin-Download>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/IMAP%26SMTP%20Mail-Proxy&fileid=3263\|\|rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
34.21	2
30.1	3	{{content/}}
	4
34.19	5	Mit dem {{smallcaps}}Imap{{/smallcaps}}-Plugin für {{formcycle/}} besteht die Möglichkeit, Daten von Formular-Eingängen innerhalb eines E-Mail-Programms anzuzeigen, diese zu verwalten und sich sofort über neue Eingänge informieren zu lassen. Hierfür stellt dieses Plugin einen {{smallcaps}}Imap{{/smallcaps}}- und {{smallcaps}}Smtp{{/smallcaps}}-Server zur Verfügung, welcher in jedem gängigen E-Mail-Programm angebunden werden kann.
1.2	6
5.1	7	== Funktionalitäten ==
	8
34.2	9	; Sofortige Benachrichtigung
34.17	10	: Über die {{smallcaps}}Imap{{/smallcaps}}-Schnittstelle wird der Bneutzer sofort über neue oder geänderte Formulareingänge informiert.
34.2	11	; Konfigurierbarer Inhalt
34.17	12	: Über entsprechende Vorlagen ist der Inhalt der Benachrichtigungen sowie deren Betreff-, Absender- und Empfänger-Felder frei konfigurierbar. Da hier [[Platzhalter>>doc:Formcycle.UserInterface.Variables\|\|target="_blank"]] benutzt werden können, können neben einzelnen Werten oder Metadaten des Formulareingangs auch Links zur Wiederanzeige direkt innerhalb des Postfachs erzeugt werden.
34.2	13	; Bereitstellung von Dateien
34.17	14	: Im Formular können Dateien hochgeladen werden und während der Statusverarbeitung werden ebenfalls manchmal Dateien erzeugt. Diese Dateien werden automatisch der versendeten Nachricht angehangen. Somit stehen diese Dateien direkt im E-Mail-Programm zur Verfügung.
	15	; Abbildung der verfügbaren Postfachstruktur
	16	: Da für die Abbildung der {{formcycle/}}-Postfächer innerhalb des E-Mail-Programms entsprechende Ordner angelegt werden, hat der Benutzer auch hier nur Zugriff auf Formulareingänge, die er je nach Benutzergruppenkonfiguration haben darf. Zusätzlich wird der Ordner //Posteingang// als Sammelpostfach zur Darstellung aller ihm zugänglichen Formulareingänge benutzt.
	17	; Verwalten von Formulareingängen
	18	: Neben der eigentlichen Anzeige stehen auch Möglichkeiten zur Verwaltung von Formulareingängen zur Verfügung. So wird ein Formulareingang beim Verschieben eines Ordners in das entsprechende {{formcycle/}}-Postfach verschoben. Ferner wird der Gelesen-Status ebenso synchronisiert. Das Löschen von Formulareingängen ist bei entsprechender Berechtigung ebenso durch das Löschen der zugehörigen Nachricht oder durch das Verschieben in den Papierkorb möglich. Fehlt diese Berechtigung, taucht die Nachricht nach wenigen Sekunden wieder im E-Mail-Programm auf.
5.1	19
34.16	20	Der zur Verfügung gestellte {{smallcaps}}Smtp{{/smallcaps}}-Server ist aktuell ohne Funktionalität, sodass abgesendete Nachrichten von diesem komplett verworfen werden.
15.1	21
34.14	22	== Installation ==
1.2	23
34.17	24	Die Installation des Plugins ist über die dafür vorgesehene Verwaltungsoberfläche von Plugins durchzuführen. Hierbei muss lediglich die entsprechende {{smallcaps}}Jar{{/smallcaps}}-Datei eingespielt werden. Ferner kann die erste Installation je nach Anzahl von Formulareingängen auf Grund einer kompletten Aufbereitung der Daten für den {{smallcaps}}Imap{{/smallcaps}}-Server mehrere Minuten andauern.
1.2	25
13.1	26	{{info}}
34.17	27	Das {{smallcaps}}Imap{{/smallcaps}}-Plugin trifft bei der Anmeldung und dem Ausliefern von Nachrichten keine Unterscheidung, in welchem Mandanten es installiert ist. Es steht somit immer allen Benutzern zur Verfügung steht. Daher ist es anzuraten, das Plugin als System-Plugin zu installieren. Dies umgeht auch mögliche Probleme mit doppelt belegten Ports und ermöglicht eine zentrale Konfiguration.
13.1	28	{{/info}}
	29
34.14	30	== Konfiguration des Plugins ==
1.2	31
2.4	32	{{figure image="config_de.png"}}
34.2	33	Die Konfigurationsoberfläche des Plugins. Hier werden Einstellungen zur Verbindung mit dem Mail-Server getroffen. Weiterhin wird festgelegt, wie die versendeten E-Mails aussehen sollen.
2.4	34	{{/figure}}
1.2	35
34.2	36	Nach der Installation des Plugins stehen die in der Abbildung dargestellten Konfigurationsparameter zur Verfügung. Folgende Einstellungsmöglichkeiten gibt es dabei:
2.3	37
34.17	38	=== Konfiguration des E-Mail-Server-Services ===
1.2	39
35.1	40	{{id name="server_config"/}}
1.3	41
34.2	42	; smtp.binding.address
34.18	43	: Standardwert: //0.0.0.//. Gibt die zu verwendende {{smallcaps}}ip{{/smallcaps}}-Adresse des {{smallcaps}}Smtp{{/smallcaps}}-Servers an. Der Standardwert ist //0.0.0.0// und verwendet damit eine automatisch ermittelte {{smallcaps}}ip{{/smallcaps}}. Eine Änderung dieses Wertes ist nur nötig, falls mehrere Netzwerkadapter im Einsatz sind oder die automatische Ermittlung fehlschlägt.
34.2	44	; smtp.binding.port
34.16	45	: Standardwert: //25//. Gibt den zu verwendenten Port des {{smallcaps}}Smtp{{/smallcaps}}-Servers an. Der Standardwert sollte nur geändert werden, falls dieser Port nicht zur Verfügung steht.
34.2	46	; imap.binding.address
34.17	47	: Standardwert: //0.0.0.0//. Gibt die zu verwendende IP-Adresse des {{smallcaps}}Imap{{/smallcaps}}-Servers an. Der Standardwert ist //0.0.0.0// und verwendet damit ebenfalls eine automatisch ermittelte {{smallcaps}}ip{{/smallcaps}}. Eine Änderung dieses Wertes ist nur nötig, falls mehrere Netzwerkadapter im Einsatz sind oder die automatische Ermittlung fehlschlägt.
34.2	48	; imap.binding.port
34.17	49	: Standardwert: //143//. Gibt den zu nutzenden Port des {{smallcaps}}Imap{{/smallcaps}}-Servers an. Der Standardwert sollte nur geändert werden, falls dieser Port nicht zur Verfügung steht.
1.2	50
34.17	51	=== Konfiguration der E-Mail-Nachricht ===
1.2	52
35.1	53	{{id name="message_files_config"/}}
1.2	54
34.2	55	; mail.to.template
36.1	56	: Standard: //mail_to.txt//. Gibt den Namen der Datei an, welche in den Mandant- und Formulardateien gesucht wird und als Vorlage für den E-Mail-Empfänger benutzt werden soll.
34.2	57	; mail.from.template
34.17	58	: Standard: //mail_from.txt//. Gibt den Namen der Datei an, welche in den Mandant- und Formulardateien gesucht wird und als Vorlage für den E-Mail-Absender benutzt werden soll.
34.2	59	; mail.subject.template
34.17	60	: Standard: //mail_subject.txt//. Gibt den Namen der Datei an, welche in den Mandant- und Formulardateien gesucht wird und als Vorlage für den E-Mail-Betreff benutzt werden soll.
34.2	61	; mail.body.template
34.17	62	: Standard: //mail_body.txt//. Gibt den Namen der Datei an, welche in den Mandant- und Formulardateien gesucht wird und als Vorlage für den E-Mail-Inhalt benutzt werden soll.
1.3	63
34.14	64	== Konfiguration der E-Mail-Inhalte und Felder ==
5.2	65
36.1	66	Die Konfiguration der Inhalte und Felder der eigentlichen Nachricht benutzt einen Vorlagenmechanismus. Dieser basiert auf den vier Dateien, die unter [[Konfiguration der E-Mail-Nachricht>>\|\|anchor="message_files_config"]] eingestellt wurden. Diese werden bei der Installation des Plugins als Mandantdatei eingespielt und bei der Synchronisation der Nachrichten benutzt. Um eine formularspezifische Anzeige zu gewährleisten, ist es möglich, gleich benannte Dateien manuell als Formulardatei anzulegen und somit die Mandantdateien zu überlagern. In allen Dateien ist es möglich, [[Platzhalter>>doc:Formcycle.UserInterface.Variables\|\|target="_blank"]] zu verwenden, sodass hier abgesendete Formulardaten ausgegeben werden können. Ebenso ist es damit möglich, etwa einen Link zur Anzeige des ausgefüllten Formulars zu erzeugen.
5.2	67
34.5	68	; Inhalt
34.17	69	: Standardwert: //mail_body.txt//. Gibt den Inhalt der E-Mail-Nachricht an. Nur hier besteht die Möglichkeit, {{smallcaps}}Html{{/smallcaps}} zu hinterlegen. Beispiel:
34.4	70
	71	{{code language="html"}}
36.1	72	<html>
7.1	73	<head></head>
	74	<body>
	75	<p><a href="[%$FORM_INBOX_LINK%]">Link</a> zum Vorgang ([%$PROCESS_ID%]).</p>
	76	</body>
34.4	77	</html>
	78	{{/code}}
34.8	79
34.5	80	; Betreff
34.17	81	: Standardwert: //mail_subject.txt//. Gibt den Betreff der Nachricht an. Beispiel:
5.2	82
34.4	83	{{code language="none"}}
	84	ID: [%$RECORD_ID%] - [%$STATUS_NAME%]
	85	{{/code}}
34.8	86
34.5	87	; Empfänger
34.17	88	: Standardwert: //mail_to.txt//. Gibt den Empfänger der Nachricht an. Dieser ist nach dem Muster //Name <user@example.com>// anzugeben und hat keinerlei Auswirkungen auf den eigentlichen Empfang der Nachricht. Beispiel:
34.4	89
	90	{{code language="none"}}
	91	XIMA FORMCYCLE <no-reply@example.com>
	92	{{/code}}
34.8	93
34.5	94	; Absender
34.17	95	: Standardwert: //mail_from.txt//. Gibt den Absender der Nachricht an. Dieser ist nach dem Muster //Name <user@example.com>// anzugeben und hat keinerlei Auswirkungen auf das Absenden der Nachricht. Beispiel:
34.4	96
	97	{{code language="none"}}
	98	[%$PROJECT_NAME%] <[%$PROJECT_NAME%]@example.com>
	99	{{/code}}
	100
34.14	101	== Konfiguration des E-Mail-Programms ==
5.2	102
34.17	103	Für die Konfiguration des E-Mail-Programms sind neben der Adresse des E-Mail-Servers die unter [[Konfiguration des E-Mail-Server-Services>>\|\|anchor="server_config"]] hinerlegten Ports zu verwenden. Die kompletten zu verwendenden Anmeldedaten setzen sich demnach wie folgt zusammen:
5.2	104
34.9	105	; SMPT-Server
	106	: //<Server-Adresse>//
	107	; SMPT-Port
	108	: //siehe //[[Konfiguration Mail-Server Service>>\|\|anchor="server_config"]]
34.16	109	; {{smallcaps}}Imap{{/smallcaps}}-Server
34.9	110	: //<Server-Adresse>//
34.16	111	; {{smallcaps}}Imap{{/smallcaps}}-Port
34.9	112	: //siehe //[[Konfiguration Mail-Server Service>>\|\|anchor="server_config"]]
	113	; Benutzername
	114	: //<FORMCYCLE-Benutzer>@<FORMCYCLE-Mandantname>//
	115	; Passwort
	116	: //<FORMCYCLE-Benutzer-Passwort>//
	117	; Authentifizierung
	118	: Passwort, normal
34.17	119	; SSL-Verschlüsselung und Verbindungssicherheit
34.9	120	: keine
11.2	121
34.16	122	== Beispielskonfiguration für Thunderbird ==
18.3	123
34.12	124	1. Die Verwaltung der E-Mail-Konten über //Extras// > //Konto-Einstellungen// öffnen.{{lightbox image="thunderbird_1.png" group="g0" width="300"/}}
34.11	125	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="500"/}}
34.17	126	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="500"/}}
	127	1. In der darauf folgenden Oberfläche der Server-Konfiguration können nun die entsprechenden Daten eingetragen werden. Im Beispiel lautet der Mandantname //imap.de// und der Benutzername //user// und es werden die Standardports benutzt.{{lightbox image="thunderbird_4.png" group="g0" width="500"/}}
	128	1. Nach Fertigstellung der Konfiguration erscheinen nun die Postfächer des Benutzers als Ordner (hier //Zentrales Postfach// und //Demopostfach//) und die darin enthaltenen Nachrichten der vorhandenen Formulareingänge.{{lightbox image="thunderbird_5.png" group="g0" width="700"/}}

Wiki-Quellcode von IMAP-Plugin

Navigation