/* eslint-disable n8n-nodes-base/node-filename-against-convention */ import type { ITriggerFunctions, IBinaryData, IBinaryKeyData, ICredentialDataDecryptedObject, ICredentialsDecrypted, ICredentialTestFunctions, IDataObject, INodeCredentialTestResult, INodeExecutionData, INodeType, INodeTypeBaseDescription, INodeTypeDescription, ITriggerResponse, } from 'n8n-workflow'; import { NodeOperationError } from 'n8n-workflow'; import type { ImapSimple, ImapSimpleOptions, Message } from 'imap-simple'; import { connect as imapConnect, getParts } from 'imap-simple'; import type { Source as ParserSource } from 'mailparser'; import { simpleParser } from 'mailparser'; import isEmpty from 'lodash/isEmpty'; import find from 'lodash/find'; export async function parseRawEmail( this: ITriggerFunctions, messageEncoded: ParserSource, dataPropertyNameDownload: string, ): Promise { const responseData = await simpleParser(messageEncoded); const headers: IDataObject = {}; for (const header of responseData.headerLines) { headers[header.key] = header.line; } // @ts-ignore responseData.headers = headers; // @ts-ignore responseData.headerLines = undefined; const binaryData: IBinaryKeyData = {}; if (responseData.attachments) { for (let i = 0; i < responseData.attachments.length; i++) { const attachment = responseData.attachments[i]; binaryData[`${dataPropertyNameDownload}${i}`] = await this.helpers.prepareBinaryData( attachment.content, attachment.filename, attachment.contentType, ); } // @ts-ignore responseData.attachments = undefined; } return { json: responseData as unknown as IDataObject, binary: Object.keys(binaryData).length ? binaryData : undefined, } as INodeExecutionData; } const versionDescription: INodeTypeDescription = { displayName: 'Email Trigger (IMAP)', name: 'emailReadImap', icon: 'fa:inbox', group: ['trigger'], version: 1, description: 'Triggers the workflow when a new email is received', eventTriggerDescription: 'Waiting for you to receive an email', defaults: { name: 'Email Trigger (IMAP)', color: '#44AA22', }, triggerPanel: { header: '', executionsHelp: { inactive: "While building your workflow, click the 'listen' button, then send an email to make an event happen. This will trigger an execution, which will show up in this editor.

Once you're happy with your workflow, activate it. Then every time an email is received, the workflow will execute. These executions will show up in the executions list, but not in the editor.", active: "While building your workflow, click the 'listen' button, then send an email to make an event happen. This will trigger an execution, which will show up in this editor.

Your workflow will also execute automatically, since it's activated. Every time an email is received, this node will trigger an execution. These executions will show up in the executions list, but not in the editor.", }, activationHint: "Once you’ve finished building your workflow, activate it to have it also listen continuously (you just won’t see those executions here).", }, // eslint-disable-next-line n8n-nodes-base/node-class-description-inputs-wrong-regular-node inputs: [], outputs: ['main'], credentials: [ { name: 'imap', required: true, testedBy: 'imapConnectionTest', }, ], properties: [ { displayName: 'Mailbox Name', name: 'mailbox', type: 'string', default: 'INBOX', }, { displayName: 'Action', name: 'postProcessAction', type: 'options', options: [ { name: 'Mark as Read', value: 'read', }, { name: 'Nothing', value: 'nothing', }, ], default: 'read', description: 'What to do after the email has been received. If "nothing" gets selected it will be processed multiple times.', }, { displayName: 'Download Attachments', name: 'downloadAttachments', type: 'boolean', default: false, displayOptions: { show: { format: ['simple'], }, }, description: 'Whether attachments of emails should be downloaded. Only set if needed as it increases processing.', }, { displayName: 'Format', name: 'format', type: 'options', options: [ { name: 'RAW', value: 'raw', description: 'Returns the full email message data with body content in the raw field as a base64url encoded string; the payload field is not used', }, { name: 'Resolved', value: 'resolved', description: 'Returns the full email with all data resolved and attachments saved as binary data', }, { name: 'Simple', value: 'simple', description: 'Returns the full email; do not use if you wish to gather inline attachments', }, ], default: 'simple', description: 'The format to return the message in', }, { displayName: 'Property Prefix Name', name: 'dataPropertyAttachmentsPrefixName', type: 'string', default: 'attachment_', displayOptions: { show: { format: ['resolved'], }, }, description: 'Prefix for name of the binary property to which to write the attachments. An index starting with 0 will be added. So if name is "attachment_" the first attachment is saved to "attachment_0"', }, { displayName: 'Property Prefix Name', name: 'dataPropertyAttachmentsPrefixName', type: 'string', default: 'attachment_', displayOptions: { show: { format: ['simple'], downloadAttachments: [true], }, }, description: 'Prefix for name of the binary property to which to write the attachments. An index starting with 0 will be added. So if name is "attachment_" the first attachment is saved to "attachment_0"', }, { displayName: 'Options', name: 'options', type: 'collection', placeholder: 'Add Option', default: {}, options: [ { displayName: 'Custom Email Rules', name: 'customEmailConfig', type: 'string', default: '["UNSEEN"]', description: 'Custom email fetching rules. See node-imap\'s search function for more details.', }, { displayName: 'Ignore SSL Issues', name: 'allowUnauthorizedCerts', type: 'boolean', default: false, description: 'Whether to connect even if SSL certificate validation is not possible', }, { displayName: 'Force Reconnect', name: 'forceReconnect', type: 'number', default: 60, description: 'Sets an interval (in minutes) to force a reconnection', }, ], }, ], }; export class EmailReadImapV1 implements INodeType { description: INodeTypeDescription; constructor(baseDescription: INodeTypeBaseDescription) { this.description = { ...baseDescription, ...versionDescription, }; } methods = { credentialTest: { async imapConnectionTest( this: ICredentialTestFunctions, credential: ICredentialsDecrypted, ): Promise { const credentials = credential.data as ICredentialDataDecryptedObject; try { const config: ImapSimpleOptions = { imap: { user: credentials.user as string, password: credentials.password as string, host: credentials.host as string, port: credentials.port as number, tls: credentials.secure as boolean, authTimeout: 20000, }, }; const tlsOptions: IDataObject = {}; if (credentials.secure) { tlsOptions.servername = credentials.host as string; } if (!isEmpty(tlsOptions)) { config.imap.tlsOptions = tlsOptions; } const conn = imapConnect(config).then(async (entry) => { return entry; }); (await conn).getBoxes((_err, _boxes) => {}); } catch (error) { console.log(error); return { status: 'Error', message: error.message, }; } return { status: 'OK', message: 'Connection successful!', }; }, }, }; async trigger(this: ITriggerFunctions): Promise { const credentials = await this.getCredentials('imap'); const mailbox = this.getNodeParameter('mailbox') as string; const postProcessAction = this.getNodeParameter('postProcessAction') as string; const options = this.getNodeParameter('options', {}) as IDataObject; const staticData = this.getWorkflowStaticData('node'); this.logger.debug('Loaded static data for node "EmailReadImap"', { staticData }); let connection: ImapSimple; // Returns the email text const getText = async (parts: any[], message: Message, subtype: string) => { if (!message.attributes.struct) { return ''; } const textParts = parts.filter((part) => { return ( part.type.toUpperCase() === 'TEXT' && part.subtype.toUpperCase() === subtype.toUpperCase() ); }); if (textParts.length === 0) { return ''; } try { return await connection.getPartData(message, textParts[0]); } catch { return ''; } }; // Returns the email attachments const getAttachment = async ( imapConnection: ImapSimple, parts: any[], message: Message, ): Promise => { if (!message.attributes.struct) { return []; } // Check if the message has attachments and if so get them const attachmentParts = parts.filter((part) => { return part.disposition && part.disposition.type.toUpperCase() === 'ATTACHMENT'; }); const attachmentPromises = []; let attachmentPromise; for (const attachmentPart of attachmentParts) { attachmentPromise = imapConnection .getPartData(message, attachmentPart) .then(async (partData) => { // Return it in the format n8n expects return this.helpers.prepareBinaryData( partData as Buffer, attachmentPart.disposition.params.filename as string, ); }); attachmentPromises.push(attachmentPromise); } return Promise.all(attachmentPromises); }; // Returns all the new unseen messages const getNewEmails = async ( imapConnection: ImapSimple, searchCriteria: Array, ): Promise => { const format = this.getNodeParameter('format', 0) as string; let fetchOptions = {}; if (format === 'simple' || format === 'raw') { fetchOptions = { bodies: ['TEXT', 'HEADER'], markSeen: false, struct: true, }; } else if (format === 'resolved') { fetchOptions = { bodies: [''], markSeen: false, struct: true, }; } const results = await imapConnection.search(searchCriteria, fetchOptions); const newEmails: INodeExecutionData[] = []; let newEmail: INodeExecutionData, messageHeader, messageBody; let attachments: IBinaryData[]; let propertyName: string; // All properties get by default moved to metadata except the ones // which are defined here which get set on the top level. const topLevelProperties = ['cc', 'date', 'from', 'subject', 'to']; if (format === 'resolved') { const dataPropertyAttachmentsPrefixName = this.getNodeParameter( 'dataPropertyAttachmentsPrefixName', ) as string; for (const message of results) { if ( staticData.lastMessageUid !== undefined && message.attributes.uid <= (staticData.lastMessageUid as number) ) { continue; } if ( staticData.lastMessageUid === undefined || (staticData.lastMessageUid as number) < message.attributes.uid ) { staticData.lastMessageUid = message.attributes.uid; } const part = find(message.parts, { which: '' }); if (part === undefined) { throw new NodeOperationError(this.getNode(), 'Email part could not be parsed.'); } const parsedEmail = await parseRawEmail.call( this, part.body as Buffer, dataPropertyAttachmentsPrefixName, ); newEmails.push(parsedEmail); } } else if (format === 'simple') { const downloadAttachments = this.getNodeParameter('downloadAttachments') as boolean; let dataPropertyAttachmentsPrefixName = ''; if (downloadAttachments) { dataPropertyAttachmentsPrefixName = this.getNodeParameter( 'dataPropertyAttachmentsPrefixName', ) as string; } for (const message of results) { if ( staticData.lastMessageUid !== undefined && message.attributes.uid <= (staticData.lastMessageUid as number) ) { continue; } if ( staticData.lastMessageUid === undefined || (staticData.lastMessageUid as number) < message.attributes.uid ) { staticData.lastMessageUid = message.attributes.uid; } const parts = getParts(message.attributes.struct!); newEmail = { json: { textHtml: await getText(parts, message, 'html'), textPlain: await getText(parts, message, 'plain'), metadata: {} as IDataObject, }, }; messageHeader = message.parts.filter((part) => { return part.which === 'HEADER'; }); messageBody = messageHeader[0].body; for (propertyName of Object.keys(messageBody as IDataObject)) { if (messageBody[propertyName].length) { if (topLevelProperties.includes(propertyName)) { newEmail.json[propertyName] = messageBody[propertyName][0]; } else { (newEmail.json.metadata as IDataObject)[propertyName] = messageBody[propertyName][0]; } } } if (downloadAttachments) { // Get attachments and add them if any get found attachments = await getAttachment(imapConnection, parts, message); if (attachments.length) { newEmail.binary = {}; for (let i = 0; i < attachments.length; i++) { newEmail.binary[`${dataPropertyAttachmentsPrefixName}${i}`] = attachments[i]; } } } newEmails.push(newEmail); } } else if (format === 'raw') { for (const message of results) { if ( staticData.lastMessageUid !== undefined && message.attributes.uid <= (staticData.lastMessageUid as number) ) { continue; } if ( staticData.lastMessageUid === undefined || (staticData.lastMessageUid as number) < message.attributes.uid ) { staticData.lastMessageUid = message.attributes.uid; } const part = find(message.parts, { which: 'TEXT' }); if (part === undefined) { throw new NodeOperationError(this.getNode(), 'Email part could not be parsed.'); } // Return base64 string newEmail = { json: { raw: part.body, }, }; newEmails.push(newEmail); } } // only mark messages as seen once processing has finished if (postProcessAction === 'read') { const uidList = results.map((e) => e.attributes.uid); if (uidList.length > 0) { await imapConnection.addFlags(uidList, '\\SEEN'); } } return newEmails; }; const returnedPromise = await this.helpers.createDeferredPromise(); const establishConnection = async (): Promise => { let searchCriteria = ['UNSEEN'] as Array; if (options.customEmailConfig !== undefined) { try { searchCriteria = JSON.parse(options.customEmailConfig as string); } catch (error) { throw new NodeOperationError(this.getNode(), 'Custom email config is not valid JSON.'); } } const config: ImapSimpleOptions = { imap: { user: credentials.user as string, password: credentials.password as string, host: credentials.host as string, port: credentials.port as number, tls: credentials.secure as boolean, authTimeout: 20000, }, onmail: async () => { if (connection) { 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 * TL;DR: * - You cannot filter using ['UID', 'CURRENT ID + 1:*'] because IMAP * won't return correct results if current id + 1 does not yet exist. * - UIDs can change but this is not being treated here. * If the mailbox is recreated (lets say you remove all emails, remove * the mail box and create another with same name, UIDs will change) * - You can check if UIDs changed in the above example * by checking UIDValidity. */ this.logger.debug('Querying for new messages on node "EmailReadImap"', { searchCriteria, }); } try { const returnData = await getNewEmails(connection, searchCriteria); if (returnData.length) { this.emit([returnData]); } } catch (error) { this.logger.error('Email Read Imap node encountered an error fetching new emails', { error, }); // Wait with resolving till the returnedPromise got resolved, else n8n will be unhappy // if it receives an error before the workflow got activated await returnedPromise.promise().then(() => { this.emitError(error as Error); }); } } }, }; const tlsOptions: IDataObject = {}; if (options.allowUnauthorizedCerts === true) { tlsOptions.rejectUnauthorized = false; } if (credentials.secure) { tlsOptions.servername = credentials.host as string; } if (!isEmpty(tlsOptions)) { config.imap.tlsOptions = tlsOptions; } // Connect to the IMAP server and open the mailbox // that we get informed whenever a new email arrives return imapConnect(config).then(async (conn) => { conn.on('error', async (error) => { const errorCode = error.code.toUpperCase(); if (['ECONNRESET', 'EPIPE'].includes(errorCode as string)) { this.logger.verbose(`IMAP connection was reset (${errorCode}) - reconnecting.`, { error, }); try { connection = await establishConnection(); await connection.openBox(mailbox); return; } catch (e) { this.logger.error('IMAP reconnect did fail', { error: e }); // If something goes wrong we want to run emitError } } else { this.logger.error('Email Read Imap node encountered a connection error', { error }); this.emitError(error as Error); } }); return conn; }); }; connection = await establishConnection(); await connection.openBox(mailbox); let reconnectionInterval: NodeJS.Timeout | undefined; if (options.forceReconnect !== undefined) { reconnectionInterval = setInterval(async () => { this.logger.verbose('Forcing reconnection of IMAP node.'); connection.end(); connection = await establishConnection(); await connection.openBox(mailbox); }, (options.forceReconnect as number) * 1000 * 60); } // When workflow and so node gets set to inactive close the connectoin async function closeFunction() { if (reconnectionInterval) { clearInterval(reconnectionInterval); } connection.end(); } // Resolve returned-promise so that waiting errors can be emitted returnedPromise.resolve(); return { closeFunction, }; } }