Skip to content

fix(imap): cache message body #12082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kesselb merged 1 commit into from
Nov 26, 2025
Merged

fix(imap): cache message body #12082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 39 additions & 15 deletions lib/Controller/MessagesController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@
use OCP\Files\GenericFileException;
use OCP\Files\IMimeTypeDetector;
use OCP\Files\NotPermittedException;
use OCP\ICache;
use OCP\ICacheFactory;
use OCP\IL10N;
use OCP\IRequest;
use OCP\IURLGenerator;
Expand Down Expand Up @@ -74,7 +76,8 @@ class MessagesController extends Controller {
private SnoozeService $snoozeService;
private AiIntegrationsService $aiIntegrationService;

public function __construct(string $appName,
public function __construct(
string $appName,
IRequest $request,
AccountService $accountService,
IMailManager $mailManager,
Expand All @@ -94,7 +97,9 @@ public function __construct(string $appName,
IDkimService $dkimService,
IUserPreferences $preferences,
SnoozeService $snoozeService,
AiIntegrationsService $aiIntegrationService) {
AiIntegrationsService $aiIntegrationService,
private ICacheFactory $cacheFactory,
) {
parent::__construct($appName, $request);
$this->accountService = $accountService;
$this->mailManager = $mailManager;
Expand Down Expand Up @@ -218,6 +223,9 @@ public function getBody(int $id): JSONResponse {
return new JSONResponse([], Http::STATUS_FORBIDDEN);
}

$cacheInstance = $this->getCacheForAccount($account->getId());
$imapMessageCacheKey = 'message_' . $id;

$client = $this->clientFactory->getClient($account);
try {
$imapMessage = $this->mailManager->getImapMessage(
Expand All @@ -226,6 +234,11 @@ public function getBody(int $id): JSONResponse {
$mailbox,
$message->getUid(), true
);

if ($imapMessage->hasHtmlMessage()) {
$cacheInstance->set($imapMessageCacheKey, $imapMessage->getHtmlBody($id), 600);
}

$json = $imapMessage->getFullMessage($id);
} finally {
$client->logout();
Expand Down Expand Up @@ -571,21 +584,28 @@ public function getHtmlBody(int $id, bool $plain = false): Response {
);
}

$client = $this->clientFactory->getClient($account);
try {
$html = $this->mailManager->getImapMessage(
$client,
$account,
$mailbox,
$message->getUid(),
true
)->getHtmlBody(
$id
);
} finally {
$client->logout();
$cacheInstance = $this->getCacheForAccount($account->getId());
$imapMessageCacheKey = 'message_' . $id;

$html = $cacheInstance->get($imapMessageCacheKey);
if ($html === null) {
$client = $this->clientFactory->getClient($account);
try {
$html = $this->mailManager->getImapMessage(
$client,
$account,
$mailbox,
$message->getUid(),
true
)->getHtmlBody(
$id
);
} finally {
$client->logout();
}
}


$htmlResponse = $plain
? HtmlResponse::plain($html)
: HtmlResponse::withResizer(
Expand Down Expand Up @@ -1001,4 +1021,8 @@ private function attachmentIsImage(array $attachment): bool {
private function attachmentIsCalendarEvent(array $attachment): bool {
return in_array($attachment['mime'], ['text/calendar', 'application/ics'], true);
}

private function getCacheForAccount(int $accountId): ICache {
return $this->cacheFactory->createDistributed('mail_account_' . $accountId);
Copy link
Copy Markdown
Member

@ChristophWurst ChristophWurst Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing check for cache availability?

Copy link
Copy Markdown
Contributor Author

@kesselb kesselb Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The check for cache availability is not missing. createDistributed might return a null cache instance; that's fine and we just go ahead and fetch the part.

}
}
4 changes: 4 additions & 0 deletions lib/Model/IMAPMessage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,10 @@ public static function generateMessageId(): string {
return Horde_Mime_Headers_MessageId::create('nextcloud-mail-generated')->value;
}

public function hasHtmlMessage(): bool {
return $this->hasHtmlMessage;
}

/**
* @return int
*/
Expand Down
10 changes: 10 additions & 0 deletions tests/Unit/Controller/MessagesControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use ChristophWurst\Nextcloud\Testing\TestCase;
use Horde_Imap_Client_Socket;
use OC\AppFramework\Http\Request;
use OC\Memcache\NullCache;
use OC\Security\CSP\ContentSecurityPolicyNonceManager;
use OCA\Mail\Account;
use OCA\Mail\Attachment;
Expand Down Expand Up @@ -48,6 +49,7 @@
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Files\Folder;
use OCP\Files\IMimeTypeDetector;
use OCP\ICacheFactory;
use OCP\IL10N;
use OCP\IRequest;
use OCP\IURLGenerator;
Expand Down Expand Up @@ -130,6 +132,8 @@ class MessagesControllerTest extends TestCase {
/** @var MockObject|AiIntegrationsService */
private $aiIntegrationsService;

private ICacheFactory&MockObject $cacheFactory;

protected function setUp(): void {
parent::setUp();

Expand All @@ -155,6 +159,10 @@ protected function setUp(): void {
$this->userPreferences = $this->createMock(IUserPreferences::class);
$this->snoozeService = $this->createMock(SnoozeService::class);
$this->aiIntegrationsService = $this->createMock(AiIntegrationsService::class);
$this->cacheFactory = $this->createMock(ICacheFactory::class);

$this->cacheFactory->method('createDistributed')
->willReturn(new NullCache());

$timeFactory = $this->createMocK(ITimeFactory::class);
$timeFactory->expects($this->any())
Expand Down Expand Up @@ -185,6 +193,7 @@ protected function setUp(): void {
$this->userPreferences,
$this->snoozeService,
$this->aiIntegrationsService,
$this->cacheFactory,
);

$this->account = $this->createMock(Account::class);
Expand Down Expand Up @@ -1241,6 +1250,7 @@ public function testNeedsTranslationNoUser() {
$this->userPreferences,
$this->snoozeService,
$this->aiIntegrationsService,
$this->cacheFactory,
);

$actualResponse = $controller->needsTranslation(100);
Expand Down
Loading