Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Update email box API method naming

Leendert de Borst852fb9ff01b5
diff --git a/apps/browser-extension/src/entrypoints/popup/pages/emails/EmailDetails.tsx b/apps/browser-extension/src/entrypoints/popup/pages/emails/EmailDetails.tsx
index 1538ac3f3..30f173bde 100644
--- a/apps/browser-extension/src/entrypoints/popup/pages/emails/EmailDetails.tsx
+++ b/apps/browser-extension/src/entrypoints/popup/pages/emails/EmailDetails.tsx
@@ -102,7 +102,7 @@ const EmailDetails: React.FC = (): React.ReactElement => {
setViewMode('source');
}
} catch (err) {
- setError(err instanceof Error ? err.message : 'An error occurred');
+ setError(err instanceof Error ? err.message : t('common.errors.unknownError'));
} finally {
setIsLoading(false);
setIsInitialLoading(false);
@@ -155,8 +155,8 @@ const EmailDetails: React.FC = (): React.ReactElement => {
decodeEmailSource(sourceBytes)
.then(decoded => setSourceText(new TextDecoder().decode(decoded)))
- .catch(err => setError(err instanceof Error ? err.message : 'Failed to decode email source'));
- }, [viewMode, sourceText, sourceBytes]);
+ .catch(err => setError(err instanceof Error ? err.message : t('common.errors.unknownError')));
+ }, [viewMode, sourceText, sourceBytes, t]);
const sanitizedHtmlBody = useMemo(() => htmlBody ? sanitizeEmailHtml(htmlBody) : null, [htmlBody]);
@@ -188,9 +188,9 @@ const EmailDetails: React.FC = (): React.ReactElement => {
navigate(fromPath ?? '/emails');
}
} catch (err) {
- setError(err instanceof Error ? err.message : 'Failed to delete email');
+ setError(err instanceof Error ? err.message : t('common.errors.unknownError'));
}
- }, [id, webApi, navigate, fromPath]);
+ }, [id, webApi, navigate, fromPath, t]);
/**
* Open the email details in a new expanded popup.
@@ -220,7 +220,7 @@ const EmailDetails: React.FC = (): React.ReactElement => {
downloadBytes(attachment.filename, bytes, attachment.mimeType);
} catch (err) {
logFailure('[Email] Downloading the attachment failed', err);
- setError(err instanceof Error ? err.message : 'Failed to download attachment');
+ setError(err instanceof Error ? err.message : t('common.errors.unknownError'));
}
};
@@ -273,8 +273,9 @@ const EmailDetails: React.FC = (): React.ReactElement => {
);
}
- if (error) {
- return <div className="text-red-500">{t('common.error')} {error}</div>;
+ // Errors on a loaded email show inline so the email stays visible.
+ if (error && !email) {
+ return <div className="text-red-500">{t('common.error')}: {error}</div>;
}
if (!email) {
@@ -297,6 +298,8 @@ const EmailDetails: React.FC = (): React.ReactElement => {
variant="danger"
/>
+ {error && <p className="mb-4 text-sm text-red-500">{t('common.error')}: {error}</p>}
+
<div>
{/* Header */}
<div>
diff --git a/apps/browser-extension/src/entrypoints/popup/pages/emails/EmailsList.tsx b/apps/browser-extension/src/entrypoints/popup/pages/emails/EmailsList.tsx
index 343ff7553..db3ae6aec 100644
--- a/apps/browser-extension/src/entrypoints/popup/pages/emails/EmailsList.tsx
+++ b/apps/browser-extension/src/entrypoints/popup/pages/emails/EmailsList.tsx
@@ -20,7 +20,7 @@ import { logFailure } from '@/utils/Diagnostics';
import { useMinDurationLoading } from '@/hooks/useMinDurationLoading';
-import type { MailboxBulkRequest, MailboxBulkResponse, MailboxEmail } from '@aliasvault/models/webapi';
+import type { InboxResponse, MailboxEmail } from '@aliasvault/models/webapi';
/**
* Emails list page.
@@ -68,10 +68,7 @@ const EmailsList: React.FC = () => {
try {
// The server resolves the mailbox from the caller's active alias claims.
- const data = await webApi.post<MailboxBulkRequest, MailboxBulkResponse>('EmailBox/bulk', {
- page: 1,
- pageSize: PAGE_SIZE,
- });
+ const data = await webApi.get<InboxResponse>(`EmailBox?page=1&pageSize=${PAGE_SIZE}`);
// Decrypt emails locally using private key associated with the email address.
const encryptionKeys = dbContext.sqliteClient.encryptionKeys.getAll();
@@ -110,10 +107,7 @@ const EmailsList: React.FC = () => {
const nextPage = currentPage + 1;
- const data = await webApi.post<MailboxBulkRequest, MailboxBulkResponse>('EmailBox/bulk', {
- page: nextPage,
- pageSize: PAGE_SIZE,
- });
+ const data = await webApi.get<InboxResponse>(`EmailBox?page=${nextPage}&pageSize=${PAGE_SIZE}`);
// Decrypt emails locally
const encryptionKeys = dbContext.sqliteClient.encryptionKeys.getAll();
@@ -198,10 +192,6 @@ const EmailsList: React.FC = () => {
);
}
- if (error) {
- return <div className="text-red-500">{t('common.error')}: {error}</div>;
- }
-
// Show offline message if in offline mode
if (dbContext.isOffline) {
return (
@@ -225,11 +215,15 @@ const EmailsList: React.FC = () => {
<PageTitle>{t('emails.title')}</PageTitle>
<ReloadButton onClick={loadEmails} />
</div>
- <div className="text-gray-500 dark:text-gray-400 space-y-2">
- <p className="text-sm">
- {t('emails.emptyMessage')}
- </p>
- </div>
+ {error ? (
+ <p className="text-sm text-red-500">{t('common.error')}: {error}</p>
+ ) : (
+ <div className="text-gray-500 dark:text-gray-400 space-y-2">
+ <p className="text-sm">
+ {t('emails.emptyMessage')}
+ </p>
+ </div>
+ )}
</div>
);
}
@@ -242,6 +236,7 @@ const EmailsList: React.FC = () => {
<PageTitle>{t('emails.title')}</PageTitle>
<ReloadButton onClick={() => loadEmails(true)} />
</div>
+ {error && <p className="mb-4 text-sm text-red-500">{t('common.error')}: {error}</p>}
<div className="space-y-2">
{emails.map((email) => (
<Link
diff --git a/apps/mobile-app/app/(tabs)/emails/[id].tsx b/apps/mobile-app/app/(tabs)/emails/[id].tsx
index ae4d221cf..7459370a3 100644
--- a/apps/mobile-app/app/(tabs)/emails/[id].tsx
+++ b/apps/mobile-app/app/(tabs)/emails/[id].tsx
@@ -6,7 +6,7 @@ import { Paths } from 'expo-file-system';
import { useLocalSearchParams, useRouter, useNavigation, Stack } from 'expo-router';
import React, { useEffect, useMemo, useRef, useState, useCallback } from 'react';
import { useTranslation } from 'react-i18next';
-import { StyleSheet, View, ActivityIndicator, useColorScheme, Linking, Text, TextInput, Platform } from 'react-native';
+import { StyleSheet, View, ActivityIndicator, useColorScheme, Linking, Text, TextInput, Platform, ScrollView, RefreshControl } from 'react-native';
import { useSafeAreaInsets } from 'react-native-safe-area-context';
import { WebView, type WebViewNavigation } from 'react-native-webview';
@@ -344,6 +344,10 @@ export default function EmailDetailsScreen() : React.ReactNode {
fontSize: 14,
fontWeight: '600',
},
+ inlineError: {
+ paddingHorizontal: 12,
+ paddingVertical: 8,
+ },
metadataContainer: {
padding: 2,
},
@@ -404,6 +408,12 @@ export default function EmailDetailsScreen() : React.ReactNode {
fontSize: 15,
padding: 16,
},
+ refreshContainer: {
+ alignItems: 'center',
+ flexGrow: 1,
+ justifyContent: 'center',
+ padding: 20,
+ },
sourceText: {
fontFamily: Platform.OS === 'ios' ? 'Menlo' : 'monospace',
fontSize: 12,
@@ -494,10 +504,18 @@ export default function EmailDetailsScreen() : React.ReactNode {
);
}
- if (error) {
+ // A failed load stays pull-to-refreshable; errors on a loaded email show inline below.
+ if (error && !email) {
return (
- <ThemedView style={styles.centerContainer}>
- <ThemedText style={styles.errorText}>{t('common.error')}: {error}</ThemedText>
+ <ThemedView style={styles.container}>
+ <Stack.Screen options={{ title: t('emails.emailDetails') }} />
+ <ScrollView
+ contentContainerStyle={styles.refreshContainer}
+ alwaysBounceVertical={true}
+ refreshControl={<RefreshControl refreshing={false} onRefresh={loadEmail} colors={[colors.primary]} tintColor={colors.primary} />}
+ >
+ <ThemedText style={styles.errorText}>{t('common.error')}: {error}</ThemedText>
+ </ScrollView>
</ThemedView>
);
}
@@ -636,6 +654,11 @@ export default function EmailDetailsScreen() : React.ReactNode {
<ThemedView style={styles.container}>
<Stack.Screen options={{ title: t('emails.emailDetails') }} />
{metadataView}
+ {error && (
+ <View style={styles.inlineError}>
+ <ThemedText style={styles.errorText}>{t('common.error')}: {error}</ThemedText>
+ </View>
+ )}
{isSourceOnly && (
<View style={styles.updateNotice}>
<ThemedText style={styles.updateNoticeText}>
diff --git a/apps/mobile-app/app/(tabs)/emails/index.tsx b/apps/mobile-app/app/(tabs)/emails/index.tsx
index 51563261a..18e0fc53a 100644
--- a/apps/mobile-app/app/(tabs)/emails/index.tsx
+++ b/apps/mobile-app/app/(tabs)/emails/index.tsx
@@ -21,7 +21,7 @@ import { TitleContainer } from '@/components/ui/TitleContainer';
import { useDb } from '@/context/DbContext';
import { useWebApi } from '@/context/WebApiContext';
-import type { MailboxBulkRequest, MailboxBulkResponse, MailboxEmail } from '@aliasvault/models/webapi';
+import type { InboxResponse, MailboxEmail } from '@aliasvault/models/webapi';
/**
* Emails screen.
@@ -65,10 +65,7 @@ export default function EmailsScreen() : React.ReactNode {
try {
// The server resolves the mailbox from the caller's active alias claims.
- const data = await webApi.post<MailboxBulkRequest, MailboxBulkResponse>('EmailBox/bulk', {
- page: 1,
- pageSize: PAGE_SIZE,
- });
+ const data = await webApi.get<InboxResponse>(`EmailBox?page=1&pageSize=${PAGE_SIZE}`);
// Decrypt emails locally using private key associated with the email address
const encryptionKeys = await dbContext.sqliteClient.encryptionKeys.getAll();
@@ -121,10 +118,7 @@ export default function EmailsScreen() : React.ReactNode {
const nextPage = currentPage + 1;
- const data = await webApi.post<MailboxBulkRequest, MailboxBulkResponse>('EmailBox/bulk', {
- page: nextPage,
- pageSize: PAGE_SIZE,
- });
+ const data = await webApi.get<InboxResponse>(`EmailBox?page=${nextPage}&pageSize=${PAGE_SIZE}`);
// Decrypt emails locally
const encryptionKeys = await dbContext.sqliteClient.encryptionKeys.getAll();
@@ -210,6 +204,7 @@ export default function EmailsScreen() : React.ReactNode {
justifyContent: 'center',
},
contentContainer: {
+ flexGrow: 1,
paddingBottom: Platform.OS === 'ios' ? insets.bottom + 60 : 10,
paddingTop: Platform.OS === 'ios' ? 42 : 16,
},
@@ -218,6 +213,9 @@ export default function EmailsScreen() : React.ReactNode {
opacity: 0.7,
textAlign: 'center',
},
+ errorContainer: {
+ paddingVertical: 16,
+ },
errorText: {
color: colors.errorText,
textAlign: 'center',
@@ -271,26 +269,31 @@ export default function EmailsScreen() : React.ReactNode {
);
}
- if (error) {
- return (
- <View style={styles.centerContainer}>
- <ThemedText style={styles.errorText}>{t('common.error')}: {error}</ThemedText>
- </View>
- );
- }
+ // The error sits inside the scroll view so pull to refresh keeps working.
+ const errorView = error ? (
+ <View style={styles.errorContainer}>
+ <ThemedText style={styles.errorText}>{t('common.error')}: {error}</ThemedText>
+ </View>
+ ) : null;
if (emails.length === 0) {
return (
- <View style={styles.centerContainer}>
- <ThemedText style={styles.emptyText}>
- {t('emails.emptyMessage')}
- </ThemedText>
- </View>
+ <>
+ {errorView}
+ {!error && (
+ <View style={styles.centerContainer}>
+ <ThemedText style={styles.emptyText}>
+ {t('emails.emptyMessage')}
+ </ThemedText>
+ </View>
+ )}
+ </>
);
}
return (
<>
+ {errorView}
{emails.map((email) => (
<EmailCard key={email.id} email={email} />
))}
@@ -339,6 +342,7 @@ export default function EmailsScreen() : React.ReactNode {
scrollEventThrottle={16}
contentContainerStyle={styles.contentContainer}
scrollIndicatorInsets={{ bottom: 40 }}
+ alwaysBounceVertical={true}
refreshControl={
<RefreshControl
refreshing={isRefreshing}
diff --git a/apps/server/AliasVault.Api/Controllers/V2/Email/EmailBoxController.cs b/apps/server/AliasVault.Api/Controllers/V2/Email/EmailBoxController.cs
index 754b66c7b..14f145618 100644
--- a/apps/server/AliasVault.Api/Controllers/V2/Email/EmailBoxController.cs
+++ b/apps/server/AliasVault.Api/Controllers/V2/Email/EmailBoxController.cs
@@ -34,9 +34,9 @@ using NpgsqlTypes;
public class EmailBoxController(IAliasServerDbContextFactory dbContextFactory, UserManager<AliasVaultUser> userManager, IpBlockListService ipBlockListService, TakenAliasLookupRateLimitService takenAliasLookupRateLimit, RateLimitService rateLimitService) : AuthenticatedRequestController(userManager)
{
/// <summary>
- /// Highest page the bulk mailbox serves; each address scans up to page * pageSize rows.
+ /// Highest page the inbox serves; each address scans up to page * pageSize rows.
/// </summary>
- private const int MaxBulkPage = 1000;
+ private const int MaxInboxPage = 1000;
/// <summary>
/// Returns a list of emails for the provided email address.
@@ -147,12 +147,13 @@ public class EmailBoxController(IAliasServerDbContextFactory dbContextFactory, U
}
/// <summary>
- /// Returns a list of emails for the provided list of email addresses.
+ /// Returns the newest emails across all of the caller's active aliases, paged.
/// </summary>
- /// <param name="model">The request model extracted from POST body.</param>
- /// <returns>List of emails in JSON format.</returns>
- [HttpPost(template: "bulk", Name = "GetEmailBoxBulk")]
- public async Task<IActionResult> GetEmailBoxBulk([FromBody] MailboxBulkRequest model)
+ /// <param name="page">The page number, starting at 1.</param>
+ /// <param name="pageSize">The number of emails per page, at most 50.</param>
+ /// <returns>One page of the inbox.</returns>
+ [HttpGet(Name = "GetInbox")]
+ public async Task<IActionResult> GetInbox([FromQuery] int page = 1, [FromQuery] int pageSize = 50)
{
await using var context = await dbContextFactory.CreateDbContextAsync();
var user = await GetCurrentUserAsync();
@@ -164,8 +165,8 @@ public class EmailBoxController(IAliasServerDbContextFactory dbContextFactory, U
// Shadow-block: when active, only emails received before the block took effect are visible.
var shadowCutoff = await ipBlockListService.GetShadowBlockCutoffAsync(user, IpAddressUtility.GetRawIpAddressFromContext(HttpContext));
- model.PageSize = Math.Clamp(model.PageSize, 1, 50);
- var page = Math.Clamp(model.Page, 1, MaxBulkPage);
+ pageSize = Math.Clamp(pageSize, 1, 50);
+ page = Math.Clamp(page, 1, MaxInboxPage);
// The server picks the addresses, so a request carries no collection that could amplify the queries below.
var validAddresses = await EmailAccessHelper.ResolveActiveAddressesAsync(context, user.Id);
@@ -189,7 +190,7 @@ public class EmailBoxController(IAliasServerDbContextFactory dbContextFactory, U
[
new("addresses", validAddresses.ToArray()),
new("keyids", decryptableKeyIds.ToArray()),
- new("limit", page * model.PageSize),
+ new("limit", page * pageSize),
];
if (shadowCutoff is not null)
@@ -202,8 +203,8 @@ public class EmailBoxController(IAliasServerDbContextFactory dbContextFactory, U
.FromSqlRaw(pageSql, parameters.ToArray())
.AsNoTracking()
.OrderByDescending(x => x.DateSystem)
- .Skip((page - 1) * model.PageSize)
- .Take(model.PageSize)
+ .Skip((page - 1) * pageSize)
+ .Take(pageSize)
.Select(x => new
{
Mail = new MailboxEmailApiModel
@@ -241,11 +242,11 @@ public class EmailBoxController(IAliasServerDbContextFactory dbContextFactory, U
var totalRecords = await countQuery.CountAsync();
- MailboxBulkResponse returnValue = new()
+ InboxResponse returnValue = new()
{
PublicKeys = keyTable.PublicKeys,
Mails = mails,
- PageSize = model.PageSize,
+ PageSize = pageSize,
CurrentPage = page,
TotalRecords = totalRecords,
};
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/MailboxBulkResponse.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/InboxResponse.cs
similarity index 87%
rename from apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/MailboxBulkResponse.cs
rename to apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/InboxResponse.cs
index a694ef58d..94f3f2b55 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/MailboxBulkResponse.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/InboxResponse.cs
@@ -1,5 +1,5 @@
//-----------------------------------------------------------------------
-// <copyright file="MailboxBulkResponse.cs" company="aliasvault">
+// <copyright file="InboxResponse.cs" company="aliasvault">
// Copyright (c) aliasvault. All rights reserved.
// Licensed under the AGPLv3 license. See LICENSE.md file in the project root for full license information.
// </copyright>
@@ -8,9 +8,9 @@
namespace AliasVault.Shared.Models.WebApi.V2.Email;
/// <summary>
-/// Represents the bulk mailbox response.
+/// One page of the inbox: the newest emails across all of the caller's active aliases.
/// </summary>
-public class MailboxBulkResponse
+public class InboxResponse
{
/// <summary>
/// Gets or sets requested page number.
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/MailboxBulkRequest.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/MailboxBulkRequest.cs
deleted file mode 100644
index fe293d4fb..000000000
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/MailboxBulkRequest.cs
+++ /dev/null
@@ -1,24 +0,0 @@
-//-----------------------------------------------------------------------
-// <copyright file="MailboxBulkRequest.cs" company="aliasvault">
-// Copyright (c) aliasvault. All rights reserved.
-// Licensed under the AGPLv3 license. See LICENSE.md file in the project root for full license information.
-// </copyright>
-//-----------------------------------------------------------------------
-
-namespace AliasVault.Shared.Models.WebApi.V2.Email;
-
-/// <summary>
-/// Represents the bulk mailbox request. The server resolves the addresses from the caller's active alias claims.
-/// </summary>
-public class MailboxBulkRequest
-{
- /// <summary>
- /// Gets or sets requested page number.
- /// </summary>
- public int Page { get; set; }
-
- /// <summary>
- /// Gets or sets requested page size.
- /// </summary>
- public int PageSize { get; set; }
-}
diff --git a/apps/web/src/pages/emails/Home.tsx b/apps/web/src/pages/emails/Home.tsx
index 080fe8ad9..62c3585d5 100644
--- a/apps/web/src/pages/emails/Home.tsx
+++ b/apps/web/src/pages/emails/Home.tsx
@@ -29,7 +29,7 @@ import { itemRoute } from '@/utils/ItemRoute';
import { StorageKeys } from '@/utils/StorageKeys';
import type { ItemRef } from '@aliasvault/client/database/ItemRef';
-import type { MailboxBulkRequest, MailboxBulkResponse, MailboxEmail } from '@aliasvault/models/webapi';
+import type { InboxResponse, MailboxEmail } from '@aliasvault/models/webapi';
/** Emails per page. */
const PAGE_SIZE = 50;
@@ -126,7 +126,7 @@ const EmailsHome: React.FC = () => {
}
try {
- const data = await webApi.post<MailboxBulkRequest, MailboxBulkResponse>('EmailBox/bulk', { page, pageSize });
+ const data = await webApi.get<InboxResponse>(`EmailBox?page=${page}&pageSize=${pageSize}`);
const encryptionKeys = dbContext.sqliteClient.encryptionKeys.getAll();
const decrypted: MailboxEmail[] = await EncryptionUtility.decryptEmailList(data.mails, data.publicKeys, encryptionKeys);
const lookup = getItemLookup();
diff --git a/core/models/src/webapi/Inbox.ts b/core/models/src/webapi/Inbox.ts
new file mode 100644
index 000000000..a3f78b420
--- /dev/null
+++ b/core/models/src/webapi/Inbox.ts
@@ -0,0 +1,12 @@
+import type { MailboxEmail } from "./MailboxEmail";
+
+/**
+ * One page of the inbox: the newest emails across all of the caller's active aliases.
+ */
+export type InboxResponse = {
+ currentPage: number;
+ pageSize: number;
+ totalRecords: number;
+ publicKeys: string[];
+ mails: MailboxEmail[];
+}
diff --git a/core/models/src/webapi/MailboxBulk.ts b/core/models/src/webapi/MailboxBulk.ts
deleted file mode 100644
index 21f268add..000000000
--- a/core/models/src/webapi/MailboxBulk.ts
+++ /dev/null
@@ -1,20 +0,0 @@
-import type { MailboxEmail } from "./MailboxEmail";
-
-/**
- * Mailbox bulk request type. The server resolves the addresses from the caller's active alias claims.
- */
-export type MailboxBulkRequest = {
- page: number;
- pageSize: number;
-}
-
-/**
- * Mailbox bulk response type.
- */
-export type MailboxBulkResponse = {
- currentPage: number;
- pageSize: number;
- totalRecords: number;
- publicKeys: string[];
- mails: MailboxEmail[];
-}
\ No newline at end of file
diff --git a/core/models/src/webapi/index.ts b/core/models/src/webapi/index.ts
index 7574fd0b4..a7db8b040 100644
--- a/core/models/src/webapi/index.ts
+++ b/core/models/src/webapi/index.ts
@@ -10,7 +10,7 @@ export * from './StatusResponseV2';
export * from './Login';
export * from './ValidateLogin';
export * from './Mailbox';
-export * from './MailboxBulk';
+export * from './Inbox';
export * from './MailboxEmail';
export * from './Email';
export * from './EmailAttachment';