forked from DirectoryTree/ImapEngine
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMailboxInterface.php
More file actions
63 lines (50 loc) · 1.34 KB
/
MailboxInterface.php
File metadata and controls
63 lines (50 loc) · 1.34 KB
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
<?php
namespace DirectoryTree\ImapEngine;
use DirectoryTree\ImapEngine\Connection\ConnectionInterface;
interface MailboxInterface
{
/**
* Get mailbox configuration values.
*/
public function config(?string $key = null, mixed $default = null): mixed;
/**
* Get the mailbox connection.
*/
public function connection(): ConnectionInterface;
/**
* Determine if connection was established.
*/
public function connected(): bool;
/**
* Force a reconnection to the server.
*/
public function reconnect(): void;
/**
* Connect to the server.
*/
public function connect(?ConnectionInterface $connection = null): void;
/**
* Disconnect from server.
*/
public function disconnect(): void;
/**
* Get the mailbox's inbox folder.
*/
public function inbox(): FolderInterface;
/**
* Begin querying for mailbox folders.
*/
public function folders(): FolderRepositoryInterface;
/**
* Get the mailbox's capabilities.
*/
public function capabilities(): array;
/**
* Select the given folder.
*/
public function select(FolderInterface $folder, bool $force = false): void;
/**
* Determine if the given folder is selected.
*/
public function selected(FolderInterface $folder): bool;
}