feat(Email Trigger (IMAP) Node): IMAP trigger node returns message UIDs #13152

umanamente · 2025-02-09T20:55:49Z

Summary

This PR adds returning the UID for each email message in the IMAP Trigger node. This allows subsequent nodes to use the UID for email manipulation. For example, the community IMAP node n8n-nodes-imap supports moving and copying emails between mailboxes, which requires the UID. Previously, this information was missing in the IMAP Trigger node output.

Steps to test:

Configure the IMAP Trigger node.
Wait for it to return a new email message.
Check the output data — the attributes field should contain the UID field.

Related Linear tickets, Github issues, and Community forum posts

Forum feature request IMAP Trigger Node - Provide email UIDs
GitHub issue: Use With N8N native trigger node umanamente/n8n-nodes-imap#42

Review / Merge checklist

PR title and summary are descriptive.
Docs updated or follow-up ticket created. NO DOCS AVAILABLE IN BASELINE
Tests included. - NO TESTS AVAILABLE IN BASELINE
PR labeled with release/backport (if necessary). - NO NEED

Joffcom · 2025-02-09T21:00:53Z

Hey @umanamente,

Thanks for the PR, We have created "GHC-783" as the internal reference to get this reviewed.

One of us will be in touch if there are any changes needed, in most cases this is normally within a couple of weeks but it depends on the current workload of the team.

codecov · 2025-02-13T13:57:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

dana-gill · 2025-02-24T09:29:08Z

@umanamente hi, could you please fix the tests 🙏 thank you!

dana-gill · 2025-03-10T17:32:11Z

packages/nodes-base/nodes/EmailReadImap/test/v2/utils.test.ts

