Plugin-Download (requires login)

The Imap plug-in for Xima® Formcycle makes it possible to display data from incoming forms within an e-mail program, to manage them and to be immediately informed of new incoming data. For this purpose, this plugin provides an Imapand Smtp server that can be connected to by any common e-mail program.

Functionalities

mmediate notification

Via the }Imap interface the user is immediately informed about new or changed form entries.

Configurable content

The content of the notifications as well as their subject, sender and recipient fields can be freely configured using corresponding templates. Since placeholders can be used here, links for re-display directly within the mailbox can be created in addition to individual values or metadata of the form input.

Provision of files

Files can be uploaded in the form and during status processing, files are also sometimes generated. These files are automatically attached to the sent message. So these files are available directly in the e-mail program.

Mapping of the available mailbox structure

Since corresponding folders are created within the e-mail program to map the Xima® Formcycle mailboxes, the user only has access to form inboxes that he is allowed to have depending on the user group configuration. In addition, the folder Inbox is used as a collective mailbox to display all form entries accessible to the user.

Manage form entries

In addition to the actual display, there are also options for managing form entries. For example, a form entry is moved to the corresponding Xima® Formcycle mailbox when it is moved to another folder. Furthermore, the read status is also synchronized. The deletion of form entries is also possible by deleting the corresponding message or by moving it to the trash, if the user has the appropriate authorization. If this authorization is missing, the message reappears in the e-mail program after a few seconds.

The provided Smtp{ server is currently without functionality, so sent messages are completely discarded by it.

Installation

The installation of the plugin is to be accomplished over the intended administration surface of plugins. All you have to do is import the corresponding Jar file. Furthermore, the first installation can take several minutes, depending on the number of form entries, due to a complete preparation of the data for the Imap server.

Configuration of the Plugins

After installing the plugin, the configuration parameters shown in the figure are available. The following configuration options are possible:

Configuration of the e-mail server service

smtp.binding.address

Default value: 0.0.0.. Specifies the ip address of the smallcaps}}Smtp{{{/smallcaps}} server to use. The default value is //0.0.0.0//, which uses an automatically generated {{smallcaps}}ip{{/smallcaps}}. Changing this value is only necessary if multiple network adapters are in use or the automatic detection fails. ; smtp.binding.port : Default value: //25//. Specifies the port of the {{smallcaps}}Smtp{{/smallcaps}} server to use. The default value should only be changed if this port is not available. ; imap.binding.address : Default value: //0.0.0.0//. Specifies the IP address to use for the {{smallcaps}}Imap{{/smallcaps}} server. The default value is //0.0.0.0//, which also uses an automatically generated {{smallcaps}}ip{{/smallcaps}}. Changing this value is only necessary if multiple network adapters are in use or the automatic detection fails. : Default value: //143//. Specifies the port of the {{smallcaps}}Imap{{{/smallcaps}} server to use. The default value should only be changed if this port is not available. === Configuration of the e-mail message === {{id name="message_files_config"/}} ; mail.to.template : Default value: //mail_to.txt//. Specifies the name of the file to be searched for in the client and form files and to be used as a template for the e-mail recipient. ; mail.from.template : Default value: //mail_from.txt//. Specifies the name of the file to be searched for in the client and form files and to be used as a template for the e-mail sender. ; mail.subject.template : Default value: //mail_subject.txt//. Specifies the name of the file to be searched for in the client and form files and to be used as a template for the e-mail subject. ; mail.body.template : Default value: //mail_body.txt//. Specifies the name of the file to be searched for in the client and form files and to be used as a template for the e-mail content. == Configuration of e-mail contents and fields == 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 Formulardateien 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. ; Inhalt : Standardwert: //mail_body.txt//. Gibt den Inhalt der E-Mail-Nachricht an. Nur hier besteht die Möglichkeit, {{smallcaps}}Html{{/smallcaps}} zu hinterlegen. Beispiel: {{code language="html"}} <html> <head></head> <body> <p><a href="[%$FORM_INBOX_LINK%]">Link</a> zum Vorgang ([%$PROCESS_ID%]).</p> </body> </html> {{/code}} ; Betreff : Standardwert: //mail_subject.txt//. Gibt den Betreff der Nachricht an. Beispiel: {{code language="none"}} ID: [%$RECORD_ID%] - [%$STATUS_NAME%] {{/code}} ; Empfänger : 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: {{code language="none"}} XIMA FORMCYCLE <no-reply@example.com> {{/code}} ; Absender : 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: {{code language="none"}} [%$PROJECT_NAME%] <[%$PROJECT_NAME%]@example.com> {{/code}} == Konfiguration des E-Mail-Programms == 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: ; SMPT-Server : //<Server-Adresse>// ; SMPT-Port : //siehe //[[Konfiguration Mail-Server Service>>||anchor="server_config"]] ; {{smallcaps}}Imap{{/smallcaps}}-Server : //<Server-Adresse>// ; {{smallcaps}}Imap{{/smallcaps}}-Port : //siehe //[[Konfiguration Mail-Server Service>>||anchor="server_config"]] ; Benutzername : //<FORMCYCLE-Benutzer>@<FORMCYCLE-Mandantname>// ; Passwort : //<FORMCYCLE-Benutzer-Passwort>// ; Authentifizierung : Passwort, normal ; SSL-Verschlüsselung und Verbindungssicherheit : keine == Beispielskonfiguration für Thunderbird == 1. Die Verwaltung der E-Mail-Konten über //Extras// > //Konto-Einstellungen// öffnen.{{lightbox image="thunderbird_1.png" group="g0" width="300"/}} 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"/}} 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"/}} 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"/}} 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"/}}