Skip to content

feat: provide attachement names for messages #11596

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: provide attachement names for messages #11596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
185eb96
enh: provide attachement names for messages
hamza221 Aug 28, 2025
0ddc79c
fixup! enh: provide attachement names for messages
hamza221 Aug 29, 2025
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
1 change: 1 addition & 0 deletions lib/Contracts/IAttachmentService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,5 @@ public function getAttachment(string $userId, int $id): array;
* @param int $id
*/
public function deleteAttachment(string $userId, int $id);

}
11 changes: 11 additions & 0 deletions lib/Db/Message.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,8 @@ class Message extends Entity implements JsonSerializable {

/** @var bool */
private $fetchAvatarFromClient = false;
/** @var array */
private $attachments = [];

public function __construct() {
$this->from = new AddressList([]);
Expand Down Expand Up @@ -312,6 +314,14 @@ public function getAvatar(): ?Avatar {
return $this->avatar;
}

public function setAttachments(array $attachments): void {
$this->attachments = $attachments;
}

public function getAttachments(): array {
return $this->attachments;
}

#[\Override]
#[ReturnTypeWillChange]
public function jsonSerialize() {
Expand Down Expand Up @@ -359,6 +369,7 @@ static function (Tag $tag) {
'mentionsMe' => $this->getMentionsMe(),
'avatar' => $this->avatar?->jsonSerialize(),
'fetchAvatarFromClient' => $this->fetchAvatarFromClient,
'attachments' => $this->getAttachments(),
];
}
}
16 changes: 13 additions & 3 deletions lib/IMAP/PreviewEnhancer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use OCA\Mail\Db\Message;
use OCA\Mail\Db\MessageMapper as DbMapper;
use OCA\Mail\IMAP\MessageMapper as ImapMapper;
use OCA\Mail\Service\Attachment\AttachmentService;
use OCA\Mail\Service\Avatar\Avatar;
use OCA\Mail\Service\AvatarService;
use Psr\Log\LoggerInterface;
Expand All @@ -39,11 +40,14 @@ class PreviewEnhancer {
/** @var AvatarService */
private $avatarService;

public function __construct(IMAPClientFactory $clientFactory,
public function __construct(
IMAPClientFactory $clientFactory,
ImapMapper $imapMapper,
DbMapper $dbMapper,
LoggerInterface $logger,
AvatarService $avatarService) {
AvatarService $avatarService,
private AttachmentService $attachmentService,
) {
$this->clientFactory = $clientFactory;
$this->imapMapper = $imapMapper;
$this->mapper = $dbMapper;
Expand All @@ -65,6 +69,12 @@ public function process(Account $account, Mailbox $mailbox, array $messages, boo

return array_merge($carry, [$message->getUid()]);
}, []);
$client = $this->clientFactory->getClient($account);

foreach ($messages as $message) {
$attachments = $this->attachmentService->getAttachmentNames($account, $mailbox, $message, $client);
$message->setAttachments($attachments);
}

if ($preLoadAvatars) {
foreach ($messages as $message) {
Expand All @@ -87,7 +97,7 @@ public function process(Account $account, Mailbox $mailbox, array $messages, boo
return $messages;
}

$client = $this->clientFactory->getClient($account);

try {
$data = $this->imapMapper->getBodyStructureData(
$client,
Expand Down
3 changes: 2 additions & 1 deletion lib/Model/IMAPMessage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,7 @@ public function getSentDate(): Horde_Imap_Client_DateTime {
return $this->imapDate;
}


/**
* @param int $id
*
Expand Down Expand Up @@ -384,7 +385,7 @@ public function setContent(string $content) {
*/
#[\Override]
public function getAttachments(): array {
throw new Exception('not implemented');
return $this->attachments;
}

/**
Expand Down
36 changes: 36 additions & 0 deletions lib/Service/Attachment/AttachmentService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,18 @@
use OCA\Mail\Db\LocalAttachment;
use OCA\Mail\Db\LocalAttachmentMapper;
use OCA\Mail\Db\LocalMessage;
use OCA\Mail\Db\Mailbox;
use OCA\Mail\Db\Message;
use OCA\Mail\Exception\AttachmentNotFoundException;
use OCA\Mail\Exception\ServiceException;
use OCA\Mail\Exception\UploadException;
use OCA\Mail\IMAP\MessageMapper;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\Files\File;
use OCP\Files\Folder;
use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
use OCP\ICacheFactory;
use Psr\Log\LoggerInterface;

class AttachmentService implements IAttachmentService {
Expand All @@ -51,6 +55,10 @@
* @var LoggerInterface
*/
private $logger;
/**
* @var ICache

Check failure on line 59 in lib/Service/Attachment/AttachmentService.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-master

UndefinedDocblockClass 

lib/Service/Attachment/AttachmentService.php:59:10: UndefinedDocblockClass: Docblock-defined class, interface or enum named OCA\Mail\Service\Attachment\ICache does not exist (see https://psalm.dev/200)
*/
private $cache;

/**
* @param Folder $userFolder
Expand All @@ -60,13 +68,15 @@
AttachmentStorage $storage,
IMailManager $mailManager,
MessageMapper $imapMessageMapper,
ICacheFactory $cacheFactory,
LoggerInterface $logger) {
$this->mapper = $mapper;
$this->storage = $storage;
$this->mailManager = $mailManager;
$this->messageMapper = $imapMessageMapper;
$this->userFolder = $userFolder;
$this->logger = $logger;
$this->cache = $cacheFactory->createLocal('mail.attachment_names');

Check failure on line 79 in lib/Service/Attachment/AttachmentService.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-master

InvalidPropertyAssignmentValue 

lib/Service/Attachment/AttachmentService.php:79:18: InvalidPropertyAssignmentValue: $this->cache with declared type 'OCA\Mail\Service\Attachment\ICache' cannot be assigned type 'OCP\ICache' (see https://psalm.dev/145)
}

/**
Expand Down Expand Up @@ -249,6 +259,32 @@
return array_values(array_filter($attachmentIds));
}

public function getAttachmentNames(Account $account, Mailbox $mailbox, Message $message, \Horde_Imap_Client_Socket $client): array {
$attachments = [];
$uniqueCacheId = $account->getUserId() . $account->getId() . $mailbox->getId() . $message->getUid();
$cached = $this->cache->get($uniqueCacheId);

Check failure on line 265 in lib/Service/Attachment/AttachmentService.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-master

UndefinedDocblockClass 

lib/Service/Attachment/AttachmentService.php:265:13: UndefinedDocblockClass: Docblock-defined class, interface or enum named OCA\Mail\Service\Attachment\ICache does not exist (see https://psalm.dev/200)
if ($cached) {
return $cached;
}
try {
$imapMessage = $this->mailManager->getImapMessage(
$client,
$account,
$mailbox,
$message->getUid(),
true
);
$attachments = $imapMessage->getAttachments();
} catch (ServiceException $e) {
$this->logger->error('Could not get attachment names', ['exception' => $e, 'messageId' => $message->getUid()]);
}
$result = array_map(static function (array $attachment) {

Check failure on line 281 in lib/Service/Attachment/AttachmentService.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-master

InvalidArgument 

lib/Service/Attachment/AttachmentService.php:281:23: InvalidArgument: Parameter 1 of closure passed to function array_map expects array<array-key, mixed>, but Horde_Mime_Part provided (see https://psalm.dev/004)
return ['name' => $attachment['fileName'],'mime' => $attachment['mime']];
}, $attachments);
$this->cache->set($uniqueCacheId, $result);

Check failure on line 284 in lib/Service/Attachment/AttachmentService.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-master

UndefinedDocblockClass 

lib/Service/Attachment/AttachmentService.php:284:3: UndefinedDocblockClass: Docblock-defined class, interface or enum named OCA\Mail\Service\Attachment\ICache does not exist (see https://psalm.dev/200)
return $result;
}

/**
* Add a message as attachment
*
Expand Down
Loading