doc(email-connector): create a documentation for the new email connector #4307

mathias-vandaele · 2024-09-16T14:32:49Z

…tor (inbound and outbound)

Description

When should this change go live?

This is a bug fix, security concern, or something that needs urgent release support.
This is already available but undocumented and should be released within a week.
This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
This is part of a scheduled alpha or minor. (apply alpha or minor label)
There is no urgency with this change and can be released at any time.

PR Checklist

My changes are for an already released minor and are in /versioned_docs directory.
My changes are for the next minor and are in /docs directory (aka /next/).

My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

…tor (inbound and outbound)

github-actions · 2024-09-16T14:33:19Z

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

docs/components/connectors/out-of-the-box-connectors/email.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

prettier

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Lines 534 to 536 in 0086d89

    
           "messageId":"VE1P191MB1101730EEA31B2FEAB320143919A2@VE1P191MB1101.EURP191.PROD.OUTLOOK.COM", 
        
           "from":"INBOX", 
        
           "to":"TEST"

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Lines 566 to 571 in 0086d89

    
           - `Unseen emails will be sync`: A process instance is created for every unseen email present in the folder at the 
        
             time the connector starts. 
        
           - `No initial sync. Only new emails`: The connector skips past emails and starts listening for new emails arriving 
        
             in the folder. 
        
           - `All emails will be sync`: A process instance is created for every email in the folder, regardless of their read 
        
             status, when the connector starts.

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Lines 573 to 581 in 0086d89

    
           - `Mark as read after processing`: Emails that have been processed will be marked as read. 
        
           - `Do nothing`: No action will be taken on processed emails. 
        
           - `Delete after processing`: Emails that have been processed will be deleted from the folder. 
        
           - `Move to another folder after processing`: Processed emails will be moved to another specified folder. 
        
               - `Folder`: Indicates the destination folder where emails will be moved after processing. A new folder or folder 
        
                 hierarchy 
        
                 can be specified using a dot-separated path (e.g., 'Archive' or 'Projects.2023.January'). Non-existent folders 
        
                 in the 
        
                 path will be created automatically.

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Lines 590 to 595 in 0086d89

    
           "messageId":"messageId", 
        
           "fromAddresses":["example@camunda.com"], 
        
           "subject":"Urgent Test", 
        
           "size":65646, 
        
           "plainTextBody":"Hey how are you?\r\n", 
        
           "htmlBody":"<html>Hello</html>"

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Line 622 in 0086d89

    
           |---------------------------------------|----------------------|--------------------------------------------------------------|

johnBgood

Few comments only, overall great 🔥

johnBgood · 2024-09-17T07:57:25Z

docs/components/connectors/out-of-the-box-connectors/email.md

+
+It allows the user to connect to any SMTP, POP3 or IMAP server using the email address and the associated password.
+
+# POP3


I think only H2 appears in the right menu

johnBgood · 2024-09-17T07:59:18Z

docs/components/connectors/out-of-the-box-connectors/email.md

+their local computer, where they can be read, managed, or archived even without an internet connection. It operates on a
+simple download-and-delete model, meaning emails are typically removed from the server once they are retrieved.
+
+- `POP3 host`: the host url of the POP3 server.


General comment:
It would be great to use tables for parameters, just like in the SQL connector.
Thus you can provide the default value, example values etc.

johnBgood · 2024-09-17T07:59:55Z

docs/components/connectors/out-of-the-box-connectors/email.md

@@ -0,0 +1,695 @@
+---
+id: email


This connector doesn't appear in the left menu: "Out of the box connectors"

I am trying to understand why

johnBgood · 2024-09-17T08:02:16Z

docs/components/connectors/out-of-the-box-connectors/email.md

+    "messageId":"RandomId",
+    "fromAddresses":["msa@communication.microsoft.com"],
+    "subject":"Example",
+    "size":99865


comment for the connector ifself, can we return sizeInBytes instead of size?

johnBgood · 2024-09-17T08:04:03Z

docs/components/connectors/out-of-the-box-connectors/email.md

+
+# Prerequisites
+
+This inbound connector only work with IMAP server.


I would highlight this, maybe a warn/note component, you can find examples in other connectors docs

docs/components/connectors/out-of-the-box-connectors/email.md

johnBgood · 2024-09-17T08:10:23Z

docs/components/connectors/out-of-the-box-connectors/email.md

+
+### Activation condition
+
+The **Activation condition** is an optional field where you can specify a Friendly Enough Expression Language (FEEL)


Friendly Enough Expression Language (FEEL)

This could be a link to the docs

johnBgood · 2024-09-17T08:11:17Z

docs/components/connectors/out-of-the-box-connectors/email.md

+subject of the incoming email matches "urgent". If this field is left blank, the process will be triggered for every
+email received by the connector.
+
+:::warning By default, the Email Inbound Connector is designed not to execute its handling strategy if it encounters an


the rendering is weird there

johnBgood · 2024-09-17T08:12:15Z

docs/components/connectors/out-of-the-box-connectors/email.md

+:::warning By default, the Email Inbound Connector is designed not to execute its handling strategy if it encounters an
+email that it cannot process, such as when the activation condition is not fulfilled. :::
+
+To ignore messages that do not meet the activation condition and still handle the email, check the **Consume unmatched


Consume unmatched
This could be a link I guess we have it documented somewhere

docs/components/connectors/out-of-the-box-connectors/email.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

prettier

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Lines 566 to 571 in 89d6e56

    
           - `Unseen emails will be sync`: A process instance is created for every unseen email present in the folder at the 
        
             time the connector starts. 
        
           - `No initial sync. Only new emails`: The connector skips past emails and starts listening for new emails arriving 
        
             in the folder. 
        
           - `All emails will be sync`: A process instance is created for every email in the folder, regardless of their read 
        
             status, when the connector starts.

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Lines 573 to 581 in 89d6e56

    
           - `Mark as read after processing`: Emails that have been processed will be marked as read. 
        
           - `Do nothing`: No action will be taken on processed emails. 
        
           - `Delete after processing`: Emails that have been processed will be deleted from the folder. 
        
           - `Move to another folder after processing`: Processed emails will be moved to another specified folder. 
        
               - `Folder`: Indicates the destination folder where emails will be moved after processing. A new folder or folder 
        
                 hierarchy 
        
                 can be specified using a dot-separated path (e.g., 'Archive' or 'Projects.2023.January'). Non-existent folders 
        
                 in the 
        
                 path will be created automatically.

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Lines 590 to 595 in 89d6e56

    
           "messageId":"messageId", 
        
           "fromAddresses":["example@camunda.com"], 
        
           "subject":"Urgent Test", 
        
           "size":65646, 
        
           "plainTextBody":"Hey how are you?\r\n", 
        
           "htmlBody":"<html>Hello</html>"

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Line 622 in 89d6e56

    
           |---------------------------------------|----------------------|--------------------------------------------------------------|

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

prettier

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Lines 573 to 581 in fc0a212

    
           - `Mark as read after processing`: Emails that have been processed will be marked as read. 
        
           - `Do nothing`: No action will be taken on processed emails. 
        
           - `Delete after processing`: Emails that have been processed will be deleted from the folder. 
        
           - `Move to another folder after processing`: Processed emails will be moved to another specified folder. 
        
               - `Folder`: Indicates the destination folder where emails will be moved after processing. A new folder or folder 
        
                 hierarchy 
        
                 can be specified using a dot-separated path (e.g., 'Archive' or 'Projects.2023.January'). Non-existent folders 
        
                 in the 
        
                 path will be created automatically.

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Lines 590 to 595 in fc0a212

    
           "messageId":"messageId", 
        
           "fromAddresses":["example@camunda.com"], 
        
           "subject":"Urgent Test", 
        
           "size":65646, 
        
           "plainTextBody":"Hey how are you?\r\n", 
        
           "htmlBody":"<html>Hello</html>"

[prettier] _{reported by reviewdog 🐶}

camunda-docs/docs/components/connectors/out-of-the-box-connectors/email.md

Line 622 in fc0a212

    
           |---------------------------------------|----------------------|--------------------------------------------------------------|

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

christinaausley · 2024-09-17T13:12:05Z

@mathias-vandaele If you run npm run format in your terminal and commit the changes, the Prettier linting will clean up these errors for you 👍

github-actions · 2024-09-17T14:16:17Z

docs/components/connectors/out-of-the-box-connectors/email.md

