You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/application-logic/microflows-and-nanoflows/activities/email-activities/send-email-action.md
+97-53Lines changed: 97 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,45 +48,66 @@ The **From** address must be an address the configured email server is allowed t
48
48
49
49
### Security Method {#security-method}
50
50
51
-
The **Security method** section determines how the connection authenticates to the email server. The connection uses basic authentication. Configure the following parameters in the table by selecting a row and clicking **Edit** (or double-clicking the row). Each value is defined using a microflow expression.
| Username | String | The username used to authenticate to the email server. |
56
-
| Password | String | The password used to authenticate to the email server. |
51
+
The **Security method** section determines how the connection authenticates to the email server. The connection uses basic authentication.
57
52
58
53
{{% alert color="warning" %}}
59
54
Basic authentication (username and password) is deprecated or disabled by default on several major email providers, including Google Workspace and Microsoft 365, unless the tenant administrator has explicitly re-enabled it. To send emails through these providers, you can:
60
55
* Re-enable SMTP basic authentication for the account (where your administrator's policy allows it), or
61
56
* Use a provider that supports basic SMTP authentication.
62
57
{{% /alert %}}
63
58
59
+
#### Username
60
+
61
+
The **Username** property is the username used to authenticate to the email server.
62
+
63
+
#### Password
64
+
65
+
The **Password** property is the password used to authenticate to the email server.
66
+
64
67
{{% alert color="warning" %}}
65
68
Avoid hard-coding a password as a literal value in the microflow because it would then be stored in the app model. Instead, provide the credential through a mechanism that keeps it out of the model (for example, a constant whose value is set per environment). Never commit real credentials to version control.
66
69
{{% /alert %}}
67
70
68
71
### Connection {#connection}
69
72
70
-
The **Connection** section configures how Studio Pro reaches the email server.
| Email Protocol | String | SMTP | The protocol used to send email. This property is read-only. |
75
-
| Security Type | Enumeration | TLS | The transport security used for the connection: **None**, **SSL**, or **TLS**. |
76
-
| Check Server Identity | Boolean | No | Whether to verify the server's identity (certificate). This option is only enabled when **Security Type** is set to **SSL**. |
77
-
| Timeout (ms) | Integer | 20000 | The connection timeout (in milliseconds). |
78
-
79
-
Configure the following parameters in the table by selecting a row and clicking **Edit** (or double-clicking the row). Each value is defined using a microflow expression.
| Server Host | String | The address of the email (SMTP) server. |
84
-
| Server Port | Integer | The port of the email (SMTP) server. |
73
+
The **Connection** field configures how Studio Pro reaches the email server.
85
74
86
75
{{% alert color="info" %}}
87
76
Connection details such as the **Server Host**, **Server Port**, and the **Email ID (From)** are commonly stored as [Constants](/refguide/constants/) so they can differ per environment instead of being hard-coded in the microflow. Referencing the same constants from multiple **Send Email** activities also lets you update the server settings in one place instead of editing each activity individually.
88
77
{{% /alert %}}
89
78
79
+
#### Email Protocol
80
+
81
+
The **Email Protocol** property is the protocol used to send email. This property is read-only.
82
+
83
+
Default value: *SMTP*
84
+
85
+
#### Security Type
86
+
87
+
The **Security Type** property is the transport security used for the connection: **None**, **SSL**, or **TLS**.
88
+
89
+
Default value: *TLS*
90
+
91
+
#### Check Server Identity
92
+
93
+
The **Check Server Identity** option defines whether to verify the server's identity (certificate). This option is only enabled when **Security Type** is set to **SSL**.
94
+
95
+
Default value: *No*
96
+
97
+
#### Timeout (ms)
98
+
99
+
The connection timeout (in milliseconds).
100
+
101
+
Default value: *20000*
102
+
103
+
#### Server Host
104
+
105
+
The **Server Host** property is the address of the email (SMTP) server.
106
+
107
+
#### Server Port
108
+
109
+
The **Server Port** property is the port of the email (SMTP) server.
110
+
90
111
### Test Connection {#test-connection}
91
112
92
113
Click **Test Connection** to verify the configured connection and authentication settings are valid.
@@ -103,11 +124,17 @@ The **Message** tab configures the recipients, custom headers, message content,
103
124
104
125
Configure the recipients in the table by selecting a row and clicking **Edit** (or double-clicking the row). Each value is defined using a microflow expression.
| Subject | String | The subject line of the email. |
134
-
| Message body (Plain Text) | String | The plain-text version of the email body. |
135
-
| Message body (HTML) | String | The HTML version of the email body. |
155
+
### Message Body {#message-body}
136
156
137
-
Each of these fields can be defined either as a plain text or as a string template. A string template is fixed text with `{1}`, `{2}`, … placeholders whose values are of type microflow expression and come from parameter expressions evaluated against the surrounding microflow. For example:
157
+
The following fields can be defined either as plain text or as a string template. A string template is fixed text with `{1}`, `{2}`, … placeholders whose values are of type microflow expression and come from parameter expressions evaluated against the surrounding microflow. For example:
138
158
139
159
```text
140
160
Subject: "Order {1} confirmed"
@@ -145,17 +165,32 @@ Body: "Hi {1}, your order ships on {2}."
* The subject, the plain-text body, and the HTML body each have their own template. For a given field, use either the plain value or its template consistently.
171
+
* Keep placeholder numbering contiguous (`{1}`, `{2}`, …), and make sure every placeholder has a corresponding parameter expression.
172
+
* Only reference variables that exist in the microflow's scope at the activity's position. If the data is not yet available, retrieve it earlier in the flow.
173
+
* The HTML and plain-text bodies are independent. Populate only the one (or ones) you need.
174
+
{{% /alert %}}
175
+
176
+
#### Subject
177
+
178
+
The **Subject** property is the subject line of the email.
149
179
150
-
- The subject, the plain-text body, and the HTML body each have their own template. For a given field, use either the plain value or its template consistently.
151
-
- Keep placeholder numbering contiguous (`{1}`, `{2}`, …), and make sure every placeholder has a corresponding parameter expression.
152
-
- Only reference variables that exist in the microflow's scope at the activity's position. If the data is not yet available, retrieve it earlier in the flow.
153
-
- The HTML and plain-text bodies are independent. Populate only the one (or ones) you need.
180
+
#### Message Body (Plain Text)
181
+
182
+
The **Message Body (Plain Text)** property is the plain-text version of the email body.
183
+
184
+
#### Message Body (HTML)
185
+
186
+
The **Message Body (HTML)** property is the HTML version of the email body.
154
187
155
188
### Attachment {#attachment}
156
189
157
190
In the **Attachment** section, select a microflow variable to attach to the email.
158
191
192
+
#### Variable
193
+
159
194
Only variables of type System.FileDocument, List of System.FileDocument, or their specializations can be attached. The variable must exist in the microflow's scope before the **Send Email** activity (the file must already have been retrieved or created earlier in the flow).
160
195
161
196
{{% alert color="info" %}}
@@ -164,22 +199,31 @@ The **Send Email** activity does not impose its own attachment size limit. The m
164
199
165
200
## Test Email Tab {#test-email}
166
201
167
-
The **Test Email** tab lets you send a test email to verify your configuration from Studio Pro without triggering the microflow.
202
+
The **Test Email** tab allows you to send a test email to verify your configuration from Studio Pro without triggering the microflow.
168
203
169
204
### Test Email Details {#test-email-details}
170
205
171
206
#### Use Template for Test Email
172
207
173
-
When selected, the subject and body fields use the string templates configured on the [Message](#message) tab. Because template placeholders reference microflow variables that are not available while testing, click the Edit icon next to each field to provide test values for the template parameters.
208
+
When **Use Template for Test Email** is selected, the subject and body fields use the string templates configured on the [Message](#message) tab. Because template placeholders reference microflow variables that are not available while testing, click the Edit icon next to each field to provide test values for the template parameters.
209
+
210
+
When not selected, you can enter the subject and body directly.
211
+
212
+
#### To
213
+
214
+
The **To** property is the recipient of the test email.
215
+
216
+
#### Subject
217
+
218
+
The **Subject** property is the subject line of the test email.
219
+
220
+
#### Message Body (Plain Text)
221
+
222
+
The **Message Body (Plain Text)** property is the plain-text version of the test email body.
174
223
175
-
When not selected, you can enter the subject and body directly:
0 commit comments