Skip to content

Add support for IMAP keywords #607 #608

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

Add support for IMAP keywords #607 #608

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
17 changes: 15 additions & 2 deletions src/Message.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1176,7 +1176,7 @@ public function restore(bool $expunge = true): bool {
*/
public function setFlag(array|string $flag): bool {
$this->client->openFolder($this->folder_path);
$flag = "\\" . trim(is_array($flag) ? implode(" \\", $flag) : $flag);
$flag = self::sanitizeFlags($flag);
$sequence_id = $this->getSequenceId();
try {
$status = $this->client->getConnection()->store([$flag], $sequence_id, $sequence_id, "+", true, $this->sequence)->validatedData();
Expand Down Expand Up @@ -1207,7 +1207,7 @@ public function setFlag(array|string $flag): bool {
public function unsetFlag(array|string $flag): bool {
$this->client->openFolder($this->folder_path);

$flag = "\\" . trim(is_array($flag) ? implode(" \\", $flag) : $flag);
$flag = self::sanitizeFlags($flag);
$sequence_id = $this->getSequenceId();
try {
$status = $this->client->getConnection()->store([$flag], $sequence_id, $sequence_id, "-", true, $this->sequence)->validatedData();
Expand Down Expand Up @@ -1257,6 +1257,19 @@ public function removeFlag(array|string $flag): bool {
return $this->unsetFlag($flag);
}

/**
* Format the flag string.
* Allows keywords like $MDNSent or $Forwarded
* @param array|string $flag
*
* @return string
*/
public static function sanitizeFlags(array|string $flag): string {
return trim(is_array($flag)
? (implode(" ", array_map(fn ($flag) => str_starts_with($flag, '$') ? $flag : "\\$flag", $flag)))
: (str_starts_with($flag, '$') ? $flag : "\\$flag"));
}

/**
* Get all message attachments.
*
Expand Down
6 changes: 6 additions & 0 deletions tests/MessageTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,12 @@ public function testIssue348() {
self::assertSame("application/pdf", $attachment->getMimeType());
}

public function testSanitizeFlag(): void {
self::assertEquals('\\Seen', Message::sanitizeFlags('Seen'));
self::assertEquals('$Forwarded', Message::sanitizeFlags('$Forwarded'));
self::assertEquals('\\Seen $MDNSent $Junk \\Flagged', Message::sanitizeFlags(['Seen', '$MDNSent', '$Junk', 'Flagged']));
}

/**
* Create a new protocol mockup
*
Expand Down