Mailbox
class Mailbox implements MailboxInterface (View source)
Properties
| protected array | $config | The mailbox configuration. |
|
| protected array|null | $capabilities | The cached mailbox capabilities. |
|
| protected FolderInterface|null | $selected | The currently selected folder. |
|
| protected ConnectionInterface|null | $connection | The mailbox connection. |
Methods
Constructor.
Prepare the cloned instance.
Get mailbox configuration values.
Get the mailbox connection.
Determine if connection was established.
Force a reconnection to the server.
Authenticate the current session.
Disconnect from server.
Get the mailbox's inbox folder.
Begin querying for mailbox folders.
Get the mailbox's capabilities.
Details
__construct(array $config = [])
Constructor.
void
__clone()
Prepare the cloned instance.
static Mailbox
make(array $config = [])
Make a new mailbox instance.
mixed
config(string|null $key = null, mixed $default = null)
Get mailbox configuration values.
ConnectionInterface
connection()
Get the mailbox connection.
bool
connected()
Determine if connection was established.
void
reconnect()
Force a reconnection to the server.
void
connect(ConnectionInterface|null $connection = null)
Connect to the server.
protected void
authenticate()
Authenticate the current session.
void
disconnect()
Disconnect from server.
FolderInterface
inbox()
Get the mailbox's inbox folder.
FolderRepositoryInterface
folders()
Begin querying for mailbox folders.
array
capabilities()
Get the mailbox's capabilities.
void
select(FolderInterface $folder, bool $force = false)
Select the given folder.
bool
selected(FolderInterface $folder)
Determine if the given folder is selected.