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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
<?php
declare(strict_types=1);
/**
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
*
* Mail
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCA\Mail\Contracts;
use OCA\Mail\Account;
use OCA\Mail\Db\Mailbox;
use OCA\Mail\Db\Message;
use OCA\Mail\Exception\ClientException;
use OCA\Mail\Exception\ServiceException;
use OCA\Mail\Folder;
use OCA\Mail\IMAP\FolderStats;
use OCA\Mail\Model\IMAPMessage;
use OCA\Mail\Service\Quota;
use OCP\AppFramework\Db\DoesNotExistException;
interface IMailManager {
/**
* @param string $uid
* @param int $id
*
* @return Mailbox
*
* @throws DoesNotExistException
*/
public function getMailbox(string $uid, int $id): Mailbox;
/**
* @param Account $account
*
* @return Mailbox[]
*
* @throws ServiceException
*/
public function getMailboxes(Account $account): array;
/**
* @param Account $account
* @param string $name
*
* @return Mailbox
*
* @throws ServiceException
*/
public function createMailbox(Account $account, string $name): Mailbox;
/**
* @param Account $account
* @param Mailbox $mailbox
*
* @return FolderStats
*/
public function getMailboxStats(Account $account, Mailbox $mailbox): FolderStats;
/**
* @param Mailbox $mailbox
* @param $uid
*
* @return int|null
*/
public function getMessageIdForUid(Mailbox $mailbox, $uid): ?int;
/**
* @param string $uid
* @param int $id
*
* @return Message
*
* @throws ClientException
*/
public function getMessage(string $uid, int $id): Message;
/**
* @param Account $account
* @param string $mailbox
* @param int $uid
*
* @return string
* @throws ClientException
* @throws ServiceException
*/
public function getSource(Account $account, string $mailbox, int $uid): ?string;
/**
* @param Account $account
* @param Mailbox $mailbox
* @param int $uid
* @param bool $loadBody
*
* @return IMAPMessage
*
* @throws ServiceException
*/
public function getImapMessage(Account $account,
Mailbox $mailbox,
int $uid,
bool $loadBody = false): IMAPMessage;
/**
* @param Account $account
* @param int $messageId database message ID
*
* @return Message[]
*/
public function getThread(Account $account, int $messageId): array;
/**
* @param Account $sourceAccount
* @param string $sourceFolderId
* @param int $uid
* @param Account $destinationAccount
* @param string $destFolderId
*
* @throws ServiceException
*/
public function moveMessage(Account $sourceAccount,
string $sourceFolderId,
int $uid,
Account $destinationAccount,
string $destFolderId);
/**
* @param Account $account
* @param string $mailboxId
* @param int $messageId
*
* @throws ClientException
* @throws ServiceException
*/
public function deleteMessage(Account $account, string $mailboxId, int $messageId): void;
/**
* Mark all messages of a folder as read
*
* @param Account $account
* @param Mailbox $mailbox
*/
public function markFolderAsRead(Account $account, Mailbox $mailbox): void;
/**
* @param Account $account
* @param string $mailbox
* @param int $uid
* @param string $flag
* @param bool $value
*
* @throws ClientException
* @throws ServiceException
*/
public function flagMessage(Account $account, string $mailbox, int $uid, string $flag, bool $value): void;
/**
* @param Account $account
*
* @return Quota|null
*/
public function getQuota(Account $account): ?Quota;
/**
* Rename a mailbox and get the new (cached) version
*
* @param Account $account
* @param Mailbox $mailbox
* @param string $name
*
* @return Mailbox
*
* @throw ServiceException
*/
public function renameMailbox(Account $account, Mailbox $mailbox, string $name): Mailbox;
/**
* @param Account $account
* @param Mailbox $mailbox
*
* @throws ServiceException
*/
public function deleteMailbox(Account $account, Mailbox $mailbox): void;
/**
* @param Account $account
* @param Mailbox $mailbox
* @param bool $subscribed
*
* @return Mailbox
* @throws ClientException
* @throws ServiceException
*/
public function updateSubscription(Account $account,
Mailbox $mailbox,
bool $subscribed): Mailbox;
/**
* @param Mailbox $mailbox
* @param bool $syncInBackground
*
* @return Mailbox
* @throws ClientException
* @throws ServiceException
*/
public function enableMailboxBackgroundSync(Mailbox $mailbox,
bool $syncInBackground): Mailbox;
/**
* @param Account $account
* @param Mailbox $mailbox
* @param Message $message
* @return array
*/
public function getMailAttachments(Account $account, Mailbox $mailbox, Message $message) : array;
}
|