@@ -42,6 +42,9 @@ describe('Test IMap V2 utils', () => {
 							headers: { '': 'Body content' },
 							headerLines: undefined,
 							html: false,
+							attributes: {
+								uid: undefined,


Could you please add the following test cases:

Expect the uid to be defined

uid is in the wrong format -- Probably requires some try/catch in getEmails of v2.

🙏

I added the first test: 'Expect the uid to be defined.'
I think the second test is unnecessary since the uid is already used in the code. Let me know your thoughts.

packages/nodes-base/nodes/EmailReadImap/v1/EmailReadImapV1.node.ts

dana-gill · 2025-03-13T08:56:45Z

Hey @umanamente thanks for adding the test case for uid to be defined 😄 I think there was a bit of miscommunication on my end for what I would expect to see for test cases. Here are the test cases I would expect to see for this PR:

uid is not defined
uid is defined

So you would have the following tests cases:

it('should return new emails' => ... )
// keep as is

it('should return new emails with uid if uid is present' => ... )
// this should be the same 'should return new emails' except you add uid to message and expect uid

Let me know if this makes sense

umanamente · 2025-03-13T13:11:54Z

If uid is not present, the node itself will break, since uid is used in the code before returning

koordinator7 · 2025-03-13T14:34:36Z

\ @umanamente

Good day. Please tell me how I can get UID in the IMAP node? If it's not too much trouble, in more detail, where and what code should I write?

umanamente · 2025-03-15T08:14:45Z

@dana-gill
I don't think adding a test to validate the UID makes sense because if the UID is not valid, the existing node functionality will break. If this test is necessary, it should be added by the developers maintaining this node, as it affects the node's functionality itself rather than the changes introduced in this pull request.

Please let me know your thoughts and if any further changes are needed before it can be merged.

koordinator7 · 2025-03-17T14:50:23Z

@umanamente
Good day. Please tell me how I can get UID in the IMAP node? If it's not too much trouble, in more detail, where and what code should I write?

umanamente · 2025-03-18T04:34:00Z

@umanamente
Good day. Please tell me how I can get UID in the IMAP node? If it's not too much trouble, in more detail, where and what code should I write?

This function is not available in the node yet. This pull request adds it, but it needs to be merged first.

koordinator7 · 2025-03-18T10:57:04Z

@umanamente

This function is not available in the node yet. This pull request adds it, but it needs to be merged first.
Thank you. I understand that the standard IMAP node does not yet contain UID. But you somehow get UID in the IMAP node. Please tell me what I need to do to get UID too. If it is not difficult, please provide more details.

dana-gill · 2025-03-24T15:58:46Z

Hey @umanamente could you rebase off of master and then ping me and you've done that? Thanks

umanamente · 2025-03-24T21:33:46Z

Hey @umanamente could you rebase off of master and then ping me and you've done that? Thanks

@dana-gill , sure, done

dana-gill · 2025-03-25T09:48:52Z

@umanamente it looks like the unit tests are failing. could you please patch them up and then ping me again when the pr is ready? thanks!

koordinator7 · 2025-03-27T10:48:44Z

Hey @umanamente
Help!!! "This function is not available in the node yet". This pull request adds it, but it needs to be merged first.
Thank you. I understand that the standard IMAP node does not yet contain UID. But you somehow get UID in the IMAP node. Please tell me what I need to do to get UID too. If it is not difficult, please provide more details.

umanamente · 2025-04-03T04:08:09Z

@dana-gill ,
I’ve fixed the unit tests. The issue was that the same staticData object was being reused across different runs. During the first run, the function added the last email's ID to staticData, and since that ID persisted between runs, the email was getting filtered out, resulting in an empty array. I’ve updated it so that a fresh staticData object is created before each run.

Could you please run the tests again?

packages/nodes-base/nodes/EmailReadImap/test/v2/utils.test.ts

umanamente · 2025-04-07T18:06:30Z

@dana-gill
Could you please let me know what the next steps are and if anything is needed from my side for this Pull Request to be merged?

dana-gill · 2025-04-08T07:55:08Z

@dana-gill Could you please let me know what the next steps are and if anything is needed from my side for this Pull Request to be merged?

merged ;)

cypress · 2025-04-08T08:09:42Z

n8n Run #10142

Run Properties: Passed #10142 • eee38f5bf4: 🌳 fix/pay-insights-service-tests 🖥️ browsers:node18.12.0-chrome107 🤖 schedule...

Project	`n8n`
Branch Review	`fix/pay-insights-service-tests`
Run status	`Passed #10142`
Run duration	`03m 43s`
Commit	`eee38f5bf4: 🌳 fix/pay-insights-service-tests 🖥️ browsers:node18.12.0-chrome107 🤖 schedule...`
Committer	`Guillaume Jacquart`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`1`
Pending	`7`
Skipped	`0`
Passing	`474`
View all changes introduced in this branch ↗︎

janober · 2025-04-10T07:38:47Z

Got released with [email protected]

…Ds (n8n-io#13152)

Alexandero89 · 2025-05-20T09:37:48Z

@umanamente thanks for your PR and the time you invested.

i just noticed that the UID is only available when i choose the format of the mails to be "Simple".
When i choose the format "Resolved" there is not attributes and no uid.
Was this planned and is this maybe a technical restriction or would it maybe be possible to extend it to the resolved format.

Thanks in advance

Alexandero89 · 2025-05-20T10:52:06Z

Ok, i created a PR with this feature: #15539

umanamente mentioned this pull request Feb 9, 2025

Use With N8N native trigger node umanamente/n8n-nodes-imap#42

Closed

n8n-assistant bot added community Authored by a community member node/improvement New feature or request in linear Issue or PR has been created in Linear for internal review labels Feb 9, 2025

dana-gill previously approved these changes Feb 13, 2025

View reviewed changes

umanamente changed the title ~~feat(IMAP trigger): IMAP trigger node returns message UIDs~~ feat(IMAP trigger Node): IMAP trigger node returns message UIDs Feb 13, 2025

umanamente dismissed dana-gill’s stale review via 48587bb February 21, 2025 10:01

umanamente force-pushed the feat_imap_add_uid branch from 89b7a9a to 48587bb Compare February 21, 2025 10:01

umanamente requested a review from dana-gill February 21, 2025 10:22

umanamente changed the title ~~feat(IMAP trigger Node): IMAP trigger node returns message UIDs~~ feat(Email Trigger (IMAP) Node): IMAP trigger node returns message UIDs Feb 22, 2025

umanamente force-pushed the feat_imap_add_uid branch from dcd35b2 to 3e61d54 Compare March 9, 2025 21:39

dana-gill requested changes Mar 10, 2025

View reviewed changes

umanamente requested a review from dana-gill March 14, 2025 02:29

dana-gill previously approved these changes Mar 18, 2025

View reviewed changes

umanamente force-pushed the feat_imap_add_uid branch from 9cdfef3 to 3527a36 Compare March 24, 2025 21:33

umanamente force-pushed the feat_imap_add_uid branch from 3527a36 to c9dbbf6 Compare March 26, 2025 07:13

feat(Email Trigger (IMAP) Node): IMAP trigger node returns message UIDs

0b7242e

umanamente force-pushed the feat_imap_add_uid branch from c9dbbf6 to 0b7242e Compare April 1, 2025 14:21

fixed unit tests: reset staticData before each execution

aa8a7bb

umanamente dismissed dana-gill’s stale review via aa8a7bb April 3, 2025 04:06

umanamente requested a review from dana-gill April 3, 2025 04:08

dana-gill requested changes Apr 3, 2025

View reviewed changes

packages/nodes-base/nodes/EmailReadImap/test/v2/utils.test.ts Outdated Show resolved Hide resolved

packages/nodes-base/nodes/EmailReadImap/test/v2/utils.test.ts Outdated Show resolved Hide resolved

renamed staticData

6896b81

umanamente requested a review from dana-gill April 3, 2025 23:48

dana-gill approved these changes Apr 4, 2025

View reviewed changes

dana-gill merged commit 4578709 into n8n-io:master Apr 8, 2025
18 checks passed

github-actions bot mentioned this pull request Apr 10, 2025

🚀 Release 1.88.0 #14513

Merged

janober added the Released label Apr 10, 2025

xbinaryx pushed a commit to xbinaryx/n8n that referenced this pull request Apr 18, 2025

feat(Email Trigger (IMAP) Node): IMAP trigger node returns message UI…

fe9030c

…Ds (n8n-io#13152)

Alexandero89 mentioned this pull request May 20, 2025

fix(Email Trigger (IMAP) Node): Add Email UID also to email format "resolved" #15539

Merged

4 tasks

feat(Email Trigger (IMAP) Node): IMAP trigger node returns message UIDs #13152

feat(Email Trigger (IMAP) Node): IMAP trigger node returns message UIDs #13152

Uh oh!

Conversation

umanamente commented Feb 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Steps to test:

Related Linear tickets, Github issues, and Community forum posts

Review / Merge checklist

Uh oh!

Joffcom commented Feb 9, 2025

Uh oh!

codecov bot commented Feb 13, 2025

Codecov Report

Uh oh!

dana-gill commented Feb 24, 2025

Uh oh!

dana-gill Mar 10, 2025

Choose a reason for hiding this comment

Uh oh!

umanamente Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dana-gill commented Mar 13, 2025

Uh oh!

umanamente commented Mar 13, 2025

Uh oh!

koordinator7 commented Mar 13, 2025

Uh oh!

umanamente commented Mar 15, 2025

Uh oh!

koordinator7 commented Mar 17, 2025

Uh oh!

umanamente commented Mar 18, 2025

Uh oh!

koordinator7 commented Mar 18, 2025

Uh oh!

dana-gill commented Mar 24, 2025

Uh oh!

umanamente commented Mar 24, 2025

Uh oh!

dana-gill commented Mar 25, 2025

Uh oh!

koordinator7 commented Mar 27, 2025

Uh oh!

umanamente commented Apr 3, 2025

Uh oh!

Uh oh!

Uh oh!

umanamente commented Apr 7, 2025

Uh oh!

Uh oh!

dana-gill commented Apr 8, 2025

Uh oh!

cypress bot commented Apr 8, 2025

n8n Run #10142

Uh oh!

janober commented Apr 10, 2025

Uh oh!

Alexandero89 commented May 20, 2025

Uh oh!

Alexandero89 commented May 20, 2025

Uh oh!

Uh oh!

umanamente commented Feb 9, 2025 •

edited

Loading