Skip to content

Commit abb2656

Browse files
MarkvanMentsMarkvanMents
committed
Proofread
1 parent 198d25c commit abb2656

1 file changed

Lines changed: 28 additions & 30 deletions

File tree

‎content/en/docs/marketplace/platform-supported-content/modules/email-connector.md‎

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,19 @@ Missing a step, or changing the order can lead to errors.
5858

5959
1. Download and configure the latest version of the [Mx Model Reflection](/appstore/modules/model-reflection/) module.
6060
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.
6262
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-
5. Remove any JAR files still be 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`).
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`).
6464
6. [Clean the deployment directory](/refguide/app-menu/#clean-deployment-directory).
6565
7. Add the **Email_Connector_Overview** page located in the **USE_ME > Pages** to your app navigation.
6666

67+
The **Email_Connector_Overview** page launches the user interface which allows you to configure email accounts. This overview page provides access to configure and manage the following configurations and settings:
68+
69+
* [**Send Email**](#send-email)
70+
* [**Receive Email**](#receive-email)
71+
* [**Templates**](#email-templates)
72+
* [**Configure OAuth**](#oauth-config-details)
73+
6774
### Migrating from Another Module
6875

6976
When migrating to the Email Connector from a different email module, it is recommended to test your configuration in a separate app before applying it to your main project.
@@ -84,8 +91,6 @@ If you already have these widgets in your app, and they are not up to date, you
8491

8592
## Setting up the Email Connector in Studio Pro {#setup}
8693

87-
88-
8994
### Configuring Roles
9095

9196
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/).
@@ -100,7 +105,7 @@ The domain model in Mendix is a data model that describes the information in you
100105

101106
##### EmailAccount {#email-account}
102107

103-
Entity managing 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.
104109

105110
| Attribute | Description |
106111
|------------------------------|----------------------------------------------------------------|
@@ -121,7 +126,7 @@ Entity managing email account configurations, authentication methods, and securi
121126

122127
##### IncomingEmailConfiguration {#incoming-email-configuration}
123128

124-
Configuration entity managing 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.
125130

126131
| Attribute | Description |
127132
|--------------------|---------------------------------------------------|
@@ -131,9 +136,9 @@ Configuration entity managing email retrieval settings, processing options, and
131136
| BatchSize | Number of emails processed per batch operation |
132137
| Handling | Post-retrieval action (keep, move, delete emails) |
133138
| MoveFolder | Destination folder for processed emails |
134-
| ProcessInlineImage | Processes embedded images in email content |
135-
| FetchStrategy | Email retrieval method (Latest, Oldest |
136-
| NotifyOnNewEmails | Triggers notifications for incoming emails |
139+
| ProcessInlineImage | Whether to process embedded images in email content |
140+
| FetchStrategy | Email retrieval method (Latest, Oldest) |
141+
| NotifyOnNewEmails | Whether to trigger notifications for incoming emails |
137142
| ServerHost | Incoming mail server hostname or IP address |
138143
| ServerPort | Incoming mail server port |
139144

@@ -208,7 +213,7 @@ Specialized file attachment entity extending Mendix **System.FileDocument** to p
208213

209214
#### Snippets {#snippets}
210215

211-
Snippets allow you to make interface changes in one place that automatically apply everywhere the snippet is used, reducing maintenance effort and ensuring consistency. You can find the following snippets in the **USE_ME > Snippets** of the Email Connector module.
216+
Snippets allow you to make interface changes in one place that automatically apply on every page where the snippet is used, reducing maintenance effort and ensuring consistency. You can find the following snippets in the **USE_ME > Snippets** of the Email Connector module.
212217

213218
##### Authentication & Configuration
214219

@@ -259,14 +264,6 @@ The Email Connector module contains a number of Java actions which you can use t
259264
* **GetFolderNames** - Retrieve available email folders from the server
260265
* **GetBaseDNList** - Get directory service base distinguished names for LDAP integration
261266

262-
263-
The **Email_Connector_Overview** page which you added to the navigation launches the user interface which allows you to configure email accounts. This overview page provides access to configure and manage the following configurations and settings:
264-
265-
* **Send Email**
266-
* **Receive Email**
267-
* **Templates**
268-
* **Configure OAuth**
269-
270267
## Send Email {#send-email}
271268

272269
1. Deploy your application to set up your **Send Email** accounts through the Email Connector user interface.
@@ -367,7 +364,7 @@ This tab displays a list of any log entries related to errors in the Email Conne
367364

368365
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.
369366

370-
When sending emails using templates, refer to the [Email Templates](#email-templates) section below.
367+
When sending emails using templates, refer to the [Templates](#email-templates) section below.
371368

372369
### Sending Email via Java Action
373370

@@ -448,7 +445,7 @@ To manage configurations:
448445

449446
For detailed steps and implementation guidance, see the [Configure OAuth](#oauth-config-details) section below.
450447

451-
### Additional Account Settings
448+
### Additional Account Settings{#retrieve-additional}
452449

453450
You can view and change the following settings by clicking **View Settings** as the **Action** of an existing account.
454451

@@ -488,27 +485,26 @@ You can view and change the following settings by clicking **View Settings** as
488485
* Enables security filtering to prevent cross-site scripting attacks
489486
* Removes potentially malicious scripts and content from email messages
490487

488+
#### Error Logs Tab
489+
490+
This tab displays a list of any log entries related to errors in the Email Connector module.
491+
491492
### Receiving Email
492493

493-
To receive emails in your Mendix app, use the **RetrieveEmailMessages** Java action. This action fetches emails asynchronously in batches using multiple threads and returns a list of **EmailMessage** objects. Email retrieval continues until the criteria specified in the email account settings are met (for example, fetching the latest 1,000 emails). For details, see Additional Account Settings.
494+
To receive emails in your Mendix app, use the **RetrieveEmailMessages** Java action. This action fetches emails asynchronously in batches using multiple threads and returns a list of **EmailMessage** objects. Email retrieval continues until the criteria specified in the email account settings are met (for example, fetching the latest 1,000 emails). For details, see [Additional Account Settings](#retrieve-additional).
494495

495496
The input parameters for receiving email are the following:
496497

497-
* **EmailAccount** – This is an email account consisting of the incoming email configuration.
498+
* **EmailAccount** – This is an email account containing the incoming email configuration.
498499

499-
* **onEmailFetchMicroflow**** – This is a microflow that is triggered when List of **EmailMessage** is fetched from the email server, as per the batch size specified in the email account settings. You can process the list according to your needs.
500+
* **onEmailFetchMicroflow** – This is a microflow that is triggered when a list of **EmailMessage** is fetched from the email server, as per the batch size specified in the email account settings. You can process the list according to your needs.
500501

501502
{{% alert color="warning" %}}If duplicating the **onEmailFetchMicroflow** microflow, do not change the input parameter name or data type. To prevent errors, make sure you have **List of Email_Connector.EmailMessage** as a parameter to this microflow.{{% /alert %}}
502503

503504
* **onFetchCompleteMicroflow** – This is a microflow that is triggered when the email fetch action is successfully completed.
504505

505506
* **onFetchErrorMicroflow** – This is a microflow that is triggered if there are errors while fetching from the email server.
506507

507-
#### Error Logs Tab
508-
509-
This tab displays a list of any log entries related to errors in the Email Connector module.
510-
511-
512508
## Configure OAuth {#oauth-config-details}
513509

514510
1. Deploy your application to set up your **OAuth Configuration** through the Email Connector user interface.
@@ -615,11 +611,13 @@ On the [Microsoft Entra ID](https://portal.azure.com/), ensure you have the foll
615611

616612
Admin status is given on the added API permissions. The tenant admin must register the Microsoft Entra ID application's service principal in Exchange via Exchange Online PowerShell, as described in [Register service principals in Exchange](https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth#register-service-principals-in-exchange).
617613

618-
## Email Templates {#email-templates}
614+
## Templates {#email-templates}
615+
616+
This tab allows you to configure templates you can use to send your emails.
619617

620618
1. Deploy your application to set up your **Email Templates** through the Email Connector user interface.
621619
2. Navigate to the **Email Connector Overview** page.
622-
3. Select the **Email Templates** tab.
620+
3. Select the **Templates** tab.
623621
4. Click **Add New Template** or edit an existing one using the **Action**.
624622

625623
{{% alert color="info" %}} The [Mx Model Reflection](/appstore/modules/model-reflection/) must be installed and properly configured in your app prior to creating placeholder tokens and before exporting/importing email templates containing placeholder tokens.{{% /alert %}}

0 commit comments

Comments
 (0)