Files
webmail/lib/unified-mailbox.ts
T
Linus Rath cf2c27157d Merge branch 'main' into feat/stalwart-1.0
# Conflicts:
#	components/contacts/contacts-app.tsx
#	components/email/__tests__/composer-discard.test.tsx
#	components/email/calendar-invitation-banner.tsx
#	components/email/email-composer.tsx
#	components/mail/mail-app.tsx
#	components/pro/pro-compose-tab-body.tsx
#	components/pro/pro-email-tab-body.tsx
#	components/ui/__tests__/avatar.test.tsx
#	components/ui/avatar.tsx
#	hooks/use-mailbox-drop.ts
#	lib/__tests__/calendar-alerts.test.ts
#	lib/__tests__/jmap-calendar-tasks.test.ts
#	lib/__tests__/jmap-send-threading.test.ts
#	lib/demo/demo-client.ts
#	lib/demo/fixtures/calendars.ts
#	lib/jmap/client-interface.ts
#	lib/jmap/client.ts
#	lib/web-push.ts
#	stores/__tests__/contact-store.test.ts
#	stores/__tests__/email-store-thread-key.test.ts
#	stores/calendar-store.ts
#	stores/contact-store.ts
#	stores/email-store.ts
2026-10-26 10:14:12 +01:00

838 lines
32 KiB
TypeScript

