Skip to content

Commit c228f2f

Browse files
atul-lahade-mxatul-lahade-mx
committed
Improved references
1 parent 480044b commit c228f2f

1 file changed

Lines changed: 32 additions & 43 deletions

File tree

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

Lines changed: 32 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ The Email Connector includes the following capabilities:
2828

2929
* Basic Authentication (username/password)
3030
* OAuth 2.0 (Authorization Code Flow & Client Credentials Flow)
31-
* Microsoft Entra ID integration
32-
* Shared mailbox support
31+
* Microsoft Entra ID integration
3332

3433
* **Email protocols**:
3534

@@ -44,6 +43,7 @@ The Email Connector includes the following capabilities:
4443
* SSL/TLS encryption
4544
* XSS attack prevention
4645

46+
* **Shared mailbox** support
4747
* **Email Templates** with rich text editor and placeholder tokens
4848
* **Real-time email monitoring** and folder management
4949
* **Attachment support** (normal and inline)
@@ -57,12 +57,12 @@ Missing a step, or changing the order can lead to errors.
5757
{{% /alert %}}
5858

5959
1. Download and configure the latest version of the [Mx Model Reflection](/appstore/modules/model-reflection/) module.
60-
1. Download and configure the latest version of the [Encryption](/appstore/modules/encryption/) module.
61-
1. Download and configure the latest version of the [Community Commons](/appstore/modules/community-commons-function-library/) module.
62-
1. 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-
1. 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`).
64-
1. [Clean the deployment directory](/refguide/app-menu/#clean-deployment-directory).
65-
1. Add the **Email_Connector_Overview** page located in the **USE_ME > Pages** to your app navigation.
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.
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+
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`).
64+
6. [Clean the deployment directory](/refguide/app-menu/#clean-deployment-directory).
65+
7. Add the **Email_Connector_Overview** page located in the **USE_ME > Pages** to your app navigation.
6666

6767
### Migrating from Another Module
6868

@@ -79,7 +79,7 @@ The module includes the following bundled widgets:
7979
* [Pop-Up Menu](/appstore/widgets/popup-menu/)
8080

8181
{{% alert color="info" %}}
82-
If you already have these widgets in your app and they are not up to date, you will get a "Some widgets can not be read" error.
82+
If you already have these widgets in your app, and they are not up to date, you will get a "Some widgets can not be read" error.
8383
{{% /alert %}}
8484

8585
## Setting up the Email Connector in Studio Pro {#setup}
@@ -99,10 +99,6 @@ The module includes a default **EmailConnectorAdmin** module role with pre-confi
9999

100100
The Email Connector provides building blocks that you assemble to create email functionality:
101101

102-
* **[Entities](#entities)** - Represents a class of real-world objects, such as EmailAccount, EmailMessage, EmailTemplate, etc.
103-
* **[Snippets](#snippets)** - Reusable interface components that can be used across pages, layouts, and other snippets
104-
* **[Microflows](#microflows)** - Express application logic through actions such as creating objects, updating data, showing pages, and making decisions.
105-
* **[Java Actions](#java-actions)** - Extend application functionality beyond what's possible with microflows alone.
106102

107103
#### Entities {#entities}
108104

@@ -261,14 +257,7 @@ This tab displays a list of any log entries related to errors in the Email Conne
261257

262258
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.
263259

264-
When working with email templates, refer to the following sample microflows:
265-
266-
* **Sample_ACT_CreateEmailFromTemplateAndThenSend** – Demonstrates how to create an email from a template, customize it, and then send it
267-
* **Sample_ACT_SendEmailWithTemplate** – Demonstrates how to send an email directly using a predefined template
268-
269-
{{% alert color="info" %}}
270-
It is recommended to use **Sample_ACT_SendEmailWithTemplate** for most email template scenarios. It provides a streamlined implementation for sending templated emails with minimal configuration overhead.
271-
{{% /alert %}}
260+
When sending emails using templates, refer to the [Email Templates](#email-templates) section below.
272261

273262
### Sending Email via Java Action
274263

@@ -457,26 +446,26 @@ Depending on your use case, modify the **azure_defaultConfig** constant to speci
457446

458447
###### Send Emails
459448

460-
| Permission Name | Description |
461-
|-----------------|-------------|
462-
| SMTP.Send | Send emails from mailboxes using SMTP AUTH. |
463-
| User.Read | Sign in and read user profile (required for authentication). |
464-
| openid | Sign users in (required for OAuth/OpenID Connect). |
449+
| Permission Name | Description |
450+
|-----------------|---------------------------------------------------------------------------|
451+
| SMTP.Send | Send emails from mailboxes using SMTP AUTH. |
452+
| User.Read | Sign in and read user profile (required for authentication). |
453+
| openid | Sign users in (required for OAuth/OpenID Connect). |
465454
| offline_access | Maintain access to data you have given it access to (for refresh tokens). |
466-
| profile | View users' basic profile (often used during sign-in). |
467-
| email | View users' email address (optional but helpful). |
455+
| profile | View users' basic profile (often used during sign-in). |
456+
| email | View users' email address (optional but helpful). |
468457

469458
###### Receive Emails
470459

471-
| Permission Name | Description |
472-
|--------------------------|-------------|
473-
| IMAP.AccessAsUser.All | Read and write access to mailboxes via IMAP. |
474-
| POP.AccessAsUser.All | Read and write access to mailboxes via POP. |
475-
| User.Read | Sign in and read user profile (required for authentication). |
476-
| openid | Sign users in (required for OAuth/OpenID Connect). |
477-
| offline_access | Maintain access to data you have given it access to (for refresh tokens). |
478-
| profile | View users' basic profile (often used during sign-in). |
479-
| email | View users' email address (optional but helpful). |
460+
| Permission Name | Description |
461+
|-----------------------|---------------------------------------------------------------------------|
462+
| IMAP.AccessAsUser.All | Read and write access to mailboxes via IMAP. |
463+
| POP.AccessAsUser.All | Read and write access to mailboxes via POP. |
464+
| User.Read | Sign in and read user profile (required for authentication). |
465+
| openid | Sign users in (required for OAuth/OpenID Connect). |
466+
| offline_access | Maintain access to data you have given it access to (for refresh tokens). |
467+
| profile | View users' basic profile (often used during sign-in). |
468+
| email | View users' email address (optional but helpful). |
480469

481470
### Client Credential Grant Flow{#client-credentials-flow}
482471

@@ -506,14 +495,14 @@ On the [Microsoft Entra ID](https://portal.azure.com/), ensure you have the foll
506495

507496
##### Receive Emails (Application Permissions)
508497

509-
| Permission Name | Type | Description |
510-
|--------------------|-------------|-------------|
511-
| IMAP.AccessAsApp | Application | Read and write access to all mailboxes via IMAP. |
512-
| POP.AccessAsApp | Application | Read and write access to all mailboxes via POP. |
498+
| Permission Name | Type | Description |
499+
|------------------|-------------|--------------------------------------------------|
500+
| IMAP.AccessAsApp | Application | Read and write access to all mailboxes via IMAP. |
501+
| POP.AccessAsApp | Application | Read and write access to all mailboxes via POP. |
513502

514503
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).
515504

516-
## Email Templates
505+
## Email Templates {#email-templates}
517506

518507
1. Deploy your application to set up your **Email Templates** through the Email Connector user interface.
519508
2. Navigate to the **Email Connector Overview** page.
@@ -655,7 +644,7 @@ To add inline attachments to an email message, use the Rich text editor to inser
655644
656645
### Page Styling
657646
658-
If the **Email Connector** page styling is affected as you select and view email messages, it likely due to errors in the email message CSS.
647+
If the **Email Connector** page styling is affected as you select and view email messages, it is likely due to errors in the email message CSS.
659648
660649
To resolve the errors, turn on **Sanitize email to prevent XSS attacks** in [Account Settings](#other-account-settings).
661650

0 commit comments

Comments
 (0)