Wiki source code of E-Mail

Show last authors
1 {{figure image="email_en.png" clear="h1"}}
2 Configuration interface for actions of type //email//.
3 {{/figure}}
4
5 Actions of type //email// allow to send emails with or without attachments to one or more recipients.
6
7 == Parameters ==
8
9 === Email details ===
10
11 ; Email to
12 : Specifies the email recipient. Multiple recipients are separated by a comma. The use of [[variables>>Formcycle.UserInterface.Variables]] is possible.
13 ; Email from
14 : Specification of the sender of the email. The use of [[variables>>Formcycle.UserInterface.Variables]] is possible.
15 ; Sender name
16 : Specification of the name of the sender of the email. The use of [[variables>>Formcycle.UserInterface.Variables]] is possible.
17
18 === Advanced settings ===
19
20 {{figure image="email_extended_en.png" clear="h1"}}
21 Advanced settings of the //email// action.
22 {{/figure}}
23
24 ; Send an individual email to each recipient and hide email addresses of other recipients.
25 : If checked, each email will be sent separately. Otherwise all emails are sent at once.
26 ; Add internal FORMCYCLE users as recipients.
27 : [[{{formcycle/}}-user>>doc:Formcycle.UserInterface.UserSettings.User]] who should receive an email.
28 ; Add internal FORMCYCLE group as recipient.
29 : [[User>>doc:Formcycle.UserInterface.UserSettings.User]] of the specified [[user groups>>doc:Formcycle.UserInterface.UserSettings.UserGroups]] will receive an email. Note: All LDAP users of a [[LDAP Group>>doc:Formcycle.UserInterface.UserSettings.LDAPGroups]] assigned to the [[user group>>doc:Formcycle.UserInterface.UserSettings.UserGroups]] will receive an email.
30 ; Copy to (CC)
31 : Email addresses to which a copy should be sent. The use of [[variables>>Formcycle.UserInterface.Variables]] is possible.
32 ; Blind Copy To (BCC)
33 : Email addresses to which a blind copy is to be sent. The use of [[variables>>Formcycle.UserInterface.Variables]] is possible.
34 ; Reply To (Reply-To)
35 : Email addresses to which a reply is to be sent. The use of [[variables>>Formcycle.UserInterface.Variables]] is possible.
36 ; Email format
37 : Select in which format the email should be sent. You can choose between HTML (default), Plain Text or HTML and Plain Text. The contents of the respective formats can be defined separately under **Content**.
38
39 === Contents of the email ===
40
41 ; Subject
42 : Specification of the email subject. The use of [[variables>>Formcycle.UserInterface.Variables]] is possible.
43 ; HTML
44 : Content of the email. The use of [[variables>>Formcycle.UserInterface.Variables]] is possible.
45 ; Files
46 : Files that should be in the attachment of the email. See [[actions>>doc:Formcycle.Designer.Workflow.Actions.WebHome]] for a list of supported URL protocols.
47
48 == Action variables ==
49
50 Actions of type //Email// provide [[Action variables>>Formcycle.UserInterface.Variables||anchor="HActionvariables"]] which can be used in subsequent actions.
51
52 === Standard action variables ===
53
54 ; [%$<action name>.SUCCESS%]
55 : Return whether action was successfully executed. Returns Boolean (true/false).
56 ; [%$<action name>.RESULT%]
57 : Return all results provided by the action in structured form.
58
59 ; [%$<action name>.ERROR_CODE%]
60 : The error code thrown in case of an error in the action. Empty if no error occurred.
61 ; [%$<action name>.ERROR_MESSAGE%]
62 : The thrown error message in the action's error case. Empty if no error occurred.
63
64 === Action specific action variables ===
65
66 ; [%$<actionname>.ERROR.message%]
67 : Error code returned if the email was not sent or an error occurs when determining an included LDAP user/group.
68
69 == Repeated elements support ==
70
71 The //Email to//, //Subject//, and //Content// fields support [[repeated elements>>Formcycle.Designer.Form.ElementProperties.BaseProperties]].
72
73 * If a repeated field is selected in the //Email To// field using [[variables selection>>Formcycle.UserInterface.Variables]], the email will be sent to all passed email addresses.
74 * If in the field //subject// or //content// a repeated field is selected via the [[variables selection>>Formcycle.UserInterface.Variables]], the passed values are displayed comma separated.