import type { Email, Mailbox, UnifiedMailboxRole, CrossView } from '@/lib/jmap/types';
import { CROSS_EXCLUDED_ROLES } from '@/lib/jmap/types';
import type { IJMAPClient, SearchEmailsResult, SearchRequestOptions } from '@/lib/jmap/client-interface';
import type { DeferredSnippetBatch } from '@/lib/search-snippet';
import { andFilters, textConditions, textFilter } from '@/lib/jmap/search-utils';
import { compareEmails, type SortLevel } from '@/lib/message-list-order';
export interface UnifiedAccountClient {
// Display reference (avatar color / label). For personal entries this is the
// AccountEntry.id; for shared entries it is the JMAP owner id (see Email.accountId).
accountId: string;
accountLabel: string;
client: IJMAPClient;
mailboxes: Mailbox[];
// AccountEntry.id of the logged-in client this entry uses (`getClientForAccount`
// key). Stamped onto each email as `sourceClientAccountId` so single-email and
// batch actions can resolve the reaching client without scanning capabilities.
clientAccountId: string;
// JMAP account id of the data this entry reads (personal: the client's primary;
// shared: the owner id). Stamped onto each email as `sourceAccountId` and passed
// as the JMAP `accountId` for owner-scoped routing + mailbox-id namespacing.
jmapAccountId: string;
// When true, this entry represents a group/shared account owned by
// `accountId` but accessed through someone else's `client`. JMAP requests
// must use the mailbox's `originalId` and explicitly target this accountId
// so the server routes to the owner's data.
isShared?: boolean;
// Store-side mailbox ids that make up THIS account's contribution to the
// cross views (All mail / Unread / Starred). It is intentionally per-account,
// not a global list: mailbox ids are account-scoped, so an id from one account
// is meaningless in another. The effective folder set of a cross view is the
// UNION across every account's entry (one UnifiedAccountClient per account),
// i.e. the sum of the respective per-account selections.
//
// For personal accounts this is the user's folder selection
// (`allMailFolderIds[accountId]`); shared/group accounts are not individually
// configurable and leave this undefined. When undefined, getCrossIncludedMailboxes
// falls back to the role-exclusion default (inbox + custom folders).
crossIncludedMailboxIds?: string[];
}
export interface UnifiedFetchResult {
emails: Email[];
total: number;
hasMore: boolean;
errors: Map<string, string>; // accountId -> error message
/** Deferred search snippets per account (see SearchRequestOptions.deferSnippets). */
snippets?: Promise<DeferredSnippetBatch[]>;
}
export interface UnifiedMailboxCounts {
role: UnifiedMailboxRole;
unreadEmails: number;
totalEmails: number;
}
const ALL_UNIFIED_ROLES: UnifiedMailboxRole[] = [
'inbox', 'sent', 'drafts', 'trash', 'archive', 'junk',
];
/**
* Resolves the display name of the folder an email lives in, for the aggregate
* "All …" views. Matches the email's mailbox membership against the account's
* mailbox list (originalId for shared/namespaced mailboxes). Returns the first
* match, or undefined if none of the account's known folders contain it.
*/
export function resolveSourceFolderName(email: Email, mailboxes: Mailbox[]): string | undefined {
for (const m of mailboxes) {
// All fetch paths now namespace shared emails' mailboxIds to the store id
// (`${ownerId}:${origId}`), so matching `m.id` works for own and shared
// alike. The `originalId` check stays as a defensive fallback for any email
// that still carries a bare owner id. (#281 V3)
if (email.mailboxIds?.[m.id]) return m.name;
if (m.originalId && email.mailboxIds?.[m.originalId]) return m.name;
}
return undefined;
}
/**
* Finds the first mailbox matching the given role.
*/
export function findMailboxByRole(
mailboxes: Mailbox[],
role: UnifiedMailboxRole,
): Mailbox | undefined {
return mailboxes.find((m) => m.role === role);
}
/** The id a JMAP request names this entry's mailbox by (the owner's raw id for shared entries). */
export function jmapMailboxIdOf(account: UnifiedAccountClient, mailbox: Mailbox): string {
return account.isShared ? (mailbox.originalId ?? mailbox.id) : mailbox.id;
}
/**
* The condition that leaves an account's Trash and Junk out of a folder-less
* search, or null when the account has neither folder.
*/
export function trashAndJunkExclusion(account: UnifiedAccountClient): Record<string, unknown> | null {
const ids = trashAndJunkIds(account);
return ids.length > 0 ? { inMailboxOtherThan: ids } : null;
}
/** The JMAP ids of an account's Trash and Junk folders (those it has). */
export function trashAndJunkIds(account: UnifiedAccountClient): string[] {
return (['trash', 'junk'] as const)
.map((role) => findMailboxByRole(account.mailboxes, role))
.filter((mailbox): mailbox is Mailbox => Boolean(mailbox))
.map((mailbox) => jmapMailboxIdOf(account, mailbox));
}
/**
* Where each account's next page starts. The merged list interleaves the
* accounts, so its length is no single account's position: passing it made
* every account skip the rows between its own count and the merged length.
* A map gives each account the number of its rows already shown (see
* positionsByAccount); a plain number still means the same for all.
*/
export type FanOutPosition = number | Readonly<Record<string, number>>;
function positionFor(position: FanOutPosition, account: UnifiedAccountClient): number {
return typeof position === 'number' ? position : (position[account.accountId] ?? 0);
}
/** Per-account positions for the next page of a merged list. */
export function positionsByAccount(emails: readonly Email[]): Record<string, number> {
const positions: Record<string, number> = {};
for (const email of emails) {
if (email.accountId) positions[email.accountId] = (positions[email.accountId] ?? 0) + 1;
}
return positions;
}
/**
* Fetches emails from all accounts for a given unified role, merges and sorts
* them by receivedAt descending. Per-account failures are collected in the
* errors map while successful results are still returned.
*/
export async function fetchUnifiedEmails(
accounts: UnifiedAccountClient[],
role: UnifiedMailboxRole,
limit: number,
position: FanOutPosition,
order: SortLevel[] = [],
): Promise<UnifiedFetchResult> {
const errors = new Map<string, string>();
// Build one fetch task per account, wrapping each in a catch so we can
// track per-account errors while still using Promise.allSettled.
type AccountResult = {
account: UnifiedAccountClient;
result: { emails: Email[]; total: number; hasMore: boolean };
} | null;
const promises = accounts.map(
async (account): Promise<AccountResult> => {
const mailbox = findMailboxByRole(account.mailboxes, role);
if (!mailbox) return null;
const { jmapMailboxId, jmapAccountId } = resolveJmapTarget(account, mailbox);
try {
// The configured list order (#718) rides along only when set, so the
// default call shape stays the four-argument one.
const result = order.length > 0
? await account.client.getEmails(jmapMailboxId, jmapAccountId, limit, positionFor(position, account), undefined, undefined, undefined, order)
: await account.client.getEmails(jmapMailboxId, jmapAccountId, limit, positionFor(position, account));
return { account, result };
} catch (err) {
errors.set(
account.accountId,
err instanceof Error ? err.message : String(err),
);
return null;
}
},
);
const results = await Promise.allSettled(promises);
let mergedEmails: Email[] = [];
let totalSum = 0;
let anyHasMore = false;
for (const outcome of results) {
if (outcome.status !== 'fulfilled' || outcome.value === null) continue;
const { account, result } = outcome.value;
// Decorate each email with the source account info. The per-account client
// returns shared object references; decorate shallow copies instead of
// mutating them in place so retained callers/snapshots aren't corrupted.
const decorated = result.emails.map((email) => ({
...email,
accountId: account.accountId,
accountLabel: account.accountLabel,
sourceClientAccountId: account.clientAccountId,
sourceAccountId: account.jmapAccountId,
sourceFolder: resolveSourceFolderName(email, account.mailboxes),
}));
mergedEmails = mergedEmails.concat(decorated);
totalSum += result.total;
if (result.hasMore) {
anyHasMore = true;
}
}
// Merge the per-account pages under the same order each server applied
// (receivedAt descending by default).
mergedEmails.sort(compareEmails(order));
return {
emails: mergedEmails,
total: totalSum,
hasMore: anyHasMore,
errors,
};
}
/**
* Runs a text search across every account that has a mailbox for the given
* unified role, merging and sorting the results by receivedAt descending. The
* fan-out / error-collection shape mirrors `fetchUnifiedEmails` so the caller
* sees consistent behavior between browse and search.
*/
export async function searchUnifiedEmails(
accounts: UnifiedAccountClient[],
role: UnifiedMailboxRole,
query: string,
limit: number,
position: FanOutPosition,
): Promise<UnifiedFetchResult> {
return fanOutUnifiedQuery(accounts, role, async (account, mailbox) => {
const { jmapMailboxId, jmapAccountId } = resolveJmapTarget(account, mailbox);
return account.client.searchEmails(query, jmapMailboxId, jmapAccountId, limit, positionFor(position, account));
});
}
/**
* Like `searchUnifiedEmails`, but uses the JMAP advanced filter shape. The
* caller supplies a `filterFor(mailboxId)` factory because each account's role
* mailbox has a different id and the filter must include the right
* `inMailbox` clause per request.
*/
export async function advancedSearchUnifiedEmails(
accounts: UnifiedAccountClient[],
role: UnifiedMailboxRole,
filterFor: (mailboxId: string) => Record<string, unknown>,
limit: number,
position: FanOutPosition,
): Promise<UnifiedFetchResult> {
return fanOutUnifiedQuery(accounts, role, async (account, mailbox) => {
const { jmapMailboxId, jmapAccountId } = resolveJmapTarget(account, mailbox);
return account.client.advancedSearchEmails(filterFor(jmapMailboxId), jmapAccountId, limit, positionFor(position, account));
});
}
/**
* Resolves the JMAP-side mailbox id and accountId for a mailbox living inside
* a UnifiedAccountClient. For personal-account entries we use the JMAP id as
* returned by the primary client; for shared-owner entries the mailbox id is
* namespaced (`${ownerId}:${origId}`) so we must use `originalId` and pass the
* owner's accountId through the request.
*/
function resolveJmapTarget(
account: UnifiedAccountClient,
mailbox: Mailbox,
): { jmapMailboxId: string; jmapAccountId: string | undefined } {
if (account.isShared) {
return {
jmapMailboxId: mailbox.originalId ?? mailbox.id,
jmapAccountId: account.accountId,
};
}
return { jmapMailboxId: mailbox.id, jmapAccountId: undefined };
}
async function fanOutUnifiedQuery(
accounts: UnifiedAccountClient[],
role: UnifiedMailboxRole,
run: (
account: UnifiedAccountClient,
mailbox: Mailbox,
) => Promise<{ emails: Email[]; total: number; hasMore: boolean }>,
): Promise<UnifiedFetchResult> {
const errors = new Map<string, string>();
type AccountResult = {
account: UnifiedAccountClient;
result: { emails: Email[]; total: number; hasMore: boolean };
} | null;
const promises = accounts.map(async (account): Promise<AccountResult> => {
const mailbox = findMailboxByRole(account.mailboxes, role);
if (!mailbox) return null;
try {
const result = await run(account, mailbox);
return { account, result };
} catch (err) {
errors.set(
account.accountId,
err instanceof Error ? err.message : String(err),
);
return null;
}
});
const results = await Promise.allSettled(promises);
let mergedEmails: Email[] = [];
let totalSum = 0;
let anyHasMore = false;
for (const outcome of results) {
if (outcome.status !== 'fulfilled' || outcome.value === null) continue;
const { account, result } = outcome.value;
// Decorate shallow copies, not the shared client-returned objects.
const decorated = result.emails.map((email) => ({
...email,
accountId: account.accountId,
accountLabel: account.accountLabel,
sourceClientAccountId: account.clientAccountId,
sourceAccountId: account.jmapAccountId,
sourceFolder: resolveSourceFolderName(email, account.mailboxes),
}));
mergedEmails = mergedEmails.concat(decorated);
totalSum += result.total;
if (result.hasMore) anyHasMore = true;
}
mergedEmails.sort((a, b) => {
const dateA = new Date(a.receivedAt).getTime();
const dateB = new Date(b.receivedAt).getTime();
return dateB - dateA;
});
return { emails: mergedEmails, total: totalSum, hasMore: anyHasMore, errors };
}
/**
* Aggregates unread and total email counts across all accounts for each
* unified mailbox role. Only includes roles that exist in at least one account.
*/
export function fetchUnifiedMailboxCounts(
accounts: UnifiedAccountClient[],
): UnifiedMailboxCounts[] {
const counts: UnifiedMailboxCounts[] = [];
for (const role of ALL_UNIFIED_ROLES) {
let unreadEmails = 0;
let totalEmails = 0;
let found = false;
for (const account of accounts) {
const mailbox = findMailboxByRole(account.mailboxes, role);
if (mailbox) {
found = true;
unreadEmails += mailbox.unreadEmails;
totalEmails += mailbox.totalEmails;
}
}
if (found) {
counts.push({ role, unreadEmails, totalEmails });
}
}
return counts;
}
// ─── Cross-account views (unread / starred / all) ─────────────────────────────
//
// These merge messages across EVERY account (including shared) and across all
// folders except the CROSS_EXCLUDED_ROLES (junk, sent, archive, trash, drafts, all),
// i.e. inbox + custom folders, into one date-sorted list. Unlike the per-role
// unified fan-out above, the query spans many mailboxes per account, so the
// filter is built from each account's included-mailbox ids.
/**
* Mailboxes of an account included in the cross views (All mail / Unread /
* Starred). When the account carries an explicit `crossIncludedMailboxIds`
* selection (personal accounts honor the user's folder picker, shared accounts
* include everything), only those mailboxes are used. Otherwise it falls back
* to the role-exclusion default: everything whose role is not excluded (inbox +
* custom/no-role folders).
*/
export function getCrossIncludedMailboxes(account: UnifiedAccountClient): Mailbox[] {
if (account.crossIncludedMailboxIds) {
const selected = new Set(account.crossIncludedMailboxIds);
return account.mailboxes.filter((m) => selected.has(m.id));
}
return account.mailboxes.filter((m) => !CROSS_EXCLUDED_ROLES.has(m.role ?? ''));
}
/**
* Builds the JMAP Email/query filter for a cross-account view over the given
* JMAP-side mailbox ids. `all` is just the mailbox membership; `unread` and
* `starred` AND a keyword condition onto it.
*/
export function buildCrossFilter(
view: CrossView,
jmapMailboxIds: string[],
): Record<string, unknown> {
const inAny: Record<string, unknown> = jmapMailboxIds.length === 1
? { inMailbox: jmapMailboxIds[0] }
: { operator: 'OR', conditions: jmapMailboxIds.map((id) => ({ inMailbox: id })) };
if (view === 'all') return inAny;
const keyword = view === 'unread' ? { notKeyword: '$seen' } : { hasKeyword: '$flagged' };
return { operator: 'AND', conditions: [inAny, keyword] };
}
/**
* Total unread count across every account's included cross-view mailboxes. Used
* for the unread badge on the "All unread" and "All mail" entries. Mirrors the
* unified count behaviour (sum of per-mailbox unread metadata, no extra query).
*/
export function getCrossUnreadTotal(accounts: UnifiedAccountClient[]): number {
let unread = 0;
for (const account of accounts) {
for (const m of getCrossIncludedMailboxes(account)) unread += m.unreadEmails;
}
return unread;
}
async function fanOutCrossQuery(
accounts: UnifiedAccountClient[],
run: (
account: UnifiedAccountClient,
jmapAccountId: string | undefined,
includedJmapIds: string[],
) => Promise<{ emails: Email[]; total: number; hasMore: boolean }>,
): Promise<UnifiedFetchResult> {
const errors = new Map<string, string>();
type AccountResult = {
account: UnifiedAccountClient;
result: { emails: Email[]; total: number; hasMore: boolean };
} | null;
const promises = accounts.map(async (account): Promise<AccountResult> => {
const included = getCrossIncludedMailboxes(account);
if (included.length === 0) return null;
const jmapAccountId = account.isShared ? account.accountId : undefined;
const includedJmapIds = included.map((m) => account.isShared ? (m.originalId ?? m.id) : m.id);
try {
const result = await run(account, jmapAccountId, includedJmapIds);
return { account, result };
} catch (err) {
errors.set(account.accountId, err instanceof Error ? err.message : String(err));
return null;
}
});
const results = await Promise.allSettled(promises);
let mergedEmails: Email[] = [];
let totalSum = 0;
let anyHasMore = false;
for (const outcome of results) {
if (outcome.status !== 'fulfilled' || outcome.value === null) continue;
const { account, result } = outcome.value;
// Decorate shallow copies, not the shared client-returned objects.
const decorated = result.emails.map((email) => ({
...email,
accountId: account.accountId,
accountLabel: account.accountLabel,
sourceClientAccountId: account.clientAccountId,
sourceAccountId: account.jmapAccountId,
sourceFolder: resolveSourceFolderName(email, account.mailboxes),
}));
mergedEmails = mergedEmails.concat(decorated);
totalSum += result.total;
if (result.hasMore) anyHasMore = true;
}
mergedEmails.sort((a, b) => {
const dateA = new Date(a.receivedAt).getTime();
const dateB = new Date(b.receivedAt).getTime();
return dateB - dateA;
});
return { emails: mergedEmails, total: totalSum, hasMore: anyHasMore, errors };
}
/**
* Fetches a cross-account view (browse), merging and date-sorting across all
* accounts. Per-account failures are collected in the errors map.
*/
export async function fetchCrossViewEmails(
accounts: UnifiedAccountClient[],
view: CrossView,
limit: number,
position: FanOutPosition,
): Promise<UnifiedFetchResult> {
return fanOutCrossQuery(accounts, (account, jmapAccountId, ids) =>
account.client.advancedSearchEmails(buildCrossFilter(view, ids), jmapAccountId, limit, positionFor(position, account)));
}
/**
* Text search within a cross-account view: the view filter AND the free-text
* conditions (one per quoted phrase or `word*` part, see splitSearchText),
* fanned out across accounts.
*
* Searching from "All mail" is the exception: it searches every folder of
* every account except Trash and Junk, the standard search panel's default
* scope. The All mail list leaves Sent, Archive and Drafts out (or whatever
* the folder picker excludes), and narrowing the search to that list hid
* every sent reply from it. Unread and Starred still narrow to their list.
*/
export async function searchCrossViewEmails(
accounts: UnifiedAccountClient[],
view: CrossView,
query: string,
limit: number,
position: FanOutPosition,
): Promise<UnifiedFetchResult> {
if (view === 'all') {
return searchAcrossAccounts(accounts, query, limit, position, { excludeTrashAndJunk: true });
}
return fanOutCrossQuery(accounts, (account, jmapAccountId, ids) =>
account.client.advancedSearchEmails(
{ operator: 'AND', conditions: [buildCrossFilter(view, ids), ...textConditions(query)] },
jmapAccountId,
limit,
positionFor(position, account),
));
}
/**
* Like `searchCrossViewEmails`, but applies an advanced filter (text + field
* conditions from `buildJMAPFilter`, built WITHOUT an `inMailbox` clause) on top
* of the cross-view membership. `extraFilter` may be empty ({}), in which case
* only the membership filter is used (equivalent to a plain browse). A
* non-empty filter on "All mail" searches every folder except Trash and Junk,
* as in `searchCrossViewEmails`.
*/
export async function advancedSearchCrossViewEmails(
accounts: UnifiedAccountClient[],
view: CrossView,
extraFilter: Record<string, unknown>,
limit: number,
position: FanOutPosition,
): Promise<UnifiedFetchResult> {
const hasExtra = Object.keys(extraFilter).length > 0;
if (view === 'all' && hasExtra) {
return advancedSearchAcrossAccounts(accounts, extraFilter, limit, position, { excludeTrashAndJunk: true });
}
return fanOutCrossQuery(accounts, (account, jmapAccountId, ids) => {
const membership = buildCrossFilter(view, ids);
const filter = hasExtra
? { operator: 'AND', conditions: [membership, extraFilter] }
: membership;
return account.client.advancedSearchEmails(filter, jmapAccountId, limit, positionFor(position, account));
});
}
/**
* Fetches every message carrying a tag keyword across all the given accounts.
*
* A tag is a user-level concept: the same `$label:<id>` keyword is set on
* messages in the user's own account and in the group/shared accounts they
* can reach, and the sidebar tag entry should list all of them. Querying only
* the account of the folder that happened to be selected made the tag view
* flip between the personal and the group messages depending on which folder
* the user came from (#1038).
*
* No `inMailbox` constraint: a tag spans folders. Each account is asked for
* the same page (`limit`/`position`) with pinned-first ordering plus the
* configured list order, mirroring `fetchEmails`, and the pages are merged
* under that same order. Per-account failures land in `errors`.
*
* Trash and Junk are left out, as in Gmail's label views: a deleted message
* keeps its keywords, so it stayed listed under the tag (and came back on
* every refresh after Delete removed the row), looking no different from
* live mail (#1156). It is still reachable from the Trash folder itself.
*/
export async function fetchTagEmails(
accounts: UnifiedAccountClient[],
keyword: string,
limit: number,
position: FanOutPosition,
order: SortLevel[] = [],
extraFilter?: Record<string, unknown>,
): Promise<UnifiedFetchResult> {
return fanOutAccountQuery(
accounts,
(account, jmapAccountId) => {
const filter = andFilters(extraFilter ?? {}, trashAndJunkExclusion(account));
return account.client.getEmails(
undefined, jmapAccountId, limit, positionFor(position, account), keyword, true,
Object.keys(filter).length > 0 ? filter : undefined, order,
);
},
compareEmails(order, { pinnedFirst: true }),
);
}
export interface AcrossAccountsSearchOptions extends SearchRequestOptions {
/**
* Leave every account's Trash and Junk out: the search panel's default
* scope, "All folders except Spam and Trash". Its "All folders" scope
* searches them too.
*/
excludeTrashAndJunk?: boolean;
}
/**
* Text search over every folder of every given account: the folder-less
* scopes of the standard search panel. One query per account with no
* `inMailbox` constraint, merged newest first.
*
* The unscoped search used to ask only the login's own account, so mail in
* the group/shared accounts the same login reaches (whose folders sit right
* there in the sidebar) was silently missing from every "All folders"
* search - an ordinary "No results found" with no hint (#1082).
*/
export async function searchAcrossAccounts(
accounts: UnifiedAccountClient[],
query: string,
limit: number,
position: FanOutPosition,
options: AcrossAccountsSearchOptions = {},
): Promise<UnifiedFetchResult> {
return fanOutAccountQuery(
accounts,
(account, jmapAccountId) => {
const exclusion = options.excludeTrashAndJunk ? trashAndJunkExclusion(account) : null;
return exclusion
? account.client.advancedSearchEmails(
andFilters(textFilter(query), exclusion), jmapAccountId, limit, positionFor(position, account),
...searchRequestOptions(options),
)
: account.client.searchEmails(query, undefined, jmapAccountId, limit, positionFor(position, account), ...searchRequestOptions(options));
},
newestFirst,
);
}
/**
* Like `searchAcrossAccounts`, with a JMAP advanced filter that was built
* WITHOUT an `inMailbox` clause (`buildJMAPFilter(query, filters, undefined)`).
*/
export async function advancedSearchAcrossAccounts(
accounts: UnifiedAccountClient[],
filter: Record<string, unknown>,
limit: number,
position: FanOutPosition,
options: AcrossAccountsSearchOptions = {},
): Promise<UnifiedFetchResult> {
return fanOutAccountQuery(
accounts,
(account, jmapAccountId) => account.client.advancedSearchEmails(
options.excludeTrashAndJunk ? andFilters(filter, trashAndJunkExclusion(account)) : filter,
jmapAccountId,
limit,
positionFor(position, account),
...searchRequestOptions(options),
),
newestFirst,
);
}
/** The trailing SearchRequestOptions argument, left off when nothing is asked of it. */
function searchRequestOptions(options: AcrossAccountsSearchOptions): [] | [SearchRequestOptions] {
return options.deferSnippets ? [{ deferSnippets: true }] : [];
}
function newestFirst(a: Email, b: Email): number {
return new Date(b.receivedAt).getTime() - new Date(a.receivedAt).getTime();
}
/**
* Runs one folder-less request per account (own entries against the client's
* primary account, shared entries against the owner's JMAP accountId), stamps
* every returned email with its source account and merges the pages under
* `sort`. A failing account lands in `errors` and does not hide the others.
*/
async function fanOutAccountQuery(
accounts: UnifiedAccountClient[],
run: (
account: UnifiedAccountClient,
jmapAccountId: string | undefined,
) => Promise<SearchEmailsResult>,
sort: (a: Email, b: Email) => number,
): Promise<UnifiedFetchResult> {
const errors = new Map<string, string>();
type AccountResult = {
account: UnifiedAccountClient;
result: SearchEmailsResult;
} | null;
const promises = accounts.map(async (account): Promise<AccountResult> => {
const jmapAccountId = account.isShared ? account.accountId : undefined;
try {
const result = await run(account, jmapAccountId);
return { account, result };
} catch (err) {
errors.set(account.accountId, err instanceof Error ? err.message : String(err));
return null;
}
});
const results = await Promise.allSettled(promises);
let mergedEmails: Email[] = [];
let totalSum = 0;
let anyHasMore = false;
const snippetBatches: Promise<DeferredSnippetBatch | null>[] = [];
for (const outcome of results) {
if (outcome.status !== 'fulfilled' || outcome.value === null) continue;
const { account, result } = outcome.value;
if (result.snippets) {
snippetBatches.push(result.snippets.then((list) => (list ? { accountId: account.accountId, list } : null)));
}
// Decorate shallow copies, not the shared client-returned objects. The
// source stamps are what routes every later action (read, move, delete,
// thread expansion) back to the owning account.
const decorated = result.emails.map((email) => ({
...email,
accountId: account.accountId,
accountLabel: account.accountLabel,
sourceClientAccountId: account.clientAccountId,
sourceAccountId: account.jmapAccountId,
sourceFolder: resolveSourceFolderName(email, account.mailboxes),
}));
mergedEmails = mergedEmails.concat(decorated);
totalSum += result.total;
if (result.hasMore) anyHasMore = true;
}
mergedEmails.sort(sort);
const snippets = snippetBatches.length > 0
? Promise.all(snippetBatches).then((batches) => batches.filter((batch): batch is DeferredSnippetBatch => batch !== null))
: undefined;
return { emails: mergedEmails, total: totalSum, hasMore: anyHasMore, errors, ...(snippets ? { snippets } : {}) };
}
/**
* Returns the list of unified roles that exist in at least one account's
* mailboxes.
*/
export function getUnifiedRoles(
accounts: UnifiedAccountClient[],
): UnifiedMailboxRole[] {
const roles: UnifiedMailboxRole[] = [];
for (const role of ALL_UNIFIED_ROLES) {
for (const account of accounts) {
if (findMailboxByRole(account.mailboxes, role)) {
roles.push(role);
break;
}
}
}
return roles;
}
/**
* Only growth is interesting. A shrink (sign-out, disconnect) is already driven
* by the flow that caused it, so refetching there would race it. See #950.
*/
export function connectedAccountsGrew(previous: string | null, current: string): boolean {
if (previous === null || previous === current) return false;
const before = new Set(previous ? previous.split(',').filter(Boolean) : []);
return current.split(',').some((id) => id !== '' && !before.has(id));
}
/** The server a client talks to, compared without case or a trailing slash. */
export function unifiedServerKey(client: Pick<IJMAPClient, 'getServerUrl'> | undefined): string {
return (client?.getServerUrl?.() ?? '').trim().replace(/\/+$/, '').toLowerCase();
}
/**
* How far the unified scope has got while logins are still reconnecting:
* `{ loaded, total }` while some logins expected in it are not there yet,
* `null` once it is complete, when it spans only one login, or when no
* restore is running (a login that did not make it must not keep the note up).
*/
export function unifiedLoadProgress(input: {
crossAccountActive: boolean;
restoring: boolean;
scope: Pick<UnifiedAccountClient, 'clientAccountId' | 'isShared'>[];
accounts: { hasError?: boolean }[];
}): { loaded: number; total: number } | null {
if (!input.crossAccountActive || !input.restoring) return null;
const total = input.accounts.filter((a) => !a.hasError).length;
if (total < 2) return null;
const loaded = new Set(input.scope.filter((e) => !e.isShared).map((e) => e.clientAccountId)).size;
return loaded < total ? { loaded, total } : null;
}
/**
* Drops mailboxes that are reachable through more than one logged-in account,
* so each folder contributes to the aggregate views exactly once.
*
* A folder shared with a second login (owner + grantee both logged in), or
* shared with two logins at once, otherwise yields one entry per reaching
* login: its messages list twice and its unread count is summed twice.
*
* A mailbox is identified by its server, its owning JMAP account and its
* server-side id (a shared entry's `originalId`). JMAP account and mailbox ids
* are only unique on one server (Stalwart hands out short ids like "b" or "c"
* everywhere), so logins on different servers never cover each other's
* folders. Personal entries always win and are never trimmed, so
* an owner's folder is read through the owner's own login and honors their
* folder selection. Shared entries keep only mailboxes not already covered and
* are dropped when none remain. Order is preserved.
*/
export function dedupeUnifiedAccounts(accounts: UnifiedAccountClient[]): UnifiedAccountClient[] {
const seen = new Set<string>();
const key = (account: UnifiedAccountClient, mailboxId: string) =>
`${unifiedServerKey(account.client)}\u0000${account.jmapAccountId}\u0000${mailboxId}`;
for (const account of accounts) {
if (account.isShared) continue;
for (const m of account.mailboxes) seen.add(key(account, m.id));
}
const out: UnifiedAccountClient[] = [];
for (const account of accounts) {
if (!account.isShared) {
out.push(account);
continue;
}
const mailboxes = account.mailboxes.filter((m) => {
const k = key(account, m.originalId ?? m.id);
if (seen.has(k)) return false;
seen.add(k);
return true;
});
if (mailboxes.length === 0) continue;
out.push(mailboxes.length === account.mailboxes.length ? account : { ...account, mailboxes });
}
return out;
}