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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
|
<?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\Service;
use Horde_Imap_Client;
use Horde_Imap_Client_Exception;
use Horde_Imap_Client_Exception_NoSupportExtension;
use OCA\Mail\Account;
use OCA\Mail\Contracts\IMailManager;
use OCA\Mail\Db\Mailbox;
use OCA\Mail\Db\MailboxMapper;
use OCA\Mail\Db\Message;
use OCA\Mail\Db\MessageMapper as DbMessageMapper;
use OCA\Mail\Events\BeforeMessageDeletedEvent;
use OCA\Mail\Events\MessageDeletedEvent;
use OCA\Mail\Events\MessageFlaggedEvent;
use OCA\Mail\Exception\ClientException;
use OCA\Mail\Exception\ServiceException;
use OCA\Mail\Exception\TrashMailboxNotSetException;
use OCA\Mail\Folder;
use OCA\Mail\IMAP\FolderMapper;
use OCA\Mail\IMAP\FolderStats;
use OCA\Mail\IMAP\IMAPClientFactory;
use OCA\Mail\IMAP\MailboxSync;
use OCA\Mail\IMAP\MessageMapper as ImapMessageMapper;
use OCA\Mail\Model\IMAPMessage;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\EventDispatcher\IEventDispatcher;
use Psr\Log\LoggerInterface;
use function array_map;
use function array_values;
class MailManager implements IMailManager {
/**
* https://tools.ietf.org/html/rfc3501#section-2.3.2
*/
private const ALLOWED_FLAGS = [
'seen' => [Horde_Imap_Client::FLAG_SEEN],
'answered' => [Horde_Imap_Client::FLAG_ANSWERED],
'flagged' => [Horde_Imap_Client::FLAG_FLAGGED],
'deleted' => [Horde_Imap_Client::FLAG_DELETED],
'draft' => [Horde_Imap_Client::FLAG_DRAFT],
'recent' => [Horde_Imap_Client::FLAG_RECENT],
'junk' => [Horde_Imap_Client::FLAG_JUNK, 'junk'],
'mdnsent' => [Horde_Imap_Client::FLAG_MDNSENT],
];
/** @var IMAPClientFactory */
private $imapClientFactory;
/** @var MailboxSync */
private $mailboxSync;
/** @var MailboxMapper */
private $mailboxMapper;
/** @var FolderMapper */
private $folderMapper;
/** @var ImapMessageMapper */
private $imapMessageMapper;
/** @var DbMessageMapper */
private $dbMessageMapper;
/** @var IEventDispatcher */
private $eventDispatcher;
/**
* @var LoggerInterface
*/
private $logger;
public function __construct(IMAPClientFactory $imapClientFactory,
MailboxMapper $mailboxMapper,
MailboxSync $mailboxSync,
FolderMapper $folderMapper,
ImapMessageMapper $messageMapper,
DbMessageMapper $dbMessageMapper,
IEventDispatcher $eventDispatcher,
LoggerInterface $logger) {
$this->imapClientFactory = $imapClientFactory;
$this->mailboxMapper = $mailboxMapper;
$this->mailboxSync = $mailboxSync;
$this->folderMapper = $folderMapper;
$this->imapMessageMapper = $messageMapper;
$this->dbMessageMapper = $dbMessageMapper;
$this->eventDispatcher = $eventDispatcher;
$this->logger = $logger;
}
public function getMailbox(string $uid, int $id): Mailbox {
try {
return $this->mailboxMapper->findByUid($id, $uid);
} catch (DoesNotExistException $e) {
throw new ClientException("Mailbox $id does not exist", 0, $e);
}
}
/**
* @param Account $account
*
* @return Mailbox[]
* @throws ServiceException
*/
public function getMailboxes(Account $account): array {
$this->mailboxSync->sync($account, $this->logger);
return $this->mailboxMapper->findAll($account);
}
/**
* @param Account $account
* @param string $name
*
* @return Mailbox
* @throws ServiceException
*/
public function createMailbox(Account $account, string $name): Mailbox {
$client = $this->imapClientFactory->getClient($account);
$folder = $this->folderMapper->createFolder($client, $account, $name);
try {
$this->folderMapper->getFoldersStatus([$folder], $client);
} catch (Horde_Imap_Client_Exception $e) {
throw new ServiceException(
"Could not get mailbox status: " .
$e->getMessage(),
(int) $e->getCode(),
$e
);
}
$this->folderMapper->detectFolderSpecialUse([$folder]);
$this->mailboxSync->sync($account, $this->logger,true);
return $this->mailboxMapper->find($account, $name);
}
/**
* @param Account $account
* @param Mailbox $mailbox
*
* @return FolderStats
* @throws Horde_Imap_Client_Exception
*/
public function getMailboxStats(Account $account, Mailbox $mailbox): FolderStats {
$client = $this->imapClientFactory->getClient($account);
return $this->folderMapper->getFoldersStatusAsObject($client, $mailbox->getName());
}
public function getImapMessage(Account $account,
Mailbox $mailbox,
int $uid,
bool $loadBody = false): IMAPMessage {
$client = $this->imapClientFactory->getClient($account);
try {
return $this->imapMessageMapper->find(
$client,
$mailbox->getName(),
$uid,
$loadBody
);
} catch (Horde_Imap_Client_Exception | DoesNotExistException $e) {
throw new ServiceException(
"Could not load message",
(int) $e->getCode(),
$e
);
}
}
public function getThread(Account $account, int $messageId): array {
return $this->dbMessageMapper->findThread($account, $messageId);
}
public function getMessageIdForUid(Mailbox $mailbox, $uid): ?int {
return $this->dbMessageMapper->getIdForUid($mailbox, $uid);
}
public function getMessage(string $uid, int $id): Message {
return $this->dbMessageMapper->findByUserId($uid, $id);
}
/**
* @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 {
$client = $this->imapClientFactory->getClient($account);
try {
return $this->imapMessageMapper->getFullText(
$client,
$mailbox,
$uid
);
} catch (Horde_Imap_Client_Exception | DoesNotExistException $e) {
throw new ServiceException("Could not load message", 0, $e);
}
}
/**
* @param Account $sourceAccount
* @param string $sourceFolderId
* @param int $uid
* @param Account $destinationAccount
* @param string $destFolderId
*
* @return void
* @throws ServiceException
*
*/
public function moveMessage(Account $sourceAccount,
string $sourceFolderId,
int $uid,
Account $destinationAccount,
string $destFolderId) {
if ($sourceAccount->getId() === $destinationAccount->getId()) {
try {
$sourceMailbox = $this->mailboxMapper->find($sourceAccount, $sourceFolderId);
} catch (DoesNotExistException $e) {
throw new ServiceException("Source mailbox $sourceFolderId does not exist", 0, $e);
}
$this->moveMessageOnSameAccount(
$sourceAccount,
$sourceFolderId,
$destFolderId,
$uid
);
// Delete cached source message (the source imap message is copied and deleted)
$this->eventDispatcher->dispatch(
MessageDeletedEvent::class,
new MessageDeletedEvent($sourceAccount, $sourceMailbox, $uid)
);
} else {
throw new ServiceException('It is not possible to move across accounts yet');
}
}
/**
* @throws ClientException
* @throws ServiceException
* @todo evaluate if we should sync mailboxes first
*/
public function deleteMessage(Account $account,
string $mailboxId,
int $messageId): void {
$this->eventDispatcher->dispatch(
BeforeMessageDeletedEvent::class,
new BeforeMessageDeletedEvent($account, $mailboxId, $messageId)
);
try {
$sourceMailbox = $this->mailboxMapper->find($account, $mailboxId);
} catch (DoesNotExistException $e) {
throw new ServiceException("Source mailbox $mailboxId does not exist", 0, $e);
}
try {
$trashMailboxId = $account->getMailAccount()->getTrashMailboxId();
if ($trashMailboxId === null) {
throw new TrashMailboxNotSetException();
}
$trashMailbox = $this->mailboxMapper->findById($trashMailboxId);
} catch (DoesNotExistException $e) {
throw new ServiceException("No trash folder", 0, $e);
}
if ($mailboxId === $trashMailbox->getName()) {
// Delete inside trash -> expunge
$this->imapMessageMapper->expunge(
$this->imapClientFactory->getClient($account),
$sourceMailbox->getName(),
$messageId
);
} else {
$this->imapMessageMapper->move(
$this->imapClientFactory->getClient($account),
$sourceMailbox->getName(),
$messageId,
$trashMailbox->getName()
);
}
$this->eventDispatcher->dispatch(
MessageDeletedEvent::class,
new MessageDeletedEvent($account, $sourceMailbox, $messageId)
);
}
/**
* @param Account $account
* @param string $sourceFolderId
* @param string $destFolderId
* @param int $messageId
*
* @return void
* @throws ServiceException
*
*/
private function moveMessageOnSameAccount(Account $account,
string $sourceFolderId,
string $destFolderId,
int $messageId): void {
$client = $this->imapClientFactory->getClient($account);
$this->imapMessageMapper->move($client, $sourceFolderId, $messageId, $destFolderId);
}
public function markFolderAsRead(Account $account, Mailbox $mailbox): void {
$client = $this->imapClientFactory->getClient($account);
$this->imapMessageMapper->markAllRead($client, $mailbox->getName());
}
public function updateSubscription(Account $account, Mailbox $mailbox, bool $subscribed): Mailbox {
/**
* 1. Change subscription on IMAP
*/
$client = $this->imapClientFactory->getClient($account);
try {
$client->subscribeMailbox($mailbox->getName(), $subscribed);
} catch (Horde_Imap_Client_Exception $e) {
throw new ServiceException(
"Could not set subscription status for mailbox " . $mailbox->getId() . " on IMAP: " . $e->getMessage(),
(int) $e->getCode(),
$e
);
}
/**
* 2. Pull changes into the mailbox database cache
*/
$this->mailboxSync->sync($account, $this->logger,true);
/**
* 3. Return the updated object
*/
return $this->mailboxMapper->find($account, $mailbox->getName());
}
public function enableMailboxBackgroundSync(Mailbox $mailbox,
bool $syncInBackground): Mailbox {
$mailbox->setSyncInBackground($syncInBackground);
return $this->mailboxMapper->update($mailbox);
}
public function flagMessage(Account $account, string $mailbox, int $uid, string $flag, bool $value): void {
$client = $this->imapClientFactory->getClient($account);
try {
$mb = $this->mailboxMapper->find($account, $mailbox);
} catch (DoesNotExistException $e) {
throw new ClientException("Mailbox $mailbox does not exist", 0, $e);
}
// Only send system flags to the IMAP server as other flags might not be supported
$imapFlags = self::ALLOWED_FLAGS[$flag] ?? [];
try {
foreach ($imapFlags as $imapFlag) {
if ($value) {
$this->imapMessageMapper->addFlag($client, $mb, $uid, $imapFlag);
} else {
$this->imapMessageMapper->removeFlag($client, $mb, $uid, $imapFlag);
}
}
} catch (Horde_Imap_Client_Exception $e) {
throw new ServiceException(
"Could not set message flag on IMAP: " . $e->getMessage(),
(int) $e->getCode(),
$e
);
}
$this->eventDispatcher->dispatch(
MessageFlaggedEvent::class,
new MessageFlaggedEvent(
$account,
$mb,
$uid,
$flag,
$value
)
);
}
/**
* @param Account $account
*
* @return Quota|null
* @see https://tools.ietf.org/html/rfc2087
*/
public function getQuota(Account $account): ?Quota {
$client = $this->imapClientFactory->getClient($account);
/**
* Get all the quotas roots of the user's mailboxes
*/
try {
$quotas = array_map(static function (Folder $mb) use ($client) {
return $client->getQuotaRoot($mb->getMailbox());
}, $this->folderMapper->getFolders($account, $client));
} catch (Horde_Imap_Client_Exception_NoSupportExtension $ex) {
return null;
}
/**
* Extract the 'storage' quota
*
* Falls back to 0/0 if this quota has no storage information
*
* @see https://tools.ietf.org/html/rfc2087#section-3
*/
$storageQuotas = array_map(function (array $root) {
return $root['storage'] ?? [
'usage' => 0,
'limit' => 0,
];
}, array_merge(...array_values($quotas)));
if (empty($storageQuotas)) {
// Nothing left to do, and array_merge doesn't like to be called with zero arguments.
return null;
}
/**
* Deduplicate identical quota roots
*/
$storage = array_merge(...array_values($storageQuotas));
return new Quota(
1024 * (int)($storage['usage'] ?? 0),
1024 * (int)($storage['limit'] ?? 0)
);
}
public function renameMailbox(Account $account, Mailbox $mailbox, string $name): Mailbox {
/*
* 1. Rename on IMAP
*/
$this->folderMapper->renameFolder(
$this->imapClientFactory->getClient($account),
$mailbox->getName(),
$name
);
/**
* 2. Get the IMAP changes into our database cache
*/
$this->mailboxSync->sync($account, $this->logger,true);
/**
* 3. Return the cached object with the new ID
*/
try {
return $this->mailboxMapper->find($account, $name);
} catch (DoesNotExistException $e) {
throw new ServiceException("The renamed mailbox $name does not exist", 0, $e);
}
}
/**
* @param Account $account
* @param Mailbox $mailbox
*
* @throws ServiceException
*/
public function deleteMailbox(Account $account,
Mailbox $mailbox): void {
$client = $this->imapClientFactory->getClient($account);
$this->folderMapper->delete($client, $mailbox->getName());
$this->mailboxMapper->delete($mailbox);
}
}
|