Pop
extends Imap
in package
Mail client POP class
Tags
Table of Contents
- $connection : resource
- Mailbox connection resource
- $connectionString : string
- Mailbox connection string
- $folder : string
- Current folder
- $host : string
- Mail client host
- $password : string
- Password
- $port : int
- Mail client port
- $service : string
- Mail client service (pop, imap, nntp, etc.)
- $username : string
- Username
- __construct() : mixed
- Constructor
- clearMessageFlags() : Imap
- Mark a message or messages as unread
- close() : void
- Close the mailbox connection resource
- connect() : Imap
- Connect to an IMAP mailbox
- connection() : resource
- Get mailbox connection
- copyMessage() : Imap
- Copy messages to another mailbox
- createMailbox() : Imap
- Create mailbox
- decodeText() : string
- Decode text
- deleteMailbox() : Imap
- Delete mailbox
- deleteMessage() : Imap
- Delete message
- getConnectionString() : string
- Get mailbox connection string
- getFolder() : string
- Get folder
- getHost() : string
- Get mail client host
- getInfo() : stdClass
- Get mailbox info
- getMessageAttachments() : array<string|int, mixed>
- Get message parts by message ID
- getMessageBody() : string
- Get message body by message ID
- getMessageBoundary() : string
- Get message boundary by message ID
- getMessageHeaderInfoById() : array<string|int, mixed>
- Get raw message headers by message ID
- getMessageHeaders() : array<string|int, mixed>
- Get message headers from a mailbox
- getMessageHeadersBy() : array<string|int, mixed>
- Get message headers from a mailbox
- getMessageHeadersById() : array<string|int, mixed>
- Get message headers by message ID
- getMessageIds() : array<string|int, mixed>
- Get message IDs from a mailbox
- getMessageIdsBy() : array<string|int, mixed>
- Get message IDs from a mailbox by a sort criteria
- getMessageNumber() : int
- Get message number from UID
- getMessageParts() : array<string|int, mixed>
- Get message parts by message ID
- getMessageRawHeadersById() : array<string|int, mixed>
- Get raw message headers by message ID
- getMessageStructure() : stdClass
- Get message structure by message ID
- getNumberOfMessages() : int
- Get total number of messages
- getNumberOfReadMessages() : int
- Get total number of read messages
- getNumberOfUnreadMessages() : int
- Get total number of unread messages
- getOverview() : array<string|int, mixed>
- Get message overviews
- getPassword() : string
- Get password
- getPort() : int
- Get mail client port
- getService() : string
- Get mail client service
- getStatus() : stdClass
- Get mailbox status
- getUsername() : string
- Get username
- hasMessageAttachments() : bool
- Get message parts by message ID
- isOpen() : bool
- Determine if the mailbox connection has been opened
- listMailboxes() : array<string|int, mixed>
- List mailboxes
- markAsRead() : Imap
- Mark a message or messages as read
- markAsUnread() : Imap
- Mark a message or messages as unread
- moveMessage() : Imap
- Move messages to another mailbox
- open() : Imap
- Open mailbox connection
- renameMailbox() : Imap
- Rename mailbox
- setFolder() : AbstractClient
- Set folder
- setHost() : AbstractClient
- Set mail client host
- setMessageFlags() : Imap
- Mark a message or messages as read
- setPassword() : AbstractClient
- Set password
- setPort() : AbstractClient
- Set mail client port
- setService() : AbstractClient
- Set mail client service
- setUsername() : AbstractClient
- Set username
Properties
$connection
Mailbox connection resource
protected
resource
$connection
= null
$connectionString
Mailbox connection string
protected
string
$connectionString
= null
$folder
Current folder
protected
string
$folder
= ''
$host
Mail client host
protected
string
$host
= null
$password
Password
protected
string
$password
= ''
$port
Mail client port
protected
int
$port
= null
$service
Mail client service (pop, imap, nntp, etc.)
protected
string
$service
= null
$username
Username
protected
string
$username
= ''
Methods
__construct()
Constructor
public
__construct(string $host, int $port[, string $service = 'pop3' ]) : mixed
Instantiate the POP mail client object
Parameters
- $host : string
- $port : int
- $service : string = 'pop3'
Return values
mixed —clearMessageFlags()
Mark a message or messages as unread
public
clearMessageFlags(mixed $ids, string $flags[, int $options = ST_UID ]) : Imap
Parameters
- $ids : mixed
- $flags : string
- $options : int = ST_UID
Return values
Imap —close()
Close the mailbox connection resource
public
close() : void
Return values
void —connect()
Connect to an IMAP mailbox
public
static connect(array<string|int, mixed> $creds[, string $flags = null ][, int $options = null ][, int $retries = null ][, array<string|int, mixed> $params = null ]) : Imap
Parameters
- $creds : array<string|int, mixed>
- $flags : string = null
- $options : int = null
- $retries : int = null
- $params : array<string|int, mixed> = null
Return values
Imap —connection()
Get mailbox connection
public
connection() : resource
Return values
resource —copyMessage()
Copy messages to another mailbox
public
copyMessage(mixed $ids, string|array<string|int, mixed> $to[, int $options = CP_UID ]) : Imap
Parameters
- $ids : mixed
- $to : string|array<string|int, mixed>
- $options : int = CP_UID
Return values
Imap —createMailbox()
Create mailbox
public
createMailbox(string $new) : Imap
Parameters
- $new : string
Return values
Imap —decodeText()
Decode text
public
decodeText(string $text) : string
Parameters
- $text : string
Return values
string —deleteMailbox()
Delete mailbox
public
deleteMailbox([string $mailbox = null ]) : Imap
Parameters
- $mailbox : string = null
Tags
Return values
Imap —deleteMessage()
Delete message
public
deleteMessage(int $id[, int $options = FT_UID ]) : Imap
Parameters
- $id : int
- $options : int = FT_UID
Return values
Imap —getConnectionString()
Get mailbox connection string
public
getConnectionString() : string
Return values
string —getFolder()
Get folder
public
getFolder() : string
Return values
string —getHost()
Get mail client host
public
getHost() : string
Return values
string —getInfo()
Get mailbox info
public
getInfo() : stdClass
Return values
stdClass —getMessageAttachments()
Get message parts by message ID
public
getMessageAttachments(int $id[, string $encoding = null ]) : array<string|int, mixed>
Parameters
- $id : int
- $encoding : string = null
Return values
array<string|int, mixed> —getMessageBody()
Get message body by message ID
public
getMessageBody(int $id) : string
Parameters
- $id : int
Return values
string —getMessageBoundary()
Get message boundary by message ID
public
getMessageBoundary(int $id) : string
Parameters
- $id : int
Return values
string —getMessageHeaderInfoById()
Get raw message headers by message ID
public
getMessageHeaderInfoById(int $id) : array<string|int, mixed>
Parameters
- $id : int
Return values
array<string|int, mixed> —getMessageHeaders()
Get message headers from a mailbox
public
getMessageHeaders([string $criteria = 'ALL' ][, int $options = SE_UID ][, string $charset = null ]) : array<string|int, mixed>
Parameters
- $criteria : string = 'ALL'
- $options : int = SE_UID
- $charset : string = null
Return values
array<string|int, mixed> —getMessageHeadersBy()
Get message headers from a mailbox
public
getMessageHeadersBy([int $criteria = SORTDATE ][, bool $reverse = true ][, int $options = SE_UID ][, string $search = 'ALL' ][, string $charset = null ]) : array<string|int, mixed>
Parameters
- $criteria : int = SORTDATE
- $reverse : bool = true
- $options : int = SE_UID
- $search : string = 'ALL'
- $charset : string = null
Return values
array<string|int, mixed> —getMessageHeadersById()
Get message headers by message ID
public
getMessageHeadersById(int $id) : array<string|int, mixed>
Parameters
- $id : int
Return values
array<string|int, mixed> —getMessageIds()
Get message IDs from a mailbox
public
getMessageIds([string $criteria = 'ALL' ][, int $options = SE_UID ][, string $charset = null ]) : array<string|int, mixed>
Parameters
- $criteria : string = 'ALL'
- $options : int = SE_UID
- $charset : string = null
Return values
array<string|int, mixed> —getMessageIdsBy()
Get message IDs from a mailbox by a sort criteria
public
getMessageIdsBy([int $criteria = SORTDATE ][, bool $reverse = true ][, int $options = SE_UID ][, string $search = 'ALL' ][, string $charset = null ]) : array<string|int, mixed>
Parameters
- $criteria : int = SORTDATE
- $reverse : bool = true
- $options : int = SE_UID
- $search : string = 'ALL'
- $charset : string = null
Return values
array<string|int, mixed> —getMessageNumber()
Get message number from UID
public
getMessageNumber(int $id) : int
Parameters
- $id : int
Return values
int —getMessageParts()
Get message parts by message ID
public
getMessageParts(int $id) : array<string|int, mixed>
Parameters
- $id : int
Return values
array<string|int, mixed> —getMessageRawHeadersById()
Get raw message headers by message ID
public
getMessageRawHeadersById(int $id) : array<string|int, mixed>
Parameters
- $id : int
Return values
array<string|int, mixed> —getMessageStructure()
Get message structure by message ID
public
getMessageStructure(int $id) : stdClass
Parameters
- $id : int
Return values
stdClass —getNumberOfMessages()
Get total number of messages
public
getNumberOfMessages() : int
Return values
int —getNumberOfReadMessages()
Get total number of read messages
public
getNumberOfReadMessages() : int
Return values
int —getNumberOfUnreadMessages()
Get total number of unread messages
public
getNumberOfUnreadMessages() : int
Return values
int —getOverview()
Get message overviews
public
getOverview(mixed $ids[, int $options = FT_UID ]) : array<string|int, mixed>
Parameters
- $ids : mixed
- $options : int = FT_UID
Return values
array<string|int, mixed> —getPassword()
Get password
public
getPassword() : string
Return values
string —getPort()
Get mail client port
public
getPort() : int
Return values
int —getService()
Get mail client service
public
getService() : string
Return values
string —getStatus()
Get mailbox status
public
getStatus() : stdClass
Return values
stdClass —getUsername()
Get username
public
getUsername() : string
Return values
string —hasMessageAttachments()
Get message parts by message ID
public
hasMessageAttachments(int $id[, string $encoding = null ]) : bool
Parameters
- $id : int
- $encoding : string = null
Return values
bool —isOpen()
Determine if the mailbox connection has been opened
public
isOpen() : bool
Return values
bool —listMailboxes()
List mailboxes
public
listMailboxes([string $pattern = '*' ]) : array<string|int, mixed>
Parameters
- $pattern : string = '*'
Return values
array<string|int, mixed> —markAsRead()
Mark a message or messages as read
public
markAsRead(mixed $ids[, int $options = ST_UID ]) : Imap
Parameters
- $ids : mixed
- $options : int = ST_UID
Return values
Imap —markAsUnread()
Mark a message or messages as unread
public
markAsUnread(mixed $ids[, int $options = ST_UID ]) : Imap
Parameters
- $ids : mixed
- $options : int = ST_UID
Return values
Imap —moveMessage()
Move messages to another mailbox
public
moveMessage(mixed $ids, string|array<string|int, mixed> $to[, int $options = CP_UID ]) : Imap
Parameters
- $ids : mixed
- $to : string|array<string|int, mixed>
- $options : int = CP_UID
Return values
Imap —open()
Open mailbox connection
public
open([string $flags = null ][, int $options = null ][, int $retries = null ][, array<string|int, mixed> $params = null ]) : Imap
Parameters
- $flags : string = null
- $options : int = null
- $retries : int = null
- $params : array<string|int, mixed> = null
Return values
Imap —renameMailbox()
Rename mailbox
public
renameMailbox(string $new[, string $old = null ]) : Imap
Parameters
- $new : string
- $old : string = null
Return values
Imap —setFolder()
Set folder
public
setFolder(string $folder) : AbstractClient
Parameters
- $folder : string
Return values
AbstractClient —setHost()
Set mail client host
public
setHost(string $host) : AbstractClient
Parameters
- $host : string
Return values
AbstractClient —setMessageFlags()
Mark a message or messages as read
public
setMessageFlags(mixed $ids, string $flags[, int $options = ST_UID ]) : Imap
Parameters
- $ids : mixed
- $flags : string
- $options : int = ST_UID
Return values
Imap —setPassword()
Set password
public
setPassword(string $password) : AbstractClient
Parameters
- $password : string
Return values
AbstractClient —setPort()
Set mail client port
public
setPort(int $port) : AbstractClient
Parameters
- $port : int
Return values
AbstractClient —setService()
Set mail client service
public
setService(string $service) : AbstractClient
Parameters
- $service : string
Return values
AbstractClient —setUsername()
Set username
public
setUsername(string $username) : AbstractClient
Parameters
- $username : string