docs(inbound-email-connector): add inbound email connector documentation #4463

mathias-vandaele · 2024-10-15T08:45:05Z

Description

This feature will be available in the next connector patch 8.6.3

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.

github-actions · 2024-10-15T08:45:35Z

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

github-actions · 2024-10-15T08:46:46Z

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

+This inbound connector creates a new process each time a new email is received.
+
+- `Folder`: (Optional) This parameter defines the folder that the inbound connector will monitor. If not specified, the default folder is set to INBOX.
+- `Polling Wait Time`: This parameter sets the interval between each polling operation. Please [refer to the documentation](https://docs.camunda.io/docs/components/modeler/bpmn/timer-events/#time-duration) on time duration for the correct format.


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

christinaausley · 2024-10-15T13:48:10Z

Relates to https://github.com/camunda/product-hub/issues/2430.

github-actions · 2024-10-31T10:58:40Z

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

+  default folder is set to INBOX. For subfolders, use `.` or `/` separated path (ex: `inside/folder` or
+  `inside.folder`)
+- `Polling Wait Time`: This parameter sets the interval between each polling operation.
+  Please [refer to the documentation](https://docs.camunda.io/docs/components/modeler/bpmn/timer-events/#time-duration)


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

akeller · 2024-11-04T21:02:00Z

What is the status of this PR?

mathias-vandaele · 2024-11-05T09:54:44Z

Relates to camunda/product-hub#2430.

It will be released on 8.6.4 of connectors this week

mesellings · 2024-11-05T10:26:20Z

@mathias-vandaele I assume this means this should be included in the alpha release next week then?

If so, please can you add the relevant label(s) if this is correct (for example, "8.7.0-alpha1") and complete the When should this change go live and PR checklist sections.
I can then plan and complete a TW review of this PR for you 👍

mathias-vandaele · 2024-11-07T14:10:27Z

@mathias-vandaele I assume this means this should be included in the alpha release next week then?

If so, please can you add the relevant label(s) if this is correct (for example, "8.7.0-alpha1") and complete the When should this change go live and PR checklist sections.

I can then plan and complete a TW review of this PR for you 👍

Hello @mesellings I added the correct label, I want to mention this will also be added in the next patch of 8.6.

This will be part of the next alpha but this feature will also be present on latest

mesellings · 2024-11-07T14:13:40Z

Thanks @mathias-vandaele I'll review this for you now 👍

mesellings · 2024-11-07T14:19:33Z

@mathias-vandaele I assume this means this should be included in the alpha release next week then?

If so, please can you add the relevant label(s) if this is correct (for example, "8.7.0-alpha1") and complete the When should this change go live and PR checklist sections.

I can then plan and complete a TW review of this PR for you 👍

Hello @mesellings I added the correct label, I want to mention this will also be added in the next patch of 8.6.

This will be part of the next alpha but this feature will also be present on latest

I assume this means we should also backport to the 8.6 docs? (just checking)

akeller · 2024-11-07T16:39:53Z

I've updated the PR description based on the following:

This will be part of the next alpha but this feature will also be present on latest

To me, this means it should be available for both the current docs (8.6) and future (/next/ or 8.7). @mathias-vandaele please use the template to help us understand how and when to review your changes.

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

versioned_docs/version-8.6/components/connectors/out-of-the-box-connectors/email.md

mesellings

@mathias-vandaele I've committed my edits to the branch, and backported to the 8.6 docs, happy to approve, good job! 👍 🚀

mesellings · 2024-11-08T09:19:45Z

@mathias-vandaele Shall I merge and release this for you?

mesellings

Fixed broken link and typo - approved 👍

…s://github.com/camunda/camunda-docs into docs-add-inbound-email-connector-documentation

mesellings

Approved after link fix 👍

docs(inbound-email-connector): add inbound email connector documentation

acf9bb7

mathias-vandaele requested a review from sbuettner October 15, 2024 08:45

github-actions bot reviewed Oct 15, 2024

View reviewed changes

christinaausley assigned mathias-vandaele Oct 15, 2024

christinaausley added the component:connectors Issues related to the connectors project. label Oct 15, 2024

docs(inbound-email-connector): add specification concerning folder

0bd28ef

github-actions bot reviewed Oct 31, 2024

View reviewed changes

sbuettner previously approved these changes Nov 5, 2024

View reviewed changes

mathias-vandaele added the 8.7.0-alpha1 November 2024 alpha release label Nov 7, 2024

mesellings self-requested a review November 7, 2024 14:13

mesellings self-assigned this Nov 7, 2024

TW edits

9268f18

mesellings dismissed sbuettner’s stale review via 9268f18 November 8, 2024 09:11

github-actions bot reviewed Nov 8, 2024

View reviewed changes

docs/components/connectors/out-of-the-box-connectors/email.md Outdated Show resolved Hide resolved

Backport to 8.6

0cfa1a0

github-actions bot reviewed Nov 8, 2024

View reviewed changes

versioned_docs/version-8.6/components/connectors/out-of-the-box-connectors/email.md Outdated Show resolved Hide resolved

mesellings previously approved these changes Nov 8, 2024

View reviewed changes

Fix link and typo

1d03c6d

mesellings dismissed their stale review via 1d03c6d November 8, 2024 09:21

mesellings self-requested a review November 8, 2024 09:22

mesellings previously approved these changes Nov 8, 2024

View reviewed changes

mesellings added 4 commits November 8, 2024 09:23

Merge branch 'main' into docs-add-inbound-email-connector-documentation

a8b63aa

Merge branch 'main' into docs-add-inbound-email-connector-documentation

8de3047

Fix link

143a06b

Merge branch 'docs-add-inbound-email-connector-documentation' of http…

8a11163

…s://github.com/camunda/camunda-docs into docs-add-inbound-email-connector-documentation

mesellings dismissed their stale review via 8a11163 November 8, 2024 10:11

mesellings self-requested a review November 8, 2024 10:11

mesellings approved these changes Nov 8, 2024

View reviewed changes

mesellings merged commit 72a338f into main Nov 8, 2024
7 checks passed

mesellings deleted the docs-add-inbound-email-connector-documentation branch November 8, 2024 10:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(inbound-email-connector): add inbound email connector documentation #4463

docs(inbound-email-connector): add inbound email connector documentation #4463

mathias-vandaele commented Oct 15, 2024 •

edited by akeller

Loading

github-actions bot commented Oct 15, 2024 •

edited

Loading

github-actions bot Oct 15, 2024

christinaausley commented Oct 15, 2024

github-actions bot Oct 31, 2024

akeller commented Nov 4, 2024

mathias-vandaele commented Nov 5, 2024

mesellings commented Nov 5, 2024

mathias-vandaele commented Nov 7, 2024

mesellings commented Nov 7, 2024

mesellings commented Nov 7, 2024

akeller commented Nov 7, 2024

mesellings left a comment

mesellings commented Nov 8, 2024

mesellings left a comment •

edited

Loading

mesellings left a comment

docs(inbound-email-connector): add inbound email connector documentation #4463

docs(inbound-email-connector): add inbound email connector documentation #4463

Conversation

mathias-vandaele commented Oct 15, 2024 • edited by akeller Loading

Description

When should this change go live?

PR Checklist

github-actions bot commented Oct 15, 2024 • edited Loading

github-actions bot Oct 15, 2024

Choose a reason for hiding this comment

christinaausley commented Oct 15, 2024

github-actions bot Oct 31, 2024

Choose a reason for hiding this comment

akeller commented Nov 4, 2024

mathias-vandaele commented Nov 5, 2024

mesellings commented Nov 5, 2024

mathias-vandaele commented Nov 7, 2024

mesellings commented Nov 7, 2024

mesellings commented Nov 7, 2024

akeller commented Nov 7, 2024

mesellings left a comment

Choose a reason for hiding this comment

mesellings commented Nov 8, 2024

mesellings left a comment • edited Loading

Choose a reason for hiding this comment

mesellings left a comment

Choose a reason for hiding this comment

mathias-vandaele commented Oct 15, 2024 •

edited by akeller

Loading

github-actions bot commented Oct 15, 2024 •

edited

Loading

mesellings left a comment •

edited

Loading