The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix: handle unavailable IMAP mailboxes (#24141)
neo773783469980ce1
diff --git a/packages/twenty-server/src/modules/messaging/message-folder-manager/drivers/imap/services/imap-get-all-folders.service.ts b/packages/twenty-server/src/modules/messaging/message-folder-manager/drivers/imap/services/imap-get-all-folders.service.tsindex 26719e3917a..352f03d90b9 100644--- a/packages/twenty-server/src/modules/messaging/message-folder-manager/drivers/imap/services/imap-get-all-folders.service.ts+++ b/packages/twenty-server/src/modules/messaging/message-folder-manager/drivers/imap/services/imap-get-all-folders.service.ts@@ -5,6 +5,7 @@ import { isDefined } from 'twenty-shared/utils';import {DiscoveredMessageFolder,+ type MessageFolder,MessageFolderDriver,} from 'src/modules/messaging/message-folder-manager/interfaces/message-folder-driver.interface';@@ -15,6 +16,7 @@ import { shouldSyncFolderByDefault } from 'src/modules/messaging/message-folder-import { ImapClientProvider } from 'src/modules/messaging/message-import-manager/drivers/imap/providers/imap-client.provider';import { ImapFindSentFolderService } from 'src/modules/messaging/message-import-manager/drivers/imap/services/imap-find-sent-folder.service';import { getImapFolderPath } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/get-imap-folder-path.util';+import { normalizeImapUnicode } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/normalize-imap-unicode.util';import { getStandardFolderByRegex } from 'src/modules/messaging/message-import-manager/drivers/utils/get-standard-folder-by-regex';@Injectable()@@ -32,6 +34,7 @@ export class ImapGetAllFoldersService implements MessageFolderDriver {'id' | 'provider' | 'connectionParameters' | 'handle' | 'workspaceId'>,messageChannel: Pick<MessageChannelEntity, 'messageFolderImportPolicy'>,+ existingFolders: MessageFolder[],): Promise<DiscoveredMessageFolder[]> {try {const client = await this.imapClientProvider.getClient(@@ -44,6 +47,7 @@ export class ImapGetAllFoldersService implements MessageFolderDriver {client,mailboxList,messageChannel,+ existingFolders,);await this.imapClientProvider.closeClient(client);@@ -63,40 +67,67 @@ export class ImapGetAllFoldersService implements MessageFolderDriver {client: ImapFlow,mailboxList: ListResponse[],messageChannel: Pick<MessageChannelEntity, 'messageFolderImportPolicy'>,+ existingFolders: MessageFolder[],): Promise<DiscoveredMessageFolder[]> {+ const normalizedMailboxList = mailboxList.map((mailbox) => ({+ ...mailbox,+ path: normalizeImapUnicode(mailbox.path, client),+ name: normalizeImapUnicode(mailbox.name, client),+ parentPath: mailbox.parentPath+ ? normalizeImapUnicode(mailbox.parentPath, client)+ : mailbox.parentPath,+ }));+ const existingExternalIdsByNormalizedId = new Map<string, string>();++ for (const folder of existingFolders) {+ if (isDefined(folder.externalId)) {+ existingExternalIdsByNormalizedId.set(+ normalizeImapUnicode(folder.externalId, client),+ folder.externalId,+ );+ }+ }+const folders: DiscoveredMessageFolder[] = [];const pathToExternalIdMap = new Map<string, string>();const sentFolder =await this.imapFindSentFolderService.findSentFolder(client);+ const sentFolderPath = isDefined(sentFolder)+ ? normalizeImapUnicode(sentFolder.path, client)+ : undefined;const sentMailbox = isDefined(sentFolder)- ? mailboxList.find((mailbox) => mailbox.path === sentFolder.path)+ ? normalizedMailboxList.find((mailbox) => mailbox.path === sentFolderPath): undefined;if (isDefined(sentFolder) &&+ isDefined(sentFolderPath) &&isDefined(sentMailbox) &&this.isMailboxSelectable(sentMailbox)) {const uidValidity = await this.getUidValidity(client, sentMailbox);- const externalId = uidValidity- ? `${sentFolder.path}:${uidValidity.toString()}`- : sentFolder.path;+ const normalizedExternalId = uidValidity+ ? `${sentFolderPath}:${uidValidity.toString()}`+ : sentFolderPath;+ const externalId =+ existingExternalIdsByNormalizedId.get(normalizedExternalId) ??+ normalizedExternalId;- pathToExternalIdMap.set(sentFolder.path, externalId);+ pathToExternalIdMap.set(sentFolderPath, externalId);folders.push({externalId,- name: sentFolder.name,+ name: sentMailbox.name,isSynced: true,isSentFolder: true,parentFolderId: sentMailbox?.parentPath || null,});}- for (const mailbox of mailboxList) {- if (!this.isValidMailbox(mailbox, folders)) {+ for (const mailbox of normalizedMailboxList) {+ if (!this.isValidMailbox(client, mailbox, folders)) {if (!pathToExternalIdMap.has(mailbox.path)) {pathToExternalIdMap.set(mailbox.path, mailbox.path);}@@ -104,9 +135,12 @@ export class ImapGetAllFoldersService implements MessageFolderDriver {}const uidValidity = await this.getUidValidity(client, mailbox);- const externalId = uidValidity+ const normalizedExternalId = uidValidity? `${mailbox.path}:${uidValidity}`: mailbox.path;+ const externalId =+ existingExternalIdsByNormalizedId.get(normalizedExternalId) ??+ normalizedExternalId;pathToExternalIdMap.set(mailbox.path, externalId);@@ -159,6 +193,7 @@ export class ImapGetAllFoldersService implements MessageFolderDriver {}private isValidMailbox(+ client: ImapFlow,mailbox: ListResponse,existingFolders: DiscoveredMessageFolder[],): boolean {@@ -167,7 +202,7 @@ export class ImapGetAllFoldersService implements MessageFolderDriver {}const isDuplicate = existingFolders.some(- (folder) => getImapFolderPath(folder?.externalId) === mailbox.path,+ (folder) => getImapFolderPath(folder.externalId, client) === mailbox.path,);return !isDuplicate;diff --git a/packages/twenty-server/src/modules/messaging/message-folder-manager/interfaces/message-folder-driver.interface.ts b/packages/twenty-server/src/modules/messaging/message-folder-manager/interfaces/message-folder-driver.interface.tsindex 1f485e3bbba..c11775dc07c 100644--- a/packages/twenty-server/src/modules/messaging/message-folder-manager/interfaces/message-folder-driver.interface.ts+++ b/packages/twenty-server/src/modules/messaging/message-folder-manager/interfaces/message-folder-driver.interface.ts@@ -32,5 +32,6 @@ export type MessageFolderDriver = {| 'workspaceId'>,messageChannel: Pick<MessageChannelEntity, 'messageFolderImportPolicy'>,+ existingFolders: MessageFolder[],): Promise<DiscoveredMessageFolder[]>;};diff --git a/packages/twenty-server/src/modules/messaging/message-folder-manager/services/sync-message-folders.service.ts b/packages/twenty-server/src/modules/messaging/message-folder-manager/services/sync-message-folders.service.tsindex c7753f45b9a..7a6b7849c69 100644--- a/packages/twenty-server/src/modules/messaging/message-folder-manager/services/sync-message-folders.service.ts+++ b/packages/twenty-server/src/modules/messaging/message-folder-manager/services/sync-message-folders.service.ts@@ -62,6 +62,7 @@ export class SyncMessageFoldersService {const discoveredFolders = await this.discoverAllFolders(messageChannel.connectedAccount,messageChannel,+ messageChannel.messageFolders,);const { messageFolders: existingFolders, id: messageChannelId } =@@ -87,6 +88,7 @@ export class SyncMessageFoldersService {| 'workspaceId'>,messageChannel: Pick<MessageChannelEntity, 'messageFolderImportPolicy'>,+ existingFolders: MessageFolder[],): Promise<DiscoveredMessageFolder[]> {switch (connectedAccount.provider) {case ConnectedAccountProvider.GOOGLE:@@ -103,6 +105,7 @@ export class SyncMessageFoldersService {return this.imapGetAllFoldersService.getAllMessageFolders(connectedAccount,messageChannel,+ existingFolders,);default:throw new Error(diff --git a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/services/imap-get-message-list.service.ts b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/services/imap-get-message-list.service.tsindex 75cd138cfb6..dec96e48838 100644--- a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/services/imap-get-message-list.service.ts+++ b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/services/imap-get-message-list.service.ts@@ -16,6 +16,8 @@ import { ImapSyncService } from 'src/modules/messaging/message-import-manager/drimport { createSyncCursor } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/create-sync-cursor.util';import { resolveMailboxState } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/extract-mailbox-state.util';import { getImapFolderPath } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/get-imap-folder-path.util';+import { isImapMailboxNotFoundError } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/is-imap-mailbox-not-found-error.util';+import { normalizeImapUnicode } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/normalize-imap-unicode.util';import { parseSyncCursor } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/parse-sync-cursor.util';import { type GetMessageListsArgs } from 'src/modules/messaging/message-import-manager/types/get-message-lists-args.type';import {@@ -58,9 +60,20 @@ export class ImapGetMessageListService {const results: GetMessageListsResponse = [];for (const folder of foldersToProcess) {- const response = await this.getMessageList(client, folder);-- results.push({ ...response, folderId: folder.id });+ try {+ const response = await this.getMessageList(client, folder);++ results.push({ ...response, folderId: folder.id });+ } catch (error) {+ if (isImapMailboxNotFoundError(error)) {+ this.logger.warn(+ `Skipping unavailable mailbox for folder ${folder.name}`,+ );+ continue;+ }++ throw error;+ }}return results;@@ -79,15 +92,17 @@ export class ImapGetMessageListService {client: ImapFlow,folder: MessageFolder,): Promise<GetOneMessageListResponse> {- const folderPath = getImapFolderPath(folder.externalId);+ const messageExternalIdPrefix = getImapFolderPath(folder.externalId);- if (!isDefined(folderPath)) {+ if (!isDefined(messageExternalIdPrefix)) {throw new MessageImportDriverException(`Folder ${folder.name} has no path`,MessageImportDriverExceptionCode.NOT_FOUND,);}+ const folderPath = normalizeImapUnicode(messageExternalIdPrefix, client);+if (await this.canSkipFolderSync(client, folder)) {this.logger.log(`Skipping folder ${folder.name}: no new messages`);@@ -137,7 +152,7 @@ export class ImapGetMessageListService {const messageExternalIds = messageUids.sort((a, b) => b - a)- .map((uid) => `${folderPath}:${uid}`);+ .map((uid) => `${messageExternalIdPrefix}:${uid}`);return {messageExternalIds,@@ -147,6 +162,10 @@ export class ImapGetMessageListService {folderId: folder.id,};} catch (error) {+ if (isImapMailboxNotFoundError(error)) {+ throw error;+ }+this.logger.error(`Error syncing folder ${folder.name}: ${error.message}`,);@@ -161,7 +180,7 @@ export class ImapGetMessageListService {client: ImapFlow,folder: MessageFolder,): Promise<boolean> {- const folderPath = getImapFolderPath(folder.externalId);+ const folderPath = getImapFolderPath(folder.externalId, client);const previousCursor = parseSyncCursor(folder.syncCursor);if (!isDefined(folderPath) || !isDefined(previousCursor)) {diff --git a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/types/imap-error.type.ts b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/types/imap-error.type.tsindex 2d421dffc5b..79e9e830d7e 100644--- a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/types/imap-error.type.ts+++ b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/types/imap-error.type.ts@@ -6,6 +6,7 @@ export interface ImapFlowError extends Error {executedCommand?: string;authenticationFailed?: boolean;response?: string;+ mailboxMissing?: boolean;syscall?: string;errno?: number;}diff --git a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/get-imap-folder-path.util.ts b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/get-imap-folder-path.util.tsindex a780022c5af..f4e008376d6 100644--- a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/get-imap-folder-path.util.ts+++ b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/get-imap-folder-path.util.ts@@ -1,7 +1,11 @@import { isNonEmptyString } from '@sniptt/guards';+import { type ImapFlow } from 'imapflow';++import { normalizeImapUnicode } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/normalize-imap-unicode.util';export const getImapFolderPath = (externalId: string | null | undefined,+ client?: Pick<ImapFlow, 'enabled'>,): string | null => {if (!isNonEmptyString(externalId)) {return null;@@ -10,14 +14,14 @@ export const getImapFolderPath = (const lastColonIndex = externalId.lastIndexOf(':');if (lastColonIndex === -1) {- return externalId;+ return normalizeImapUnicode(externalId, client);}- const trailingSegment = externalId.slice(lastColonIndex + 1);+ const suffix = externalId.slice(lastColonIndex + 1);- if (!/^\d+$/.test(trailingSegment)) {- return externalId;+ if (!/^\d+$/.test(suffix)) {+ return normalizeImapUnicode(externalId, client);}- return externalId.slice(0, lastColonIndex);+ return normalizeImapUnicode(externalId.slice(0, lastColonIndex), client);};diff --git a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/is-imap-flow-error.util.ts b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/is-imap-flow-error.util.tsindex f9f1c8d9bb0..8f19468b724 100644--- a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/is-imap-flow-error.util.ts+++ b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/is-imap-flow-error.util.ts@@ -6,6 +6,7 @@ export const isImapFlowError = (error: Error): error is ImapFlowError => {return (isDefined(error) &&('serverResponseCode' in error ||+ 'responseStatus' in error ||'responseText' in error ||'executedCommand' in error ||'authenticationFailed' in error)diff --git a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/is-imap-mailbox-not-found-error.util.ts b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/is-imap-mailbox-not-found-error.util.tsnew file mode 100644index 00000000000..520b32cd405--- /dev/null+++ b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/is-imap-mailbox-not-found-error.util.ts@@ -0,0 +1,21 @@+import { isImapFlowError } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/is-imap-flow-error.util';+import { MISSING_MAILBOX_MESSAGE_PREFIXES } from 'src/modules/messaging/message-import-manager/drivers/imap/utils/missing-mailbox-message-prefixes.const';++export const isImapMailboxNotFoundError = (error: Error): boolean => {+ if (!isImapFlowError(error) || error.responseStatus !== 'NO') {+ return false;+ }++ if (+ error.serverResponseCode?.toUpperCase() === 'NONEXISTENT' ||+ error.mailboxMissing+ ) {+ return true;+ }++ const responseText = error.responseText?.toLowerCase();++ return MISSING_MAILBOX_MESSAGE_PREFIXES.some((prefix) =>+ responseText?.startsWith(prefix),+ );+};diff --git a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/missing-mailbox-message-prefixes.const.ts b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/missing-mailbox-message-prefixes.const.tsnew file mode 100644index 00000000000..0c94f3cfb75--- /dev/null+++ b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/missing-mailbox-message-prefixes.const.ts@@ -0,0 +1,6 @@+export const MISSING_MAILBOX_MESSAGE_PREFIXES = [+ 'mailbox does not exist',+ "mailbox doesn't exist",+ 'unknown mailbox:',+ 'no such mailbox',+];diff --git a/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/normalize-imap-unicode.util.ts b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/normalize-imap-unicode.util.tsnew file mode 100644index 00000000000..5521f1661c0--- /dev/null+++ b/packages/twenty-server/src/modules/messaging/message-import-manager/drivers/imap/utils/normalize-imap-unicode.util.ts@@ -0,0 +1,7 @@+import { type ImapFlow } from 'imapflow';++export const normalizeImapUnicode = (+ value: string,+ client?: Pick<ImapFlow, 'enabled'>,+): string =>+ client?.enabled.has('UTF8=ACCEPT') ? value.normalize('NFC') : value;diff --git a/packages/twenty-server/src/modules/messaging/message-outbound-manager/drivers/imap/services/imap-smtp-message-outbound.service.ts b/packages/twenty-server/src/modules/messaging/message-outbound-manager/drivers/imap/services/imap-smtp-message-outbound.service.tsindex 697b5c5df24..1532e7d60fb 100644--- a/packages/twenty-server/src/modules/messaging/message-outbound-manager/drivers/imap/services/imap-smtp-message-outbound.service.ts+++ b/packages/twenty-server/src/modules/messaging/message-outbound-manager/drivers/imap/services/imap-smtp-message-outbound.service.ts@@ -85,7 +85,10 @@ export class ImapSmtpMessageOutboundService implements MessageOutboundDriver {});}- const sentFolderPath = getImapFolderPath(sentFolder?.externalId);+ const sentFolderPath = getImapFolderPath(+ sentFolder?.externalId,+ imapClient,+ );if (isDefined(sentFolderPath)) {await imapClient.append(sentFolderPath, messageBuffer);diff --git a/packages/twenty-server/src/modules/onboarding-recent-messages-import/services/imap-recent-messages.service.ts b/packages/twenty-server/src/modules/onboarding-recent-messages-import/services/imap-recent-messages.service.tsindex 39ddab1ba38..af1399c23fb 100644--- a/packages/twenty-server/src/modules/onboarding-recent-messages-import/services/imap-recent-messages.service.ts+++ b/packages/twenty-server/src/modules/onboarding-recent-messages-import/services/imap-recent-messages.service.ts@@ -59,7 +59,7 @@ export class ImapRecentMessagesService {messageFolder: MessageFolder;maxCount: number;}): Promise<string[]> {- const folderPath = getImapFolderPath(messageFolder.externalId);+ const folderPath = getImapFolderPath(messageFolder.externalId, imapClient);if (!isDefined(folderPath)) {return [];