Skip to content

feat: add endpoint to set message flags via the OCS API #13505

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
steven-mpawulo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add endpoint to set message flags via the OCS API #13505

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
41 changes: 41 additions & 0 deletions lib/Controller/MessageApiController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,4 +488,45 @@ private function handleAttachments(): array {

return $messageAttachments;
}

/**
* Set flags (e.g. seen/unseen) on a mail message
*
* @param int $id the message id
* @param array<string, bool> $flags Flags to set, e.g. {"seen": true} to mark as read, {"seen": false} to mark as unread
* @return DataResponse<Http::STATUS_OK, string, array{}>|DataResponse<Http::STATUS_NOT_FOUND, string, array{}>
*
* 200: Flags updated successfully
* 404: User, Message, Account or Mailbox not found
* @throws ClientException
* @throws ServiceException
*/
#[ApiRoute(verb: 'POST', url: '/message/{id}/flags')]
#[NoAdminRequired]
#[NoCSRFRequired]
#[TrapError]
public function setFlags(int $id, array $flags): DataResponse {
if ($this->userId === null) {
return new DataResponse('Account not found.', Http::STATUS_NOT_FOUND);
}
try {
$effectiveUserId = $this->delegationService->resolveMessageUserId($id, $this->userId);
$message = $this->mailManager->getMessage($effectiveUserId, $id);
$mailbox = $this->mailManager->getMailbox($effectiveUserId, $message->getMailboxId());
$account = $this->accountService->find($effectiveUserId, $mailbox->getAccountId());
} catch (DoesNotExistException $e) {
$this->logger->error('Message, Account or Mailbox not found', ['exception' => $e->getMessage()]);
return new DataResponse('Message, Account or Mailbox not found', Http::STATUS_NOT_FOUND);
}

$flagChanges = [];
foreach ($flags as $flag => $value) {
$value = filter_var($value, FILTER_VALIDATE_BOOLEAN);
$this->mailManager->flagMessage($account, $mailbox->getName(), $message->getUid(), $flag, $value);
$flagChanges[] = "$flag=" . ($value ? 'true' : 'false');
}
$flagsSummary = implode(', ', $flagChanges);
$this->delegationService->logDelegatedAction($this->userId, $effectiveUserId, "$this->userId updated flags on message <$id> with [$flagsSummary] on behalf of $effectiveUserId");
return new DataResponse('', Http::STATUS_OK);
}
}
Loading
Loading