admin/n8n-enterprise-unlocked
1
0
Fork 0
mirror of https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git synced 2025-12-17 18:12:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(Email Trigger (IMAP) Node): Limit new mails fetched (#16926)

Browse Source 
Co-authored-by: Oleg Ivaniv <me@olegivaniv.com>
Co-authored-by: Michael Kret <michael.k@radency.com>
This commit is contained in:
Elias Meire
2025-07-09 13:04:10 +02:00
committed by GitHub
parent c8b3ac6ab0
commit d1ac292709
18 changed files with 552 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
packages/nodes-base/nodes/EmailReadImap/v2/EmailReadImapV2.node.ts
View File

@@ -1,6 +1,15 @@
import type { ImapSimple, ImapSimpleOptions, Message, MessagePart } from '@n8n/imap';
import type { ICredentialsDataImap } from '@credentials/Imap.credentials';
import { isCredentialsDataImap } from '@credentials/Imap.credentials';
import type {
ImapSimple,
ImapSimpleOptions,
Message,
MessagePart,
SearchCriteria,
} from '@n8n/imap';
import { connect as imapConnect } from '@n8n/imap';
import isEmpty from 'lodash/isEmpty';
import { DateTime } from 'luxon';
import type {
ITriggerFunctions,
IBinaryData,
@@ -13,13 +22,11 @@ import type {
INodeTypeDescription,
ITriggerResponse,
JsonObject,
INodeExecutionData,
} from 'n8n-workflow';
import { NodeConnectionTypes, NodeOperationError, TriggerCloseError } from 'n8n-workflow';
import rfc2047 from 'rfc2047';
import type { ICredentialsDataImap } from '@credentials/Imap.credentials';
import { isCredentialsDataImap } from '@credentials/Imap.credentials';
import { getNewEmails } from './utils';
const versionDescription: INodeTypeDescription = {
@@ -28,7 +35,7 @@ const versionDescription: INodeTypeDescription = {
icon: 'fa:inbox',
iconColor: 'green',
group: ['trigger'],
version: 2,
version: [2, 2.1],
description: 'Triggers the workflow when a new email is received',
eventTriggerDescription: 'Waiting for you to receive an email',
defaults: {
@@ -248,6 +255,7 @@ export class EmailReadImapV2 implements INodeType {
const mailbox = this.getNodeParameter('mailbox') as string;
const postProcessAction = this.getNodeParameter('postProcessAction') as string;
const options = this.getNodeParameter('options', {}) as IDataObject;
const activatedAt = DateTime.now();
const staticData = this.getWorkflowStaticData('node');
this.logger.debug('Loaded static data for node "EmailReadImap"', { staticData });
@@ -333,12 +341,10 @@ export class EmailReadImapV2 implements INodeType {
const returnedPromise = this.helpers.createDeferredPromise();
const establishConnection = async (): Promise<ImapSimple> => {
let searchCriteria = ['UNSEEN'] as Array<string | string[]>;
let searchCriteria: SearchCriteria[] = ['UNSEEN'];
if (options.customEmailConfig !== undefined) {
try {
searchCriteria = JSON.parse(options.customEmailConfig as string) as Array<
string | string[]
>;
searchCriteria = JSON.parse(options.customEmailConfig as string) as SearchCriteria[];
} catch (error) {
throw new NodeOperationError(this.getNode(), 'Custom email config is not valid JSON.');
}
@@ -353,10 +359,21 @@ export class EmailReadImapV2 implements INodeType {
tls: credentials.secure,
authTimeout: 20000,
},
onMail: async () => {
onMail: async (numEmails) => {
this.logger.debug('New emails received in node "EmailReadImap"', {
numEmails,
});
if (connection) {
/**
* Only process new emails:
* - If we've seen emails before (lastMessageUid is set), fetch messages higher UID.
* - Otherwise, fetch emails received since the workflow activation date.
*
* Note: IMAP 'SINCE' only filters by date (not time),
* so it may include emails from earlier on the activation day.
*/
if (staticData.lastMessageUid !== undefined) {
searchCriteria.push(['UID', `${staticData.lastMessageUid as number}:*`]);
/**
* A short explanation about UIDs and how they work
* can be found here: https://dev.to/kehers/imap-new-messages-since-last-check-44gm
@@ -369,24 +386,28 @@ export class EmailReadImapV2 implements INodeType {
* - You can check if UIDs changed in the above example
* by checking UIDValidity.
*/
this.logger.debug('Querying for new messages on node "EmailReadImap"', {
searchCriteria,
});
searchCriteria.push(['UID', `${staticData.lastMessageUid as number}:*`]);
} else {
searchCriteria.push(['SINCE', activatedAt.toFormat('dd-LLL-yyyy')]);
}
this.logger.debug('Querying for new messages on node "EmailReadImap"', {
searchCriteria,
});
try {
const returnData = await getNewEmails.call(
this,
connection,
await getNewEmails.call(this, {
imapConnection: connection,
searchCriteria,
staticData,
postProcessAction,
getText,
getAttachment,
);
if (returnData.length) {
this.emit([returnData]);
}
onEmailBatch: async (returnData: INodeExecutionData[]) => {
if (returnData.length) {
this.emit([returnData]);
}
},
});
} catch (error) {
this.logger.error('Email Read Imap node encountered an error fetching new emails', {
error: error as Error,
@@ -399,7 +420,7 @@ export class EmailReadImapV2 implements INodeType {
}
}
},
onUpdate: async (seqNo: number, info) => {
onUpdate: (seqNo: number, info) => {
this.logger.debug(`Email Read Imap:update ${seqNo}`, info);
},
};
@@ -420,8 +441,8 @@ export class EmailReadImapV2 implements INodeType {
// Connect to the IMAP server and open the mailbox
// that we get informed whenever a new email arrives
return await imapConnect(config).then(async (conn) => {
conn.on('close', async (_hadError: boolean) => {
return await imapConnect(config).then((conn) => {
conn.on('close', (_hadError: boolean) => {
if (isCurrentlyReconnecting) {
this.logger.debug('Email Read Imap: Connected closed for forced reconnecting');
} else if (closeFunctionWasCalled) {
@@ -431,7 +452,7 @@ export class EmailReadImapV2 implements INodeType {
this.emitError(new Error('Imap connection closed unexpectedly'));
}
});
conn.on('error', async (error) => {
conn.on('error', (error) => {
const errorCode = ((error as JsonObject).code as string).toUpperCase();
this.logger.debug(`IMAP connection experienced an error: (${errorCode})`, {
error: error as Error,