+
+#### Activation condition
+
+The **Activation condition** is an optional field where you can specify a Friendly Enough Expression Language [


⚠️ [vale] _{reported by reviewdog 🐶}
[all.hrefProduction] Improper link format: ' FEEL'. Please use relative URLs.

github-actions · 2024-09-17T14:28:06Z

The preview environment relating to the commit 18af859 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4307/index.html

mesellings · 2024-09-17T15:56:33Z

@mathias-vandaele I can do a TW review for you 👍

mesellings · 2024-09-17T16:22:06Z

@mathias-vandaele Can I commit directly to the branch, or are you still working on it? I can fix those issues for you at the same time as well if you like (the sidebar etc)

doc(email-connector): create a documentation for the new email connec…

0086d89

…tor (inbound and outbound)

mathias-vandaele added the hold This issue is parked, do not merge. label Sep 16, 2024

github-actions bot reviewed Sep 16, 2024

View reviewed changes

johnBgood added the deploy Stand up a temporary docs site with this PR label Sep 16, 2024

github-actions bot temporarily deployed to camunda-docs September 16, 2024 15:19 Destroyed

docs(email-connector): fixes for the side bar

432c58d

johnBgood reviewed Sep 17, 2024

View reviewed changes

github-actions bot temporarily deployed to camunda-docs September 17, 2024 08:21 Destroyed

mathias-vandaele and others added 10 commits September 17, 2024 14:32

Update docs/components/connectors/out-of-the-box-connectors/email.md

89d6e56

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Update docs/components/connectors/out-of-the-box-connectors/email.md

fc0a212

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Update docs/components/connectors/out-of-the-box-connectors/email.md

45226cf

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Update docs/components/connectors/out-of-the-box-connectors/email.md

f2e02ad

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Update docs/components/connectors/out-of-the-box-connectors/email.md

f3263ba

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Update docs/components/connectors/out-of-the-box-connectors/email.md

d289168

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Update docs/components/connectors/out-of-the-box-connectors/email.md

1cde663

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Update docs/components/connectors/out-of-the-box-connectors/email.md

bf31821

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Update docs/components/connectors/out-of-the-box-connectors/email.md

52404cd

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Update docs/components/connectors/out-of-the-box-connectors/email.md

cd57b98

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions bot reviewed Sep 17, 2024

View reviewed changes

mathias-vandaele and others added 2 commits September 17, 2024 14:41

Update docs/components/connectors/out-of-the-box-connectors/email.md

c8852c9

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

docs(email-connector): prettier

598487c

github-actions bot temporarily deployed to camunda-docs September 17, 2024 12:57 Destroyed

christinaausley assigned mathias-vandaele Sep 17, 2024

docs(email-connector): fix comments

67a6d86

github-actions bot reviewed Sep 17, 2024

View reviewed changes

github-actions bot temporarily deployed to camunda-docs September 17, 2024 14:23 Destroyed

mesellings self-requested a review September 17, 2024 15:55

mesellings self-assigned this Sep 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc(email-connector): create a documentation for the new email connector #4307

doc(email-connector): create a documentation for the new email connector #4307

mathias-vandaele commented Sep 16, 2024

github-actions bot commented Sep 16, 2024

github-actions bot left a comment

johnBgood left a comment

johnBgood Sep 17, 2024

johnBgood Sep 17, 2024

johnBgood Sep 17, 2024

mathias-vandaele Sep 17, 2024

johnBgood Sep 17, 2024

johnBgood Sep 17, 2024

johnBgood Sep 17, 2024

johnBgood Sep 17, 2024

johnBgood Sep 17, 2024

github-actions bot left a comment

github-actions bot left a comment

christinaausley commented Sep 17, 2024

github-actions bot Sep 17, 2024

github-actions bot commented Sep 17, 2024

mesellings commented Sep 17, 2024

mesellings commented Sep 17, 2024

	"messageId":"VE1P191MB1101730EEA31B2FEAB320143919A2@VE1P191MB1101.EURP191.PROD.OUTLOOK.COM",
	"from":"INBOX",
	"to":"TEST"

	- `Unseen emails will be sync`: A process instance is created for every unseen email present in the folder at the
	time the connector starts.
	- `No initial sync. Only new emails`: The connector skips past emails and starts listening for new emails arriving
	in the folder.
	- `All emails will be sync`: A process instance is created for every email in the folder, regardless of their read
	status, when the connector starts.

	- `Mark as read after processing`: Emails that have been processed will be marked as read.
	- `Do nothing`: No action will be taken on processed emails.
	- `Delete after processing`: Emails that have been processed will be deleted from the folder.
	- `Move to another folder after processing`: Processed emails will be moved to another specified folder.
	- `Folder`: Indicates the destination folder where emails will be moved after processing. A new folder or folder
	hierarchy
	can be specified using a dot-separated path (e.g., 'Archive' or 'Projects.2023.January'). Non-existent folders
	in the
	path will be created automatically.

	"messageId":"messageId",
	"fromAddresses":["example@camunda.com"],
	"subject":"Urgent Test",
	"size":65646,
	"plainTextBody":"Hey how are you?\r\n",
	"htmlBody":"<html>Hello</html>"


		It allows the user to connect to any SMTP, POP3 or IMAP server using the email address and the associated password.

		# POP3


		# Prerequisites

		This inbound connector only work with IMAP server.


		### Activation condition

		The Activation condition is an optional field where you can specify a Friendly Enough Expression Language (FEEL)


		#### Activation condition

		The Activation condition is an optional field where you can specify a Friendly Enough Expression Language [

doc(email-connector): create a documentation for the new email connector #4307

Are you sure you want to change the base?

doc(email-connector): create a documentation for the new email connector #4307

Conversation

mathias-vandaele commented Sep 16, 2024

Description

When should this change go live?

PR Checklist

github-actions bot commented Sep 16, 2024

github-actions bot left a comment

Choose a reason for hiding this comment

johnBgood left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

christinaausley commented Sep 17, 2024

github-actions bot Sep 17, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 17, 2024

mesellings commented Sep 17, 2024

mesellings commented Sep 17, 2024