... |
... |
@@ -6,8
+6,8 @@ |
6 |
6 |
|
7 |
7 |
== Functionalities == |
8 |
8 |
|
9 |
|
-; Immediate notification |
10 |
|
-: Via the {{smallcaps}}Imap{{/smallcaps}} interface the user is immediately informed about new or changed form entries. |
|
9 |
+; mmediate notification |
|
10 |
+: Via the {{smallcaps}}}Imap{{/smallcaps}} interface the user is immediately informed about new or changed form entries. |
11 |
11 |
; Configurable content |
12 |
12 |
: The content of the notifications as well as their subject, sender and recipient fields can be freely configured using corresponding templates. Since [[placeholders>>doc:Formcycle.UserInterface.Variables||target="_blank"]] 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. |
13 |
13 |
; Provision of files |
... |
... |
@@ -40,4
+40,88 @@ |
40 |
40 |
{{id name="server_config"/}} |
41 |
41 |
|
42 |
42 |
; smtp.binding.address |
43 |
|
-: Default value: //0.0.0.//. Specifies the {{smallcaps}}ip{{/smallcaps}} 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 == The configuration of the contents and fields of the actual message uses a template mechanism. This is based on the four files set in [[e-mail message configuration>>||anchor="message_files_config"]]. These are imported as a client file when the plugin is installed and are used when synchronizing the messages.To ensure a form-specific display, it is possible to create identically named files manually as form files and thus overlay the client files. In all files it is possible to use [[placeholders>>doc:Formcycle.UserInterface.Variables||target="_blank"]] so that form data sent here can be displayed. It is also possible to create a link to display the filled out form. ; Content : Default value: //mail_body.txt//. Specifies the content of the e-mail message. Only here you have the possibility to use {{smallcaps}}Html{{/smallcaps}}. Example: {{code language="html"}} <html> <head></head> <body> <p><a href="[%$FORM_INBOX_LINK%]">Link</a> to form entry ([%$PROCESS_ID%]).</p> </body> </html> {{/code}} ; Subject : Default value: //mail_subject.txt//. Specifies the subject of the message. Example: {{code language="none"}} ID: [%$RECORD_ID%] - [%$STATUS_NAME%] {{/code}} ; Recipient : Default value: //mail_to.txt//. Specifies the recipient of the message. This is to be entered according to the pattern //name <user@example.com>// and has no effect on the actual receipt of the message. Example: {{code language="none"}} XIMA FORMCYCLE <no-reply@example.com> {{/code}} ; Sender : Default value: //mail_from.txt//. Specifies the sender of the message. This must be entered using the pattern //Name <user@example.com>// and has no effect on the sending of the message. Example: {{code language="none"}} [%$PROJECT_NAME%] <[%$PROJECT_NAME%]@example.com> {{/code}} == Configuration of the e-mail program == 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: ; {{smallcaps}}Smtp{{/smallcaps}} server : //<server address>// ; {{smallcaps}}Smtp{{/smallcaps}} port : //see//[[Configuration Mail Server Service>>||anchor="server_config"]] ; {{smallcaps}}Imap{{/smallcaps}} server : //<server address>// ; {{smallcaps}}Imap{{/smallcaps}} port : //see//[[Configuration Mail Server Service>>||anchor="server_config"]] ; Username : //<FORMCYCLE-user>@<FORMCYCLE-clientname>// ; Password : //<FORMCYCLE-user-password>// ; Authentication : Password, normal ; SSL encryption and connection security : none == Example configuration for Thunderbird == 1. Open the e-mail account management via //Extras// > //Account settings//.{{lightbox image="thunderbird_1.png" group="g0" width="300"/}} 1. Via //account actions// > //add email account...// open the dialog for configuring a new account.{{lightbox image="thunderbird_2.png" group="g0" width="500"/}} 1. Initially, Thunderbird tries to determine a server automatically based on the entered email address (here //user@imap.com//). Since this is not possible here, you can cancel this by clicking the //Edit Manually// button.{{lightbox image="thunderbird_3.png" group="g0" width="500"/}} 1. The corresponding data can now be entered in the following interface of the server configuration. In the example, the client name is //imap.com// and the user name //user// and the standard ports are used.{{lightbox image="thunderbird_4.png" group="g0" width="500"/}} 1. After completing the configuration, the user's mailboxes now appear as folders (here //central mailbox// and //demo mailbox//) and contain the messages of the existing form entries.{{lightbox image="thunderbird_5.png" group="g0" width="700"/}}}}} |
|
43 |
+: Default value: //0.0.0.//. Specifies the {{smallcaps}}ip{{/smallcaps}} 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. |
|
44 |
+; smtp.binding.port |
|
45 |
+: 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. |
|
46 |
+; imap.binding.address |
|
47 |
+: 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. |
|
48 |
+: 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. |
|
49 |
+ |
|
50 |
+=== Configuration of the e-mail message === |
|
51 |
+ |
|
52 |
+{{id name="message_files_config"/}} |
|
53 |
+ |
|
54 |
+; mail.to.template |
|
55 |
+: 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. |
|
56 |
+; mail.from.template |
|
57 |
+: 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. |
|
58 |
+; mail.subject.template |
|
59 |
+: 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. |
|
60 |
+; mail.body.template |
|
61 |
+: 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. |
|
62 |
+ |
|
63 |
+== Configuration of e-mail contents and fields == |
|
64 |
+ |
|
65 |
+The configuration of the contents and fields of the actual message uses a template mechanism. This is based on the four files set in [[e-mail message configuration>>||anchor="message_files_config"]]. These are imported as a client file when the plugin is installed and are used when synchronizing the messages.To ensure a form-specific display, it is possible to create identically named files manually as form files and thus overlay the client files. In all files it is possible to use [[placeholders>>doc:Formcycle.UserInterface.Variables||target="_blank"]] so that form data sent here can be displayed. It is also possible to create a link to display the filled out form. |
|
66 |
+ |
|
67 |
+; Content |
|
68 |
+: Default value: //mail_body.txt//. Specifies the content of the e-mail message. Only here you have the possibility to use {{smallcaps}}Html{{/smallcaps}}. Example: |
|
69 |
+ |
|
70 |
+{{code language="html"}} |
|
71 |
+ <html> |
|
72 |
+ <head></head> |
|
73 |
+ <body> |
|
74 |
+ <p><a href="[%$FORM_INBOX_LINK%]">Link</a> to form entry ([%$PROCESS_ID%]).</p> |
|
75 |
+ </body> |
|
76 |
+</html> |
|
77 |
+{{/code}} |
|
78 |
+ |
|
79 |
+; Subject |
|
80 |
+: Default value: //mail_subject.txt//. Specifies the subject of the message. Example: |
|
81 |
+ |
|
82 |
+{{code language="none"}} |
|
83 |
+ ID: [%$RECORD_ID%] - [%$STATUS_NAME%] |
|
84 |
+{{/code}} |
|
85 |
+ |
|
86 |
+; Recipient |
|
87 |
+: Default value: //mail_to.txt//. Specifies the recipient of the message. This is to be entered according to the pattern //name <user@example.com>// and has no effect on the actual receipt of the message. Example: |
|
88 |
+ |
|
89 |
+{{code language="none"}} |
|
90 |
+ XIMA FORMCYCLE <no-reply@example.com> |
|
91 |
+{{/code}} |
|
92 |
+ |
|
93 |
+; Sender |
|
94 |
+: Default value: //mail_from.txt//. Specifies the sender of the message. This must be entered using the pattern //Name <user@example.com>// and has no effect on the sending of the message. Example: |
|
95 |
+ |
|
96 |
+{{code language="none"}} |
|
97 |
+ [%$PROJECT_NAME%] <[%$PROJECT_NAME%]@example.com> |
|
98 |
+{{/code}} |
|
99 |
+ |
|
100 |
+== Configuration of the e-mail program == |
|
101 |
+ |
|
102 |
+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: |
|
103 |
+ |
|
104 |
+; {{smallcaps}}Smtp{{/smallcaps}} server |
|
105 |
+: //<server address>// |
|
106 |
+; {{smallcaps}}Smtp{{/smallcaps}} port |
|
107 |
+: //see//[[Configuration Mail Server Service>>||anchor="server_config"]] |
|
108 |
+; {{smallcaps}}Imap{{/smallcaps}} server |
|
109 |
+: //<server address>// |
|
110 |
+; {{smallcaps}}Imap{{/smallcaps}} port |
|
111 |
+: //see//[[Configuration Mail Server Service>>||anchor="server_config"]] |
|
112 |
+; Username |
|
113 |
+: //<FORMCYCLE-user>@<FORMCYCLE-clientname>// |
|
114 |
+; Password |
|
115 |
+: //<FORMCYCLE-user-password>// |
|
116 |
+; Authentication |
|
117 |
+: Password, normal |
|
118 |
+; SSL encryption and connection security |
|
119 |
+: none |
|
120 |
+ |
|
121 |
+== Example configuration for Thunderbird == |
|
122 |
+ |
|
123 |
+1. Open the e-mail account management via //Extras// > //Account settings//.{{lightbox image="thunderbird_1.png" group="g0" width="300"/}} |
|
124 |
+1. Via //account actions// > //add email account...// open the dialog for configuring a new account.{{lightbox image="thunderbird_2.png" group="g0" width="500"/}} |
|
125 |
+1. Initially, Thunderbird tries to determine a server automatically based on the entered email address (here //user@imap.com//). Since this is not possible here, you can cancel this by clicking the //Edit Manually// button.{{lightbox image="thunderbird_3.png" group="g0" width="500"/}} |
|
126 |
+1. The corresponding data can now be entered in the following interface of the server configuration. In the example, the client name is //imap.com// and the user name //user// and the standard ports are used.{{lightbox image="thunderbird_4.png" group="g0" width="500"/}} |
|
127 |
+1. After completing the configuration, the user's mailboxes now appear as folders (here //central mailbox// and //demo mailbox//) and contain the messages of the existing form entries.{{lightbox image="thunderbird_5.png" group="g0" width="700"/}} |