Skip to content

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

Cleanup email v2 api call responses (#2159)

Leendert de Borst00a206c017ef
diff --git a/apps/server/AliasVault.Api/Controllers/V1/Email/EmailBoxController.cs b/apps/server/AliasVault.Api/Controllers/V1/Email/EmailBoxController.cs
index 426a227a9..d08db407b 100644
--- a/apps/server/AliasVault.Api/Controllers/V1/Email/EmailBoxController.cs
+++ b/apps/server/AliasVault.Api/Controllers/V1/Email/EmailBoxController.cs
@@ -204,7 +204,7 @@ public class EmailBoxController(IAliasServerDbContextFactory dbContextFactory, U
MessagePreview = x.MessagePreview ?? string.Empty,
EncryptedSymmetricKey = x.DecryptionKeys.Where(d => personalKeyIds.Contains(d.VaultManifestDeliveryKeyId)).OrderBy(d => d.VaultManifestDeliveryKeyId).Select(d => d.EncryptedSymmetricKey).First(),
EncryptionKey = x.DecryptionKeys.Where(d => personalKeyIds.Contains(d.VaultManifestDeliveryKeyId)).OrderBy(d => d.VaultManifestDeliveryKeyId).Select(d => d.VaultManifestDeliveryKey.PublicKey).First(),
- HasAttachments = x.AttachmentCount > 0 || x.Attachments.Any(),
+ HasAttachments = x.AttachmentCount > 0,
})
.ToListAsync();
diff --git a/apps/server/AliasVault.Api/Controllers/V2/Email/EmailBoxController.cs b/apps/server/AliasVault.Api/Controllers/V2/Email/EmailBoxController.cs
index fe566a3c9..19517bb83 100644
--- a/apps/server/AliasVault.Api/Controllers/V2/Email/EmailBoxController.cs
+++ b/apps/server/AliasVault.Api/Controllers/V2/Email/EmailBoxController.cs
@@ -102,7 +102,7 @@ public class EmailBoxController(IAliasServerDbContextFactory dbContextFactory, U
DateSystem = DateTime.SpecifyKind(x.DateSystem, DateTimeKind.Utc),
SecondsAgo = (int)DateTime.UtcNow.Subtract(x.DateSystem).TotalSeconds,
MessagePreview = x.MessagePreview ?? string.Empty,
- HasAttachments = x.AttachmentCount > 0 || x.Attachments.Any(),
+ HasAttachments = x.AttachmentCount > 0,
},
DecryptionKeys = x.DecryptionKeys.Where(d => decryptableKeyIds.Contains(d.VaultManifestDeliveryKeyId)).Select(d => new { d.VaultManifestDeliveryKeyId, d.EncryptedSymmetricKey }).ToList(),
})
@@ -205,7 +205,7 @@ public class EmailBoxController(IAliasServerDbContextFactory dbContextFactory, U
DateSystem = DateTime.SpecifyKind(x.DateSystem, DateTimeKind.Utc),
SecondsAgo = (int)DateTime.UtcNow.Subtract(x.DateSystem).TotalSeconds,
MessagePreview = x.MessagePreview ?? string.Empty,
- HasAttachments = x.AttachmentCount > 0 || x.Attachments.Any(),
+ HasAttachments = x.AttachmentCount > 0,
},
DecryptionKeys = x.DecryptionKeys.Where(d => decryptableKeyIds.Contains(d.VaultManifestDeliveryKeyId)).Select(d => new { d.VaultManifestDeliveryKeyId, d.EncryptedSymmetricKey }).ToList(),
})
@@ -228,7 +228,6 @@ public class EmailBoxController(IAliasServerDbContextFactory dbContextFactory, U
MailboxBulkResponse returnValue = new()
{
- Addresses = validAddresses,
PublicKeys = keyTable.PublicKeys,
Mails = mails,
PageSize = model.PageSize,
diff --git a/apps/server/AliasVault.Api/Controllers/V2/Email/EmailController.cs b/apps/server/AliasVault.Api/Controllers/V2/Email/EmailController.cs
index e67d769d9..f78c1c384 100644
--- a/apps/server/AliasVault.Api/Controllers/V2/Email/EmailController.cs
+++ b/apps/server/AliasVault.Api/Controllers/V2/Email/EmailController.cs
@@ -57,23 +57,10 @@ public class EmailController(ILogger<EmailController> logger, IAliasServerDbCont
DateSystem = DateTime.SpecifyKind(email.DateSystem, DateTimeKind.Utc),
SecondsAgo = (int)DateTime.UtcNow.Subtract(email.DateSystem).TotalSeconds,
MessageSource = email.MessageSourceBytes is not null ? Convert.ToBase64String(email.MessageSourceBytes) : email.MessageSource,
- AttachmentCount = email.AttachmentCount,
PublicKeys = keyTable.PublicKeys,
DecryptionKeys = keyTable.ToApiModels(callerDecryptionKeys.Select(d => (d.VaultManifestDeliveryKeyId, d.EncryptedSymmetricKey))),
};
- // Add attachment metadata (without the filebytes)
- var attachments = await context.EmailAttachments.Where(x => x.EmailId == email!.Id).Select(x => new AttachmentApiModel()
- {
- Id = x.Id,
- Email_Id = x.EmailId,
- Filename = x.Filename,
- MimeType = x.MimeType,
- Filesize = x.Filesize,
- }).ToListAsync();
-
- returnEmail.Attachments = attachments;
-
return Ok(returnEmail);
}
@@ -109,37 +96,6 @@ public class EmailController(ILogger<EmailController> logger, IAliasServerDbCont
}
}
- /// <summary>
- /// Get the attachment bytes for the specified email and attachment ID.
- /// </summary>
- /// <param name="id">The email ID.</param>
- /// <param name="attachmentId">The attachment ID.</param>
- /// <returns>Attachment bytes in encrypted form.</returns>
- [HttpGet(template: "{id}/attachments/{attachmentId}", Name = "GetEmailAttachment")]
- public async Task<IActionResult> GetEmailAttachment(int id, int attachmentId)
- {
- await using var context = await dbContextFactory.CreateDbContextAsync();
-
- var (email, _, errorResult) = await AuthenticateAndRetrieveEmailAsync(id, context);
- if (errorResult != null)
- {
- return errorResult;
- }
-
- // Find the requested attachment
- var attachment = await context.EmailAttachments
- .FirstOrDefaultAsync(x => x.Id == attachmentId && x.EmailId == email!.Id);
-
- if (attachment == null)
- {
- return NotFound("Attachment not found.");
- }
-
- // Return the encrypted bytes as opaque binary. The original MIME type would be
- // misleading since the payload is AES ciphertext, not a renderable file.
- return File(attachment.Bytes, "application/octet-stream", attachment.Filename);
- }
-
/// <summary>
/// Get the bytes of an attachment body that was detached from the email's source at ingest.
/// </summary>
@@ -186,7 +142,6 @@ public class EmailController(ILogger<EmailController> logger, IAliasServerDbCont
// Retrieve email from database.
var email = await context.Emails
- .Include(x => x.Attachments)
.Include(x => x.DecryptionKeys)
.ThenInclude(d => d.VaultManifestDeliveryKey)
.FirstOrDefaultAsync(x => x.Id == id);
diff --git a/apps/server/Databases/AliasServerDb/AliasServerDbContext.cs b/apps/server/Databases/AliasServerDb/AliasServerDbContext.cs
index 1282e19f1..e413614b8 100644
--- a/apps/server/Databases/AliasServerDb/AliasServerDbContext.cs
+++ b/apps/server/Databases/AliasServerDb/AliasServerDbContext.cs
@@ -87,7 +87,7 @@ public class AliasServerDbContext : WorkerStatusDbContext, IDataProtectionKeyCon
public DbSet<Email> Emails { get; set; }
/// <summary>
- /// Gets or sets the EmailAttachments DbSet.
+ /// Gets or sets the EmailAttachments DbSet. Deprecated and read-only since 0.31.0, see <see cref="EmailAttachment"/>.
/// </summary>
public DbSet<EmailAttachment> EmailAttachments { get; set; }
diff --git a/apps/server/Databases/AliasServerDb/Email.cs b/apps/server/Databases/AliasServerDb/Email.cs
index 37df31829..cf17a1f4d 100644
--- a/apps/server/Databases/AliasServerDb/Email.cs
+++ b/apps/server/Databases/AliasServerDb/Email.cs
@@ -119,7 +119,9 @@ public class Email
public bool PushNotificationSent { get; set; }
/// <summary>
- /// Gets or sets the collection of email attachments.
+ /// Gets or sets the collection of email attachments. Only populated for legacy emails: no longer written since
+ /// 0.31.0, as attachments are carried inline in the message source. See <see cref="EmailAttachment"/> for the
+ /// conditions under which this table can be dropped.
/// </summary>
public virtual List<EmailAttachment> Attachments { get; set; } = [];
diff --git a/apps/server/Databases/AliasServerDb/EmailAttachment.cs b/apps/server/Databases/AliasServerDb/EmailAttachment.cs
index e1899a9a8..f7b410a15 100644
--- a/apps/server/Databases/AliasServerDb/EmailAttachment.cs
+++ b/apps/server/Databases/AliasServerDb/EmailAttachment.cs
@@ -11,6 +11,14 @@ using Microsoft.EntityFrameworkCore;
/// <summary>
/// Represents an email attachment.
+/// <para>
+/// DEPRECATED: no longer written since 0.31.0 and no longer served by the v2 API. Attachments live inline in the
+/// message source for both storage formats, so these rows are a duplicate copy of bytes the clients already parse
+/// out of <see cref="Email.MessageSourceBytes"/> (source-only format) or <see cref="Email.MessageSource"/> (legacy).
+/// </para>
+/// <para>
+/// TODO: drop this table once all clients are upgraded.
+/// </para>
/// </summary>
[Index(nameof(EmailId))]
public class EmailAttachment
diff --git a/apps/server/Databases/AliasServerDb/Migrations/20260810200139_EmailStorageFormatV2.cs b/apps/server/Databases/AliasServerDb/Migrations/20260810200139_EmailStorageFormatV2.cs
index 643001f2d..99068b2a8 100644
--- a/apps/server/Databases/AliasServerDb/Migrations/20260810200139_EmailStorageFormatV2.cs
+++ b/apps/server/Databases/AliasServerDb/Migrations/20260810200139_EmailStorageFormatV2.cs
@@ -25,6 +25,14 @@ namespace AliasServerDb.Migrations
nullable: false,
defaultValue: 0);
+ // Backfill the count for emails that predate this column from their attachment records, so the column is
+ // authoritative for every row in the table.
+ migrationBuilder.Sql("""
+ UPDATE "Emails" SET "AttachmentCount" = counts."AttachmentCount"
+ FROM (SELECT "EmailId", COUNT(*) AS "AttachmentCount" FROM "EmailAttachments" GROUP BY "EmailId") AS counts
+ WHERE "Emails"."Id" = counts."EmailId";
+ """);
+
migrationBuilder.AddColumn<byte[]>(
name: "MessageSourceBytes",
table: "Emails",
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/EmailApiModel.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/EmailApiModel.cs
index 96023a669..5d3c1676d 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/EmailApiModel.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/EmailApiModel.cs
@@ -24,15 +24,4 @@ public class EmailApiModel : EmailApiModelBase
/// only filled in for legacy emails (pre-0.31.0) and will be removed from the DB in a future version.
/// </summary>
public string? MessageSource { get; set; }
-
- /// <summary>
- /// Gets or sets the number of attachments contained in the email message.
- /// </summary>
- public int AttachmentCount { get; set; }
-
- /// <summary>
- /// Gets or sets the list of attachments in the email. Only populated for legacy emails that carry
- /// separate attachment records; for source-only emails clients extract attachments from the parsed source.
- /// </summary>
- public List<AttachmentApiModel> Attachments { get; set; } = [];
}
diff --git a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/MailboxBulkResponse.cs b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/MailboxBulkResponse.cs
index c814cf5d5..a694ef58d 100644
--- a/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/MailboxBulkResponse.cs
+++ b/apps/server/Shared/AliasVault.Shared/Models/WebApi/V2/Email/MailboxBulkResponse.cs
@@ -12,11 +12,6 @@ namespace AliasVault.Shared.Models.WebApi.V2.Email;
/// </summary>
public class MailboxBulkResponse
{
- /// <summary>
- /// Gets or sets the mailbox addresses that client wants to retrieve emails for.
- /// </summary>
- public List<string> Addresses { get; set; } = [];
-
/// <summary>
/// Gets or sets requested page number.
/// </summary>
diff --git a/core/models/src/webapi/Email.ts b/core/models/src/webapi/Email.ts
index efb473856..bcf93d4cf 100644
--- a/core/models/src/webapi/Email.ts
+++ b/core/models/src/webapi/Email.ts
@@ -5,9 +5,6 @@ export type Email = {
/** The raw RFC 822 source of the email message (ciphertext, base64) */
messageSource: string;
- /** The number of attachments contained in the email message */
- attachmentCount: number;
-
/** The ID of the email */
id: number;
@@ -43,7 +40,4 @@ export type Email = {
/** The public keys referenced by this email's decryption keys, indexed by EmailDecryptionKey.keyIndex */
publicKeys: string[];
-
- /** The attachments of the email */
- attachments: EmailAttachment[];
}
diff --git a/core/models/src/webapi/MailboxBulk.ts b/core/models/src/webapi/MailboxBulk.ts
index 5e390852a..8563a3bf6 100644
--- a/core/models/src/webapi/MailboxBulk.ts
+++ b/core/models/src/webapi/MailboxBulk.ts
@@ -13,7 +13,6 @@ export type MailboxBulkRequest = {
* Mailbox bulk response type.
*/
export type MailboxBulkResponse = {
- addresses: string[];
currentPage: number;
pageSize: number;
totalRecords: number;