MailboxInterface
interface MailboxInterface (View source)
Methods
mixed
config(string|null $key = null, mixed $default = null)
Get mailbox configuration values.
connection()
Get the mailbox connection.
bool
connected()
Determine if connection was established.
void
reconnect()
Force a reconnection to the server.
void
void
disconnect()
Disconnect from server.
inbox()
Get the mailbox's inbox folder.
folders()
Begin querying for mailbox folders.
array
capabilities()
Get the mailbox's capabilities.
void
bool
Details
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.
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.