ImapClient
in package
Class ImapClient
Table of Contents
- $connection : Connection|bool|null
- The connection
- $connection_conf : string
- Additional configuration for the connection
- $setup : ImapDomain|null
- Storage for domain configuration
- __construct() : mixed
- ImapClient constructor.
- __destruct() : mixed
- Destruct and disconnect
- ConfirmDelete() : bool|null
- Count() : int
- Count messages in open connection directory
- FlagAsDeleted() : bool|null
- Header() : string|null
- HeaderInfo() : object|null
- Fetch the header information and extend by custom property that holds all receivers and related addresses in copy
- MailBody() : string|null
- Mailboxes() : Result
- Get list of mailboxes
- MarkMailSeen() : bool|null
- Mark email as seen
- MoveMail() : bool|null
- connect() : Connection|false|null
Properties
$connection
The connection
private
Connection|bool|null
$connection
= null
$connection_conf
Additional configuration for the connection
private
string
$connection_conf
= ':143/imap/novalidate-cert'
$setup
Storage for domain configuration
private
ImapDomain|null
$setup
The setup instance
Methods
__construct()
ImapClient constructor.
public
__construct(ImapDomain $domain) : mixed
Parameters
- $domain : ImapDomain
Return values
mixed —__destruct()
Destruct and disconnect
public
__destruct() : mixed
Return values
mixed —ConfirmDelete()
public
ConfirmDelete() : bool|null
Return values
bool|null —Count()
Count messages in open connection directory
public
Count() : int
Return values
int —FlagAsDeleted()
public
FlagAsDeleted( $i) : bool|null
Parameters
Return values
bool|null —Header()
public
Header(int $i) : string|null
Parameters
- $i : int
Return values
string|null —HeaderInfo()
Fetch the header information and extend by custom property that holds all receivers and related addresses in copy
public
HeaderInfo(int $i) : object|null
Parameters
- $i : int
-
The mail id from current list
Return values
object|null —MailBody()
public
MailBody(int $i) : string|null
Parameters
- $i : int
Return values
string|null —Mailboxes()
Get list of mailboxes
public
Mailboxes() : Result
Return values
Result —MarkMailSeen()
Mark email as seen
public
MarkMailSeen(int $i) : bool|null
Parameters
- $i : int
Return values
bool|null —MoveMail()
public
MoveMail(int $i, string $target) : bool|null
Parameters
- $i : int
- $target : string
Return values
bool|null —connect()
private
connect() : Connection|false|null