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/marketplace/platform-supported-content/modules/email-connector.md
+34-34Lines changed: 34 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,13 @@ aliases:
10
10
11
11
## Introduction
12
12
13
-
The [Email Connector](https://marketplace.mendix.com/link/component/120739) allows you to send and receive emails using your own email server. It supports features like template-based emails, digital signatures, and encrypted email sending.
13
+
The [Email Connector](https://marketplace.mendix.com/link/component/120739) allows you to **Send** and **Receive** emails using your own email server. It supports features like template-based emails, digital signatures, and encrypted email sending.
14
14
15
15
The Email Connector is a toolkit providing reusable components (snippets, microflows, entities, and Java actions) for building custom email functionality. This documentation covers the setup and configuration of these components in your Mendix application.
16
16
17
17
{{% alert color="info" %}}
18
18
19
-
This document describes versions 6.3.1 and above of the Email Connector module.
19
+
This document describes versions **6.3.1** and above of the Email Connector module.
20
20
{{% /alert %}}
21
21
22
22
### Key Features
@@ -58,7 +58,7 @@ Missing a step, or changing the order can lead to errors.
58
58
59
59
1. Download and configure the latest version of the [Mx Model Reflection](/appstore/modules/model-reflection/) module.
60
60
2. Download and configure the latest version of the [Community Commons](/appstore/modules/community-commons-function-library/) module.
61
-
3. Download and configure the latest version of the [Encryption](/appstore/modules/encryption/) module. The `EncryptionKey` constant must be set up in your application settings.
61
+
3. Download and configure the latest version of the [Encryption](/appstore/modules/encryption/) module. The `EncryptionKey` constant must be set up in your application settings. Refer [EncryptionKey Constant](/appstore/modules/encryption/#encryptionkey-constant)
62
62
4. Uninstall any previously installed email modules, such as [IMAP/POP3](https://marketplace.mendix.com/link/component/1042/) and [Email Module with Templates](https://marketplace.mendix.com/link/component/259/).
63
63
5. Remove any JAR files still present in the userlib folder from older email modules which are now unused (for example, `javax.mail-1.6.2.jar`, `activation-1.1.jar`, and `commons-email.jar`).
64
64
6.[Clean the deployment directory](/refguide/app-menu/#clean-deployment-directory).
@@ -93,7 +93,7 @@ If you already have these widgets in your app, and they are not up to date, you
93
93
94
94
### Configuring Roles
95
95
96
-
The module includes a default **EmailConnectorAdmin**module role with pre-configured access rights for common use cases. Review and verify that the access rights align with your specific requirements and security policies before assigning this module role to user roles in [App Security](/refguide/app-security/).
96
+
The module includes a default **EmailConnectorAdmin** role with pre-configured access rights for common use cases. Review and verify that the access rights align with your specific requirements and security policies before assigning this module role to user roles in [App Security](/refguide/app-security/). Also configure required module roles of prerequisite modules as needed.
97
97
98
98
### Building Email Functionality {#building-email-functionality}
99
99
@@ -105,7 +105,7 @@ The domain model in Mendix is a data model that describes the information in you
105
105
106
106
##### EmailAccount {#email-account}
107
107
108
-
EmailAccount is the entity which manages email account configurations, authentication methods, and security settings for both incoming and outgoing email operations.
108
+
**EmailAccount** is the entity which manages email account configurations, authentication methods, and security settings for both incoming and outgoing email operations.
The IncomingEmailConfiguration entity manages email retrieval settings, processing options, and server connection parameters for incoming messages.
129
+
The **IncomingEmailConfiguration** entity manages email retrieval settings, processing options, and server connection parameters for incoming messages.
@@ -158,7 +158,7 @@ Configuration entity defining Send Protocol settings, security protocols, and re
158
158
159
159
##### EmailMessage {#email-message}
160
160
161
-
Entity representing individual email messages with complete metadata, content, and processing status tracking. This entity is used for both sending and receiving emails.
161
+
The **EmailMessage** entity represent individual email messages with complete metadata, content, and processing status tracking. This entity is used for both sending and receiving emails.
@@ -209,7 +209,7 @@ Entity enabling reusable email designs with dynamic content placeholders for con
209
209
210
210
##### Attachment {#attachment}
211
211
212
-
Specialized file attachment entity extending Mendix **System.FileDocument** to provide comprehensive file handling capabilities for email communications.
212
+
Specialized file **Attachment** entity extending Mendix **System.FileDocument** to provide comprehensive file handling capabilities for email communications.
213
213
214
214
#### Snippets {#snippets}
215
215
@@ -282,8 +282,8 @@ Configuration supports two authentication methods:
282
282
283
283
You can set these up using the **Enable Microsoft Entra ID Authentication**:
284
284
285
-
* Select **Yes** to enable OAuth 2.0 authentication through Microsoft Entra ID – you will need to fill in the details described under [Basic Authentication](#send-basic-authentication)
286
-
* Select **No** (*default*) to use basic authentication with username and password – you will need to fill in the details described under [OAuth Authentication](#send-oauth-authentication)
285
+
* Select **Yes** to enable OAuth 2.0 authentication through Microsoft Entra ID – you will need to fill in the details described under [OAuth Authentication](#send-oauth-authentication)
286
+
* Select **No** (*default*) to use basic authentication with username and password – you will need to fill in the details described under [Basic Authentication](#send-basic-authentication)
@@ -318,7 +318,7 @@ You can configure your account to authenticate with Microsoft Entra ID OAuth 2.0
318
318
To manage configurations:
319
319
320
320
* Select the **Configure OAuth** tab to add, delete, and edit OAuth configurations
321
-
* If no email accounts are configured, you can create a new OAuth configuration
321
+
* If no OAuth configuration are configured, you can create a new configuration
322
322
323
323
For detailed steps and implementation guidance, see the [Configure OAuth](#oauth-config-details) section below.
324
324
@@ -358,24 +358,24 @@ You can view and change the following settings by clicking **View Settings** as
358
358
359
359
#### Error Logs Tab
360
360
361
-
This tab displays a list of any log entries related to errors in the Email Connector module.
361
+
This tab displays a list of any log entries related to errors occurred during send email operation in the Email Connector module.
362
362
363
363
### Sending Email via Microflow
364
364
365
365
Use the **SUB_SendEmail** microflow for standardized, Mendix-compliant email delivery with proper error handling and configuration management. For this you will need to create your message as an object of type `Email_Connector.EmailMessage` and associate it with the `Email_Connector.EmailAccount` object containing the send mail account.
366
366
367
-
When sending an email, the To, From and Content fields are mandatory. When sending emails using templates, refer to the [Templates](#email-templates) section below.
367
+
When sending an email, the **To**, **From** and **Content** fields are mandatory. When sending emails using templates, refer to the [Templates](#email-templates) section below.
368
368
369
369
### Sending Email via Java Action
370
370
371
-
When modeling your app in Studio Pro, use the SendEmail Java action to send emails. The input parameters are as follows:
371
+
When modeling your app in Studio Pro, use the **SendEmail** Java action to send emails. The input parameters are as follows:
372
372
373
373
***EmailAccount** – The entity containing the configuration details for the outgoing email account
374
374
***EmailMessage** – The entity instance containing the content and details of the email to be sent
375
375
376
376
The return type is a Boolean value. This Java action uses the provided details to connect to the email server and send an email. It returns True if successful and displays the error object and cause if it fails.
377
377
378
-
When sending an email, the To, From and Content fields are mandatory. In To, CC, and BCC, you can optionally specify multiple email addresses, each separated by a semicolon (;).
378
+
When sending an email, the **To**, **From** and **Content** fields are mandatory. In **To**,**CC**, and **BCC**, you can optionally specify multiple email addresses, each separated by a semicolon (;).
379
379
380
380
## Receive Email {#receive-email}
381
381
@@ -395,8 +395,8 @@ Configuration supports two authentication methods:
395
395
396
396
You can set these up using the **Enable Microsoft Entra ID Authentication**:
397
397
398
-
* Select **Yes** to enable OAuth 2.0 authentication through Microsoft Entra ID – you will need to fill in the details described under [Basic Authentication](#receive-basic-authentication)
399
-
* Select **No** (*default*) to use basic authentication with username and password – you will need to fill in the details described under [OAuth Authentication](#receive-oauth-authentication)
398
+
* Select **Yes** to enable OAuth 2.0 authentication through Microsoft Entra ID – you will need to fill in the details described under [OAuth Authentication](#receive-oauth-authentication)
399
+
* Select **No** (*default*) to use basic authentication with username and password – you will need to fill in the details described under [Basic Authentication](#receive-basic-authentication)
@@ -485,7 +485,7 @@ You can view and change the following settings by clicking **View Settings** as
485
485
486
486
#### Error Logs Tab
487
487
488
-
This tab displays a list of any log entries related to errors in the Email Connector module.
488
+
This tab displays a list of any log entries related to errors occurred during receive email operation in the Email Connector module.
489
489
490
490
### Receiving Email
491
491
@@ -624,7 +624,7 @@ This tab allows you to configure templates you can use to send your emails.
624
624
625
625
Use the **CreateEmailFromTemplate** Java action to generate a draft email message that can be previewed and customized. Once finalized, send it using the **Send email** action. The input parameters are as follows:
626
626
627
-
***DataObject** – Entity object from which placeholder tokens are extracted. To retrieve data from multiple objects, create a [non-persistable entity](/refguide/persistability/#non-persistable).
627
+
***DataObject** – Entity object from which placeholder tokens are extracted. To retrieve data from multiple objects, create a [non-persistable entity](/refguide/persistability/#non-persistable). This is an optional parameter; it is required only if the template contains placeholder tokens.
628
628
***EmailTemplate** – Email template used to construct and send an **EmailMessage** object.
629
629
***Queued** – When enabled (**true**), the email message is stored in the **EmailMessage** entity with a **Queued** status. This configuration enables later transmission via [scheduled events](/refguide/scheduled-events/).
0 commit comments