ImapEngine/src/FlaggableInterface.php at 5a9315291429bc8a8e5455adef77c70453e8ad92 · DirectoryTree/ImapEngine · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<?php

namespace DirectoryTree\ImapEngine;

use BackedEnum;

interface FlaggableInterface
{
    /**
     * Mark the message as read. Alias for markSeen.
     */
    public function markRead(): void;

    /**
     * Mark the message as unread. Alias for unmarkSeen.
     */
    public function markUnread(): void;

    /**
     * Mark the message as seen.
     */
    public function markSeen(): void;

    /**
     * Unmark the seen flag.
     */
    public function unmarkSeen(): void;

    /**
     * Mark the message as answered.
     */
    public function markAnswered(): void;

    /**
     * Unmark the answered flag.
     */
    public function unmarkAnswered(): void;

    /**
     * Mark the message as flagged.
     */
    public function markFlagged(): void;

    /**
     * Unmark the flagged flag.
     */
    public function unmarkFlagged(): void;

    /**
     * Mark the message as deleted.
     */
    public function markDeleted(bool $expunge = false): void;

    /**
     * Unmark the deleted flag.
     */
    public function unmarkDeleted(): void;

    /**
     * Mark the message as a draft.
     */
    public function markDraft(): void;

    /**
     * Unmark the draft flag.
     */
    public function unmarkDraft(): void;

    /**
     * Mark the message as recent.
     */
    public function markRecent(): void;

    /**
     * Unmark the recent flag.
     */
    public function unmarkRecent(): void;

    /**
     * Determine if the message is marked as seen.
     */
    public function isSeen(): bool;

    /**
     * Determine if the message is marked as answered.
     */
    public function isAnswered(): bool;

    /**
     * Determine if the message is flagged.
     */
    public function isFlagged(): bool;

    /**
     * Determine if the message is marked as deleted.
     */
    public function isDeleted(): bool;

    /**
     * Determine if the message is marked as a draft.
     */
    public function isDraft(): bool;

    /**
     * Determine if the message is marked as recent.
     */
    public function isRecent(): bool;

    /**
     * Get the message's flags.
     *
     * @return string[]
     */
    public function flags(): array;

    /**
     * Determine if the message has the given flag.
     */
    public function hasFlag(BackedEnum|string $flag): bool;

    /**
     * Add or remove a flag from the message.
     */
    public function flag(BackedEnum|string $flag, string $operation, bool $expunge = false): void;
}