Skip to content

Commit dcbd015

Browse files
Addressed review comment
1 parent 9a9666a commit dcbd015

1 file changed

Lines changed: 34 additions & 34 deletions

File tree

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

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ aliases:
1010

1111
## Introduction
1212

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.
1414

1515
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.
1616

1717
{{% alert color="info" %}}
1818

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.
2020
{{% /alert %}}
2121

2222
### Key Features
@@ -58,7 +58,7 @@ 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. Refer [EncryptionKey Constant](/appstore/modules/encryption/#encryptionkey-constant)
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/).
6363
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).
@@ -93,7 +93,7 @@ If you already have these widgets in your app, and they are not up to date, you
9393

9494
### Configuring Roles
9595

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.
9797

9898
### Building Email Functionality {#building-email-functionality}
9999

@@ -105,7 +105,7 @@ The domain model in Mendix is a data model that describes the information in you
105105

106106
##### EmailAccount {#email-account}
107107

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.
109109

110110
| Attribute | Description |
111111
|------------------------------|----------------------------------------------------------------|
@@ -126,26 +126,26 @@ EmailAccount is the entity which manages email account configurations, authentic
126126

127127
##### IncomingEmailConfiguration {#incoming-email-configuration}
128128

129-
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.
130130

131-
| Attribute | Description |
132-
|--------------------|---------------------------------------------------|
133-
| IncomingProtocol | Email retrieval protocol (IMAP/POP3) |
134-
| Folder | Server folder for email retrieval |
135-
| UseBatchImport | Enables batch processing for large email volumes |
136-
| BatchSize | Number of emails processed per batch operation |
137-
| Handling | Post-retrieval action (keep, move, delete emails) |
138-
| MoveFolder | Destination folder for processed 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 |
142-
| ServerHost | Incoming mail server hostname or IP address |
143-
| ServerPort | Incoming mail server port |
131+
| Attribute | Description |
132+
|--------------------|------------------------------------------------------|
133+
| IncomingProtocol | Email retrieval protocol (IMAP/POP3) |
134+
| Folder | Server folder for email retrieval |
135+
| UseBatchImport | Enables batch processing for large email volumes |
136+
| BatchSize | Number of emails processed per batch operation |
137+
| Handling | Post-retrieval action (keep, move, delete emails) |
138+
| MoveFolder | Destination folder for processed 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 |
142+
| ServerHost | Incoming mail server hostname or IP address |
143+
| ServerPort | Incoming mail server port |
144144

145145

146146
##### OutgoingEmailConfiguration {#outgoing-email-configuration}
147147

148-
Configuration entity defining Send Protocol settings, security protocols, and reliability options for sending emails.
148+
The **OutgoingEmailConfiguration** entity manages Send Protocol settings, security protocols, and reliability options for sending emails.
149149

150150
| Attribute | Description |
151151
|------------------|------------------------------------------------------|
@@ -158,7 +158,7 @@ Configuration entity defining Send Protocol settings, security protocols, and re
158158

159159
##### EmailMessage {#email-message}
160160

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.
162162

163163
| Attribute | Description |
164164
|-------------------|-------------------------------------------------------------------|
@@ -186,7 +186,7 @@ Entity representing individual email messages with complete metadata, content, a
186186

187187
##### EmailTemplate {#email-template}
188188

189-
Entity enabling reusable email designs with dynamic content placeholders for consistent and efficient messaging.
189+
The **EmailTemplate** enables reusable email designs with dynamic content placeholders for consistent and efficient messaging.
190190

191191
| Attribute | Description |
192192
|------------------|-----------------------------------------------|
@@ -209,7 +209,7 @@ Entity enabling reusable email designs with dynamic content placeholders for con
209209

210210
##### Attachment {#attachment}
211211

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.
213213

214214
#### Snippets {#snippets}
215215

@@ -282,8 +282,8 @@ Configuration supports two authentication methods:
282282

283283
You can set these up using the **Enable Microsoft Entra ID Authentication**:
284284

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)
287287

288288
### Basic Authentication {#send-basic-authentication}
289289

@@ -318,7 +318,7 @@ You can configure your account to authenticate with Microsoft Entra ID OAuth 2.0
318318
To manage configurations:
319319

320320
* 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
322322

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

@@ -358,24 +358,24 @@ You can view and change the following settings by clicking **View Settings** as
358358

359359
#### Error Logs Tab
360360

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.
362362

363363
### Sending Email via Microflow
364364

365365
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.
366366

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.
368368

369369
### Sending Email via Java Action
370370

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:
372372

373373
* **EmailAccount** – The entity containing the configuration details for the outgoing email account
374374
* **EmailMessage** – The entity instance containing the content and details of the email to be sent
375375

376376
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.
377377

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 (;).
379379

380380
## Receive Email {#receive-email}
381381

@@ -395,8 +395,8 @@ Configuration supports two authentication methods:
395395

396396
You can set these up using the **Enable Microsoft Entra ID Authentication**:
397397

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)
400400

401401
#### Basic Authentication {#receive-basic-authentication}
402402

@@ -485,7 +485,7 @@ You can view and change the following settings by clicking **View Settings** as
485485

486486
#### Error Logs Tab
487487

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.
489489

490490
### Receiving Email
491491

@@ -624,7 +624,7 @@ This tab allows you to configure templates you can use to send your emails.
624624

625625
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:
626626

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.
628628
* **EmailTemplate** – Email template used to construct and send an **EmailMessage** object.
629629
* **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/).
630630

0 commit comments

Comments
 (0)