VERSION
VERSION
Serialized version.
An interface to a POP3 server using PHP functions.
It is an abstraction layer allowing POP3 commands to be used based on IMAP equivalents.
This driver implements the following POP3-related RFCs:
- STD 53/RFC 1939: POP3 specification - RFC 2195: CRAM-MD5 authentication - RFC 2449: POP3 extension mechanism - RFC 2595/4616: PLAIN authentication - RFC 2831: DIGEST-MD5 SASL Authentication (obsoleted by RFC 6331) - RFC 3206: AUTH/SYS response codes - RFC 4616: AUTH=PLAIN - RFC 5034: POP3 SASL - RFC 5802: AUTH=SCRAM-SHA-1 - RFC 6856: UTF8, LANG
$statuscache : boolean
Horde_Imap_Client is optimized for short (i.e. 1 seconds) scripts. It makes heavy use of mailbox caching to save on server accesses. This property should be set to false for long-running scripts, or else status() data may not reflect the current state of the mailbox on the server.
$_alerts : \Horde_Imap_Client_Base_Alerts
Alerts reporting object.
$_cache : \Horde_Imap_Client_Cache
The Horde_Imap_Client_Cache object.
$_debug : \Horde_Imap_Client_Base_Debug
The debug object.
$_selected : \Horde_Imap_Client_Mailbox
The currently selected mailbox.
__construct(array $params = array())
Constructor.
| array | $params | Configuration parameters:
- cache: (array) If set, caches data from fetch(), search(), and
thread() calls. Requires the horde/Cache package to be
installed. The array can contain the following keys (see
Horde_Imap_Client_Cache for default values):
- backend: [REQUIRED (or cacheob)] (Horde_Imap_Client_Cache_Backend)
Backend cache driver [@since 2.9.0].
- fetch_ignore: (array) A list of mailboxes to ignore when storing
fetch data.
- fields: (array) The fetch criteria to cache. If not defined, all
cacheable data is cached. The following is a list of
criteria that can be cached:
- Horde_Imap_Client::FETCH_ENVELOPE
- Horde_Imap_Client::FETCH_FLAGS
Only if server supports CONDSTORE extension
- Horde_Imap_Client::FETCH_HEADERS
Only for queries that specifically request caching
- Horde_Imap_Client::FETCH_IMAPDATE
- Horde_Imap_Client::FETCH_SIZE
- Horde_Imap_Client::FETCH_STRUCTURE
- capability_ignore: (array) A list of IMAP capabilites to ignore, even
if they are supported on the server.
DEFAULT: No supported capabilities are ignored.
- comparator: (string) The search comparator to use instead of the
default server comparator. See setComparator() for
format.
DEFAULT: Use the server default
- context: (array) Any context parameters passed to
stream_create_context(). @since 2.27.0
- debug: (string) If set, will output debug information to the stream
provided. The value can be any PHP supported wrapper that can
be opened via PHP's fopen() function.
DEFAULT: No debug output
- hostspec: (string) The hostname or IP address of the server.
DEFAULT: 'localhost'
- id: (array) Send ID information to the server (only if server
supports the ID extension). An array with the keys as the fields
to send and the values being the associated values. See RFC 2971
[3.3] for a list of standard field values.
DEFAULT: No info sent to server
- lang: (array) A list of languages (in priority order) to be used to
display human readable messages.
DEFAULT: Messages output in IMAP server default language
- password: (mixed) The user password. Either a string or a
Horde_Imap_Client_Base_Password object [@since 2.14.0].
- port: (integer) The server port to which we will connect.
DEFAULT: 143 (imap or imap w/TLS) or 993 (imaps)
- secure: (string) Use SSL or TLS to connect. Values:
- false (No encryption)
- 'ssl' (Auto-detect SSL version)
- 'sslv2' (Force SSL version 3)
- 'sslv3' (Force SSL version 2)
- 'tls' (TLS; started via protocol-level negotation over
unencrypted channel; RECOMMENDED way of initiating secure
connection)
- 'tlsv1' (TLS direct version 1.x connection to server) [@since
2.16.0]
- true (TLS if available/necessary) [@since 2.15.0]
DEFAULT: false
- timeout: (integer) Connection timeout, in seconds.
DEFAULT: 30 seconds
- username: (string) [REQUIRED] The username.
|
getIdsOb(mixed $ids = null, boolean $sequence = false) : \Horde_Imap_Client_Ids
Returns the correct IDs object for use with this driver.
| mixed | $ids | Either self::ALL, self::SEARCH_RES, self::LARGEST, Horde_Imap_Client_Ids object, array, or sequence string. |
| boolean | $sequence | Are $ids message sequence numbers? |
The IDs object.
queryCapability(string $capability) : mixed
Returns whether the IMAP server supports the given capability (See RFC 3501 [6.1.1]).
| string | $capability | The capability string to query. |
True if the server supports the queried capability, false if it doesn't, or an array if the capability can contain multiple values.
getNamespaces(array $additional = array(), array $opts = array()) : mixed
Get the NAMESPACE information from the IMAP server (RFC 2342).
| array | $additional | If the server supports namespaces, any additional namespaces to add to the namespace list that are not broadcast by the server. The namespaces must be UTF-8 strings. |
| array | $opts | Additional options:
|
A Horde_Imap_Client_Namespace_List object if 'ob_return', is true. Otherwise, an array of namespace objects (@deprecated) with the name as the key (UTF-8) and the following values:
- delimiter: (string) The namespace delimiter.
- hidden: (boolean) Is this a hidden namespace?
- name: (string) The namespace name (UTF-8).
- translation: (string) Returns the translated name of the namespace
(UTF-8). Requires RFC 5255 and a previous call to
setLanguage().
- type: (integer) The namespace type. Either:
- Horde_Imap_Client::NS_PERSONAL
- Horde_Imap_Client::NS_OTHER
- Horde_Imap_Client::NS_SHARED
setLanguage(array $langs = null) : string
Sets the preferred language for server response messages (RFC 5255).
| array | $langs | Overrides the value of the 'lang' param and sends this list of preferred languages instead. The special string 'i-default' can be used to restore the language to the server default. |
The language accepted by the server, or null if the default language is used.
getLanguage(array $list = false) : mixed
Gets the preferred language for server response messages (RFC 5255).
| array | $list | If true, return the list of available languages. |
If $list is true, the list of languages available on the server (may be empty). If false, the language used by the server, or null if the default language is used.
openMailbox(mixed $mailbox, integer $mode = \Horde_Imap_Client::OPEN_AUTO)
Open a mailbox.
| mixed | $mailbox | The mailbox to open. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| integer | $mode | The access mode. Either
|
createMailbox(mixed $mailbox, array $opts = array())
Create a mailbox.
| mixed | $mailbox | The mailbox to create. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| array | $opts | Additional options:
|
renameMailbox(mixed $old, mixed $new)
Rename a mailbox.
| mixed | $old | The old mailbox name. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| mixed | $new | The new mailbox name. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
subscribeMailbox(mixed $mailbox, boolean $subscribe = true)
Manage subscription status for a mailbox.
| mixed | $mailbox | The mailbox to [un]subscribe to. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| boolean | $subscribe | True to subscribe, false to unsubscribe. |
listMailboxes(mixed $pattern, integer $mode = \Horde_Imap_Client::MBOX_ALL, array $options = array()) : array
Obtain a list of mailboxes matching a pattern.
| mixed | $pattern | The mailbox search pattern(s) (see RFC 3501 [6.3.8] for the format). A UTF-8 string or an array of strings. If a Horde_Imap_Client_Mailbox object is given, it is escaped (i.e. wildcard patterns are converted to return the miminal number of matches possible). |
| integer | $mode | Which mailboxes to return. Either:
|
| array | $options | Additional options:
- attributes: (boolean) If true, return attribute information under
the 'attributes' key.
DEFAULT: Do not return this information.
- children: (boolean) Tell server to return children attribute
information (\HasChildren, \HasNoChildren). Requires the
LIST-EXTENDED extension to guarantee this information is
returned. Server MAY return this attribute without this
option, or if the CHILDREN extension is available, but it
is not guaranteed.
DEFAULT: false
- flat: (boolean) If true, return a flat list of mailbox names only.
Overrides the 'attributes' option.
DEFAULT: Do not return flat list.
- recursivematch: (boolean) Force the server to return information
about parent mailboxes that don't match other
selection options, but have some sub-mailboxes that
do. Information about children is returned in the
CHILDINFO extended data item ('extended'). Requires
the LIST-EXTENDED extension.
DEFAULT: false
- remote: (boolean) Tell server to return mailboxes that reside on
another server. Requires the LIST-EXTENDED extension.
DEFAULT: false
- special_use: (boolean) Tell server to return special-use attribute
information (see Horde_Imap_Client SPECIALUSE_*
constants). Server must support the SPECIAL-USE return
option for this setting to have any effect.
DEFAULT: false
- status: (integer) Tell server to return status information. The
value is a bitmask that may contain any of:
- Horde_Imap_Client::STATUS_MESSAGES
- Horde_Imap_Client::STATUS_RECENT
- Horde_Imap_Client::STATUS_UIDNEXT
- Horde_Imap_Client::STATUS_UIDVALIDITY
- Horde_Imap_Client::STATUS_UNSEEN
- Horde_Imap_Client::STATUS_HIGHESTMODSEQ
DEFAULT: 0
- sort: (boolean) If true, return a sorted list of mailboxes?
DEFAULT: Do not sort the list.
- sort_delimiter: (string) If 'sort' is true, this is the delimiter
used to sort the mailboxes.
DEFAULT: '.'
|
If 'flat' option is true, the array values are a list of Horde_Imap_Client_Mailbox objects. Otherwise, the keys are UTF-8 mailbox names and the values are arrays with these keys:
status(mixed $mailbox, integer $flags = \Horde_Imap_Client::STATUS_ALL, array $opts = array()) : array
Obtain status information for a mailbox.
| mixed | $mailbox | The mailbox(es) to query. Either a Horde_Imap_Client_Mailbox object, a string (UTF-8), or an array of objects/strings (since 2.10.0). |
| integer | $flags | A bitmask of information requested from the server. Allowed flags:
- Horde_Imap_Client::STATUS_MESSAGES
Return key: messages
Return format: (integer) The number of messages in the mailbox.
- Horde_Imap_Client::STATUS_RECENT
Return key: recent
Return format: (integer) The number of messages with the \Recent
flag set as currently reported in the mailbox
- Horde_Imap_Client::STATUS_RECENT_TOTAL
Return key: recent_total
Return format: (integer) The number of messages with the \Recent
flag set. This returns the total number of messages
that have been marked as recent in this mailbox
since the PHP process began. (since 2.12.0)
- Horde_Imap_Client::STATUS_UIDNEXT
Return key: uidnext
Return format: (integer) The next UID to be assigned in the
mailbox. Only returned if the server automatically
provides the data.
- Horde_Imap_Client::STATUS_UIDNEXT_FORCE
Return key: uidnext
Return format: (integer) The next UID to be assigned in the
mailbox. This option will always determine this
value, even if the server does not automatically
provide this data.
- Horde_Imap_Client::STATUS_UIDVALIDITY
Return key: uidvalidity
Return format: (integer) The unique identifier validity of the
mailbox.
- Horde_Imap_Client::STATUS_UNSEEN
Return key: unseen
Return format: (integer) The number of messages which do not have
the \Seen flag set.
- Horde_Imap_Client::STATUS_FIRSTUNSEEN
Return key: firstunseen
Return format: (integer) The sequence number of the first unseen
message in the mailbox.
- Horde_Imap_Client::STATUS_FLAGS
Return key: flags
Return format: (array) The list of defined flags in the mailbox
(all flags are in lowercase).
- Horde_Imap_Client::STATUS_PERMFLAGS
Return key: permflags
Return format: (array) The list of flags that a client can change
permanently (all flags are in lowercase).
- Horde_Imap_Client::STATUS_HIGHESTMODSEQ
Return key: highestmodseq
Return format: (integer) If the server supports the CONDSTORE
IMAP extension, this will be the highest
mod-sequence value of all messages in the mailbox.
Else 0 if CONDSTORE not available or the mailbox
does not support mod-sequences.
- Horde_Imap_Client::STATUS_SYNCMODSEQ
Return key: syncmodseq
Return format: (integer) If caching, and the server supports the
CONDSTORE IMAP extension, this is the cached
mod-sequence value of the mailbox when it was opened
for the first time in this access. Will be null if
not caching, CONDSTORE not available, or the mailbox
does not support mod-sequences.
- Horde_Imap_Client::STATUS_SYNCFLAGUIDS
Return key: syncflaguids
Return format: (Horde_Imap_Client_Ids) If caching, the server
supports the CONDSTORE IMAP extension, and the
mailbox contained cached data when opened for the
first time in this access, this is the list of UIDs
in which flags have changed since STATUS_SYNCMODSEQ.
- Horde_Imap_Client::STATUS_SYNCVANISHED
Return key: syncvanished
Return format: (Horde_Imap_Client_Ids) If caching, the server
supports the CONDSTORE IMAP extension, and the
mailbox contained cached data when opened for the
first time in this access, this is the list of UIDs
which have been deleted since STATUS_SYNCMODSEQ.
- Horde_Imap_Client::STATUS_UIDNOTSTICKY
Return key: uidnotsticky
Return format: (boolean) If the server supports the UIDPLUS IMAP
extension, and the queried mailbox does not support
persistent UIDs, this value will be true. In all
other cases, this value will be false.
- Horde_Imap_Client::STATUS_FORCE_REFRESH
Normally, the status information will be cached for a given
mailbox. Since most PHP requests are generally less than a second,
this is fine. However, if your script is long running, the status
information may not be up-to-date. Specifying this flag will ensure
that the server is always polled for the current mailbox status
before results are returned. (since 2.14.0)
- Horde_Imap_Client::STATUS_ALL (DEFAULT)
Shortcut to return 'messages', 'recent', 'uidnext', 'uidvalidity',
and 'unseen' values.
|
| array | $opts | Additional options:
- sort: (boolean) If true, sort the list of mailboxes? (since 2.10.0)
DEFAULT: Do not sort the list.
- sort_delimiter: (string) If 'sort' is true, this is the delimiter
used to sort the mailboxes. (since 2.10.0)
DEFAULT: '.'
|
If $mailbox contains multiple mailboxes, an array with keys being the UTF-8 mailbox name and values as arrays containing the requested keys (see above). Otherwise, an array with keys as the requested keys (see above) and values as the key data.
statusMultiple(array $mailboxes, integer $flags = \Horde_Imap_Client::STATUS_ALL, array $opts = array()) : array
Perform a STATUS call on multiple mailboxes at the same time.
This method leverages the LIST-EXTENDED and LIST-STATUS extensions on the IMAP server to improve the efficiency of this operation.
| array | $mailboxes | The mailboxes to query. Either Horde_Imap_Client_Mailbox objects, strings (UTF-8), or a combination of the two. |
| integer | $flags | See status(). |
| array | $opts | Additional options:
|
An array with the keys as the mailbox names (UTF-8) and the values as arrays with the requested keys (from the mask given in $flags).
append(mixed $mailbox, array $data, array $options = array()) : \Horde_Imap_Client_Ids
Append message(s) to a mailbox.
| mixed | $mailbox | The mailbox to append the message(s) to. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| array | $data | The message data to append, along with additional options. An array of arrays with each embedded array having the following entries:
- data: (mixed) The data to append. If a string or a stream resource,
this will be used as the entire contents of a single message.
If an array, will catenate all given parts into a single
message. This array contains one or more arrays with
two keys:
- t: (string) Either 'url' or 'text'.
- v: (mixed) If 't' is 'url', this is the IMAP URL to the message
part to append. If 't' is 'text', this is either a string or
resource representation of the message part data.
DEFAULT: NONE (entry is MANDATORY)
- flags: (array) An array of flags/keywords to set on the appended
message.
DEFAULT: Only the \Recent flag is set.
- internaldate: (DateTime) The internaldate to set for the appended
message.
DEFAULT: internaldate will be the same date as when
the message was appended.
|
| array | $options | Additonal options:
- create: (boolean) Try to create $mailbox if it does not exist?
DEFAULT: No.
|
The UIDs of the appended messages.
close(array $options = array())
Close the connection to the currently selected mailbox, optionally expunging all deleted messages (RFC 3501 [6.4.2]).
| array | $options | Additional options:
|
expunge(mixed $mailbox, array $options = array()) : \Horde_Imap_Client_Ids
Expunge deleted messages from the given mailbox.
| mixed | $mailbox | The mailbox to expunge. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| array | $options | Additional options:
|
If 'list' option is true, returns the UID list of expunged messages.
search(mixed $mailbox, \Horde_Imap_Client_Search_Query $query = null, array $options = array()) : array
Search a mailbox.
| mixed | $mailbox | The mailbox to search. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| \Horde_Imap_Client_Search_Query | $query | The search query. Defaults to an ALL search. |
| array | $options | Additional options:
- nocache: (boolean) Don't cache the results.
DEFAULT: false (results cached, if possible)
- partial: (mixed) The range of results to return (message sequence
numbers) Only a single range is supported (represented by
the minimum and maximum values contained in the range
given).
DEFAULT: All messages are returned.
- results: (array) The data to return. Consists of zero or more of
the following flags:
- Horde_Imap_Client::SEARCH_RESULTS_COUNT
- Horde_Imap_Client::SEARCH_RESULTS_MATCH (DEFAULT)
- Horde_Imap_Client::SEARCH_RESULTS_MAX
- Horde_Imap_Client::SEARCH_RESULTS_MIN
- Horde_Imap_Client::SEARCH_RESULTS_SAVE
- Horde_Imap_Client::SEARCH_RESULTS_RELEVANCY
- sequence: (boolean) If true, returns an array of sequence numbers.
DEFAULT: Returns an array of UIDs
- sort: (array) Sort the returned list of messages. Multiple sort
criteria can be specified. Any sort criteria can be sorted in
reverse order (instead of the default ascending order) by
adding a Horde_Imap_Client::SORT_REVERSE element to the array
directly before adding the sort element. The following sort
criteria are available:
- Horde_Imap_Client::SORT_ARRIVAL
- Horde_Imap_Client::SORT_CC
- Horde_Imap_Client::SORT_DATE
- Horde_Imap_Client::SORT_DISPLAYFROM
On servers that don't support SORT=DISPLAY, this criteria will
fallback to doing client-side sorting.
- Horde_Imap_Client::SORT_DISPLAYFROM_FALLBACK
On servers that don't support SORT=DISPLAY, this criteria will
fallback to Horde_Imap_Client::SORT_FROM [since 2.4.0].
- Horde_Imap_Client::SORT_DISPLAYTO
On servers that don't support SORT=DISPLAY, this criteria will
fallback to doing client-side sorting.
- Horde_Imap_Client::SORT_DISPLAYTO_FALLBACK
On servers that don't support SORT=DISPLAY, this criteria will
fallback to Horde_Imap_Client::SORT_TO [since 2.4.0].
- Horde_Imap_Client::SORT_FROM
- Horde_Imap_Client::SORT_SEQUENCE
- Horde_Imap_Client::SORT_SIZE
- Horde_Imap_Client::SORT_SUBJECT
- Horde_Imap_Client::SORT_TO
[On servers that support SEARCH=FUZZY, this criteria is also
available:]
- Horde_Imap_Client::SORT_RELEVANCY
|
An array with the following keys:
- count: (integer) The number of messages that match the search
criteria. Always returned.
- match: (Horde_Imap_Client_Ids) The IDs that match $criteria, sorted
if the 'sort' modifier was set. Returned if
Horde_Imap_Client::SEARCH_RESULTS_MATCH is set.
- max: (integer) The UID (default) or message sequence number (if
'sequence' is true) of the highest message that satisifies
$criteria. Returns null if no matches found. Returned if
Horde_Imap_Client::SEARCH_RESULTS_MAX is set.
- min: (integer) The UID (default) or message sequence number (if
'sequence' is true) of the lowest message that satisifies
$criteria. Returns null if no matches found. Returned if
Horde_Imap_Client::SEARCH_RESULTS_MIN is set.
- modseq: (integer) The highest mod-sequence for all messages being
returned. Returned if 'sort' is false, the search query
includes a MODSEQ command, and the server supports the
CONDSTORE IMAP extension.
- relevancy: (array) The list of relevancy scores. Returned if
Horde_Imap_Client::SEARCH_RESULTS_RELEVANCY is set and
the server supports FUZZY search matching.
- save: (boolean) Whether the search results were saved. Returned if
Horde_Imap_Client::SEARCH_RESULTS_SAVE is set.
setComparator(string $comparator = null)
Set the comparator to use for searching/sorting (RFC 5255).
| string | $comparator | The comparator string (see RFC 4790 [3.1] - "collation-id" - for format). The reserved string 'default' can be used to select the default comparator. |
thread(mixed $mailbox, array $options = array()) : \Horde_Imap_Client_Data_Thread
Thread sort a given list of messages (RFC 5256).
| mixed | $mailbox | The mailbox to query. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| array | $options | Additional options:
- criteria: (mixed) The following thread criteria are available:
- Horde_Imap_Client::THREAD_ORDEREDSUBJECT
- Horde_Imap_Client::THREAD_REFERENCES
- Horde_Imap_Client::THREAD_REFS
Other algorithms can be explicitly specified by passing the IMAP
thread algorithm in as a string value.
DEFAULT: Horde_Imap_Client::THREAD_ORDEREDSUBJECT
- search: (Horde_Imap_Client_Search_Query) The search query.
DEFAULT: All messages in mailbox included in thread sort.
- sequence: (boolean) If true, each message is stored and referred to
by its message sequence number.
DEFAULT: Stored/referred to by UID.
|
A thread data object.
fetch(mixed $mailbox, \Horde_Imap_Client_Fetch_Query $query, array $options = array()) : \Horde_Imap_Client_Fetch_Results
Fetch message data (see RFC 3501 [6.4.5]).
| mixed | $mailbox | The mailbox to search. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| \Horde_Imap_Client_Fetch_Query | $query | Fetch query object. |
| array | $options | Additional options:
|
A results object.
vanished(mixed $mailbox, integer $modseq, array $opts = array()) : \Horde_Imap_Client_Ids
Get the list of vanished messages (UIDs that have been expunged since a given mod-sequence value).
| mixed | $mailbox | The mailbox to query. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| integer | $modseq | Search for expunged messages after this mod-sequence value. |
| array | $opts | Additional options:
|
List of UIDs that have vanished.
store(mixed $mailbox, array $options = array()) : \Horde_Imap_Client_Ids
Store message flag data (see RFC 3501 [6.4.6]).
| mixed | $mailbox | The mailbox containing the messages to modify. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| array | $options | Additional options:
|
A Horde_Imap_Client_Ids object containing the list of IDs that failed the 'unchangedsince' test.
copy(mixed $source, mixed $dest, array $options = array()) : mixed
Copy messages to another mailbox.
| mixed | $source | The source mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| mixed | $dest | The destination mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| array | $options | Additional options:
|
An array mapping old UIDs (keys) to new UIDs (values) on success (only guaranteed if 'force_map' is true) or true.
setQuota(mixed $root, array $resources = array())
Set quota limits. The server must support the IMAP QUOTA extension (RFC 2087).
| mixed | $root | The quota root. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| array | $resources | The resource values to set. Keys are the resource atom name; value is the resource value. |
getQuota(mixed $root) : mixed
Get quota limits. The server must support the IMAP QUOTA extension (RFC 2087).
| mixed | $root | The quota root. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
An array with resource keys. Each key holds an array with 2 values: 'limit' and 'usage'.
getQuotaRoot(mixed $mailbox) : mixed
Get quota limits for a mailbox. The server must support the IMAP QUOTA extension (RFC 2087).
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
An array with the keys being the quota roots. Each key holds an array with resource keys: each of these keys holds an array with 2 values: 'limit' and 'usage'.
getACL(mixed $mailbox) : array
Get the ACL rights for a given mailbox. The server must support the IMAP ACL extension (RFC 2086/4314).
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
An array with identifiers as the keys and Horde_Imap_Client_Data_Acl objects as the values.
setACL(mixed $mailbox, string $identifier, array $options)
Set ACL rights for a given mailbox/identifier.
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| string | $identifier | The identifier to alter (UTF-8). |
| array | $options | Additional options:
|
deleteACL(mixed $mailbox, string $identifier)
Deletes ACL rights for a given mailbox/identifier.
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| string | $identifier | The identifier to delete (UTF-8). |
listACLRights(mixed $mailbox, string $identifier) : \Horde_Imap_Client_Data_AclRights
List the ACL rights for a given mailbox/identifier. The server must support the IMAP ACL extension (RFC 2086/4314).
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| string | $identifier | The identifier to query (UTF-8). |
An ACL data rights object.
getMyACLRights(mixed $mailbox) : \Horde_Imap_Client_Data_Acl
Get the ACL rights for the current user for a given mailbox. The server must support the IMAP ACL extension (RFC 2086/4314).
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
An ACL data object.
getMetadata(mixed $mailbox, array $entries, array $options = array()) : array
Get metadata for a given mailbox. The server must support either the IMAP METADATA extension (RFC 5464) or the ANNOTATEMORE extension (http://ietfreport.isoc.org/idref/draft-daboo-imap-annotatemore/).
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| array | $entries | The entries to fetch (UTF-8 strings). |
| array | $options | Additional options:
|
An array with metadata names as the keys and metadata values as the values. If 'maxsize' is set, and entries exist on the server larger than this size, the size will be returned in the key '*longentries'.
setMetadata(mixed $mailbox, array $data)
Set metadata for a given mailbox/identifier.
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). If empty, sets a server annotation. |
| array | $data | A set of data values. The metadata values corresponding to the keys of the array will be set to the values in the array. |
getCacheId(mixed $mailbox, array $addl = array()) : string
Returns a unique identifier for the current mailbox status.
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| array | $addl | Additional cache info to add to the cache ID string. |
The cache ID string, which will change when the composition of the mailbox changes. The uidvalidity will always be the first element, and will be delimited by the '|' character.
resolveIds(\Horde_Imap_Client_Mailbox $mailbox, \Horde_Imap_Client_Ids $ids, integer $convert) : \Horde_Imap_Client_Ids
Resolves an IDs object into a list of IDs.
| \Horde_Imap_Client_Mailbox | $mailbox | The mailbox. |
| \Horde_Imap_Client_Ids | $ids | The Ids object. |
| integer | $convert | Convert to UIDs?
|
The list of IDs.
sync(mixed $mailbox, string $token, array $opts = array()) : \Horde_Imap_Client_Data_Sync
Synchronize a mailbox from a sync token.
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
| string | $token | A sync token generated by getSyncToken(). |
| array | $opts | Additional options:
|
A sync object.
_initCache(boolean $current = false) : boolean
Initialize the Horde_Imap_Client_Cache object, if necessary.
| boolean | $current | If true, we are going to update the currently selected mailbox. Add an additional check to see if caching is available in current mailbox. |
Returns true if caching is enabled.
_capability() : mixed
Query server capability.
Required because internal code can't call capability via magic method directly - it may not exist yet, the creation code may call capability recursively, and __get() doesn't allow recursive calls to the same property (chicken/egg issue).
The capability object if no arguments provided. If arguments are provided, they are passed to the query() method and this value is returned.
_getNamespaces() : \Horde_Imap_Client_Namespace_List
Get the NAMESPACE information from the IMAP server.
Namespace list object.
_setLanguage(array $langs) : string
Sets the preferred language for server response messages (RFC 5255).
| array | $langs | The preferred list of languages. |
The language accepted by the server, or null if the default language is used.
_getLanguage(array $list) : mixed
Gets the preferred language for server response messages (RFC 5255).
| array | $list | If true, return the list of available languages. |
If $list is true, the list of languages available on the server (may be empty). If false, the language used by the server, or null if the default language is used.
_openMailbox(\Horde_Imap_Client_Mailbox $mailbox, integer $mode)
Open a mailbox.
| \Horde_Imap_Client_Mailbox | $mailbox | The mailbox to open. |
| integer | $mode | The access mode. |
_mailboxOb(string $mailbox = null) : \Horde_Imap_Client_Base_Mailbox
Return the Horde_Imap_Client_Base_Mailbox object.
| string | $mailbox | The mailbox name. Defaults to currently selected mailbox. |
Mailbox object.
_createMailbox(\Horde_Imap_Client_Mailbox $mailbox, array $opts)
Create a mailbox.
| \Horde_Imap_Client_Mailbox | $mailbox | The mailbox to create. |
| array | $opts | Additional options. See createMailbox(). |
_deleteMailbox(\Horde_Imap_Client_Mailbox $mailbox)
Delete a mailbox.
| \Horde_Imap_Client_Mailbox | $mailbox | The mailbox to delete. |
_deleteMailboxPost(\Horde_Imap_Client_Mailbox $mailbox)
Actions to perform after a mailbox delete.
| \Horde_Imap_Client_Mailbox | $mailbox | The deleted mailbox. |
_renameMailbox(\Horde_Imap_Client_Mailbox $old, \Horde_Imap_Client_Mailbox $new)
Rename a mailbox.
| \Horde_Imap_Client_Mailbox | $old | The old mailbox name. |
| \Horde_Imap_Client_Mailbox | $new | The new mailbox name. |
_subscribeMailbox(\Horde_Imap_Client_Mailbox $mailbox, boolean $subscribe)
Manage subscription status for a mailbox.
| \Horde_Imap_Client_Mailbox | $mailbox | The mailbox to [un]subscribe to. |
| boolean | $subscribe | True to subscribe, false to unsubscribe. |
_listMailboxes(array $pattern, integer $mode, array $options) : array
Obtain a list of mailboxes matching a pattern.
| array | $pattern | The mailbox search patterns (Horde_Imap_Client_Mailbox objects). |
| integer | $mode | Which mailboxes to return. |
| array | $options | Additional options. |
See listMailboxes().
_status(array $mboxes, integer $flags) : array
Obtain status information for mailboxes.
| array | $mboxes | The list of mailbox objects to query. |
| integer | $flags | This driver only supports the options listed under Horde_Imap_Client::STATUS_ALL. |
See array return for status().
_append(\Horde_Imap_Client_Mailbox $mailbox, array $data, array $options) : mixed
Append message(s) to a mailbox.
| \Horde_Imap_Client_Mailbox | $mailbox | The mailbox to append the message(s) to. |
| array | $data | The message data. |
| array | $options | Additional options. |
A Horde_Imap_Client_Ids object containing the UIDs of the appended messages (if server supports UIDPLUS extension) or true.
_expunge(array $options) : \Horde_Imap_Client_Ids
Expunge all deleted messages from the given mailbox.
| array | $options | Additional options. 'ids' has no effect in this driver. |
If 'list' option is true, returns the list of expunged messages.
_search(object $query, array $options) : \Horde_Imap_Client_Ids
Search a mailbox.
| object | $query | The search query. |
| array | $options | Additional options. The '_query' key contains the value of $query->build(). |
An array of IDs.
_setComparator(string $comparator)
Set the comparator to use for searching/sorting (RFC 5255).
| string | $comparator | The comparator string (see RFC 4790 [3.1] - "collation-id" - for format). The reserved string 'default' can be used to select the default comparator. |
_thread(array $options) : \Horde_Imap_Client_Data_Thread
Thread sort a given list of messages (RFC 5256).
| array | $options | Additional options. See thread(). |
A thread data object.
_fetch(\Horde_Imap_Client_Fetch_Results $results, array $queries)
Fetch message data.
Fetch queries should be grouped in the $queries argument. Each value is an array of fetch options, with the fetch query stored in the '_query' parameter. IMPORTANT: All queries must have the same ID type (either sequence or UID).
| \Horde_Imap_Client_Fetch_Results | $results | Fetch results. |
| array | $queries | The list of queries. |
_vanished(integer $modseq, \Horde_Imap_Client_Ids $ids) : \Horde_Imap_Client_Ids
Get the list of vanished messages.
| integer | $modseq | Mod-sequence value. |
| \Horde_Imap_Client_Ids | $ids | UIDs. |
List of UIDs that have vanished.
_store(array $options) : \Horde_Imap_Client_Ids
Store message flag data.
| array | $options | Additional options. This driver does not support 'unchangedsince'. |
A Horde_Imap_Client_Ids object containing the list of IDs that failed the 'unchangedsince' test.
_copy(\Horde_Imap_Client_Mailbox $dest, array $options) : mixed
Copy messages to another mailbox.
| \Horde_Imap_Client_Mailbox | $dest | The destination mailbox. |
| array | $options | Additional options. |
An array mapping old UIDs (keys) to new UIDs (values) on success (if the IMAP server and/or driver support the UIDPLUS extension) or true.
_setQuota(\Horde_Imap_Client_Mailbox $root, $options) : boolean
Set quota limits.
| \Horde_Imap_Client_Mailbox | $root | The quota root. |
| $options |
True on success.
_getQuota(\Horde_Imap_Client_Mailbox $root) : mixed
Get quota limits.
| \Horde_Imap_Client_Mailbox | $root | The quota root. |
An array with resource keys. Each key holds an array with 2 values: 'limit' and 'usage'.
_getQuotaRoot(\Horde_Imap_Client_Mailbox $mailbox) : mixed
Get quota limits for a mailbox.
| \Horde_Imap_Client_Mailbox | $mailbox | A mailbox. |
An array with the keys being the quota roots. Each key holds an array with resource keys: each of these keys holds an array with 2 values: 'limit' and 'usage'.
_getACL(\Horde_Imap_Client_Mailbox $mailbox) : array
Get ACL rights for a given mailbox.
| \Horde_Imap_Client_Mailbox | $mailbox | A mailbox. |
An array with identifiers as the keys and Horde_Imap_Client_Data_Acl objects as the values.
_setACL(\Horde_Imap_Client_Mailbox $mailbox, string $identifier, array $options)
Set ACL rights for a given mailbox/identifier.
| \Horde_Imap_Client_Mailbox | $mailbox | A mailbox. |
| string | $identifier | The identifier to alter (UTF7-IMAP). |
| array | $options | Additional options. 'rights' contains the string of rights to set on the server. |
_deleteACL(\Horde_Imap_Client_Mailbox $mailbox, string $identifier)
Deletes ACL rights for a given mailbox/identifier.
| \Horde_Imap_Client_Mailbox | $mailbox | A mailbox. |
| string | $identifier | The identifier to delete (UTF7-IMAP). |
_listACLRights(\Horde_Imap_Client_Mailbox $mailbox, string $identifier) : \Horde_Imap_Client_Data_AclRights
Get ACL rights for a given mailbox/identifier.
| \Horde_Imap_Client_Mailbox | $mailbox | A mailbox. |
| string | $identifier | The identifier to query (UTF7-IMAP). |
An ACL data rights object.
_getMyACLRights(\Horde_Imap_Client_Mailbox $mailbox) : \Horde_Imap_Client_Data_Acl
Get the ACL rights for the current user for a given mailbox.
| \Horde_Imap_Client_Mailbox | $mailbox | A mailbox. |
An ACL data object.
_getMetadata(\Horde_Imap_Client_Mailbox $mailbox, array $entries, array $options) : array
Get metadata for a given mailbox.
| \Horde_Imap_Client_Mailbox | $mailbox | A mailbox. |
| array | $entries | The entries to fetch (UTF7-IMAP strings). |
| array | $options | Additional options. |
An array with metadata names as the keys and metadata values as the values.
_setMetadata(\Horde_Imap_Client_Mailbox $mailbox, array $data)
Set metadata for a given mailbox/identifier.
| \Horde_Imap_Client_Mailbox | $mailbox | A mailbox. |
| array | $data | A set of data values. See setMetadata() for format. |
_updateCache(\Horde_Imap_Client_Fetch_Results $data)
Store FETCH data in cache.
| \Horde_Imap_Client_Fetch_Results | $data | The fetch results. |
_moveCache(\Horde_Imap_Client_Mailbox $to, array $map, string $uidvalid)
Moves cache entries from the current mailbox to another mailbox.
| \Horde_Imap_Client_Mailbox | $to | The destination mailbox. |
| array | $map | Mapping of source UIDs (keys) to destination UIDs (values). |
| string | $uidvalid | UIDVALIDITY of destination mailbox. |
_deleteMsgs(\Horde_Imap_Client_Mailbox $mailbox, \Horde_Imap_Client_Ids $ids, array $opts = array()) : \Horde_Imap_Client_Ids
Delete messages in the cache.
| \Horde_Imap_Client_Mailbox | $mailbox | The mailbox. |
| \Horde_Imap_Client_Ids | $ids | The list of IDs to delete in $mailbox. |
| array | $opts | Additional options (not used in base class). |
UIDs that were deleted.
_getSearchCache(string $type, array $options) : mixed
Retrieve data from the search cache.
| string | $type | The cache type ('search' or 'thread'). |
| array | $options | The options array of the calling function. |
Returns search cache metadata. If search was retrieved, data is in key 'data'. Returns null if caching is not available.
_syncStatus(mixed $mailbox) : array
Return the current mailbox synchronization status.
| mixed | $mailbox | A mailbox. Either a Horde_Imap_Client_Mailbox object or a string (UTF-8). |
An array with status data. (This data is not guaranteed to have any specific format).
_getUidByMessageId(\Horde_Imap_Client_Mailbox $mailbox, string $msgid) : string
Get a message UID by the Message-ID. Returns the last message in a mailbox that matches.
| \Horde_Imap_Client_Mailbox | $mailbox | The mailbox to search |
| string | $msgid | Message-ID. |
UID (null if not found).
_fetchCmd(\Horde_Imap_Client_Fetch_Results $results, array $options)
Fetch data for a given fetch query.
| \Horde_Imap_Client_Fetch_Results | $results | Fetch results. |
| array | $options | Fetch query options. |
_pop3Cache(string $type, integer $index = self::MBOX_CACHE, mixed $data = null) : mixed
Retrieve locally cached message data.
| string | $type | Either 'hdr', 'hdrob', 'msg', 'size', 'stat', 'top', or 'uidl'. |
| integer | $index | The message index. |
| mixed | $data | Additional information needed. |
The cached data. 'msg' returns a stream resource. All other types return strings.
_sendLine(string $cmd, array $options = array()) : array
Perform a command on the server. A connection to the server must have already been made.
| string | $cmd | The command to execute. |
| array | $options | Additional options:
- debug: (string) When debugging, send this string instead of the
actual command/data sent.
DEFAULT: Raw data output to debug stream.
- multiline: (mixed) 'array', 'none', or 'stream'.
|
See _getResponse().
_getResponse(mixed $multiline = false) : array
Gets a line from the stream and parses it.
| mixed | $multiline | 'array', 'none', 'stream', or null. |
An array with the following keys:
_getSeqIds(\Horde_Imap_Client_Ids $ids) : array
Returns a list of sequence IDs.
| \Horde_Imap_Client_Ids | $ids | The ID list. |
A list of sequence IDs.
_parseResponseCode(string $text) : object
Parses response text for response codes (RFC 2449 [8]).
| string | $text | The response text. |
An object with the following properties: