Differences Between: [Versions 310 and 400] [Versions 39 and 400] [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]
Copyright 2005-2017 Horde LLC (http://www.horde.org/) See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Copyright: | 1999-2007 The SquirrelMail Project Team |
Copyright: | 2005-2017 Horde LLC |
License: | http://www.horde.org/licenses/lgpl21 LGPL 2.1 |
File Size: | 5166 lines (185 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
Horde_Imap_Client_Socket:: (89 methods):
__construct()
__get()
getParam()
update()
_initCapability()
_parseCapability()
_noop()
_getNamespaces()
_parseNamespace()
_login()
_connect()
_tryLogin()
_authInitialResponse()
_loginTasks()
_logout()
_sendID()
_parseID()
_getID()
_setLanguage()
_getLanguage()
_parseLanguage()
_enable()
_parseEnabled()
_openMailbox()
_createMailbox()
_deleteMailbox()
_renameMailbox()
_subscribeMailbox()
_listMailboxes()
_getMailboxList()
_parseList()
_status()
_parseStatus()
_prepareStatusResponse()
_append()
_appendData()
_convertCatenateUrl()
_check()
_close()
_expunge()
_parseVanished()
_search()
_parseSearch()
_parseEsearch()
_setComparator()
_getComparator()
_parseComparator()
_thread()
_parseThread()
_parseThreadLevel()
_fetch()
_fetchCmd()
_partialAtom()
_parseFetch()
_parseBodystructure()
_parseStructureParams()
_parseEnvelope()
_vanished()
_store()
_storeCmd()
_copy()
_setQuota()
_getQuota()
_parseQuota()
_getQuotaRoot()
_setACL()
_deleteACL()
_getACL()
_parseACL()
_listACLRights()
_parseListRights()
_getMyACLRights()
_parseMyRights()
_getMetadata()
_getAnnotateMoreEntry()
_setMetadata()
_parseAnnotation()
_parseMetadata()
_deleteMsgs()
_getMboxFormatOb()
_sendCmd()
_sendCmdChunk()
_processCmd()
_processCmdContinuation()
_command()
_pipeline()
_getLine()
_serverResponse()
_responseCode()
Class: Horde_Imap_Client_Socket - X-Ref
An interface to an IMAP4rev1 server (RFC 3501) using standard PHP code.__construct(array $params = array() X-Ref |
param: array $params A hash containing configuration parameters. |
__get($name) X-Ref |
No description |
getParam($key) X-Ref |
No description |
update(SplSubject $subject) X-Ref |
No description |
_initCapability() X-Ref |
No description |
_parseCapability(Horde_Imap_Client_Interaction_Pipeline $pipeline,$data) X-Ref |
Parse a CAPABILITY Response (RFC 3501 [7.2.1]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: array $data An array of CAPABILITY strings. |
_noop() X-Ref |
No description |
_getNamespaces() X-Ref |
No description |
_parseNamespace(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a NAMESPACE response (RFC 2342 [5] & RFC 5255 [3.4]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The NAMESPACE data. |
_login() X-Ref |
No description |
_connect() X-Ref |
Connects to the IMAP server. |
_tryLogin($method) X-Ref |
Authenticate to the IMAP server. return: Horde_Imap_Client_Interaction_Pipeline Pipeline object. param: string $method IMAP login method. |
_authInitialResponse($method, $ir, $username = null) X-Ref |
No description |
_loginTasks($firstlogin = true, array $resp = array() X-Ref |
Perform login tasks. return: boolean True if global login tasks should be performed. param: boolean $firstlogin Is this the first login? param: array $resp The data response from the login command. |
_logout() X-Ref |
No description |
_sendID($info) X-Ref |
No description |
_parseID(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse an ID response (RFC 2971 [3.2]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The server response. |
_getID() X-Ref |
No description |
_setLanguage($langs) X-Ref |
No description |
_getLanguage($list) X-Ref |
No description |
_parseLanguage(Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a LANGUAGE response (RFC 5255 [3.3]). param: Horde_Imap_Client_Tokenize $data The server response. |
_enable($exts) X-Ref |
Enable an IMAP extension (see RFC 5161). param: array $exts The extensions to enable. |
_parseEnabled(Horde_Imap_Client_Tokenize $data) X-Ref |
Parse an ENABLED response (RFC 5161 [3.2]). param: Horde_Imap_Client_Tokenize $data The server response. |
_openMailbox(Horde_Imap_Client_Mailbox $mailbox, $mode) X-Ref |
No description |
_createMailbox(Horde_Imap_Client_Mailbox $mailbox, $opts) X-Ref |
No description |
_deleteMailbox(Horde_Imap_Client_Mailbox $mailbox) X-Ref |
No description |
_renameMailbox(Horde_Imap_Client_Mailbox $old,Horde_Imap_Client_Mailbox $new) X-Ref |
No description |
_subscribeMailbox(Horde_Imap_Client_Mailbox $mailbox,$subscribe) X-Ref |
No description |
_listMailboxes($pattern, $mode, $options) X-Ref |
No description |
_getMailboxList($pattern, $mode, $options,$subscribed = null) X-Ref |
Obtain a list of mailboxes. return: array See listMailboxes((). param: array $pattern The mailbox search pattern(s). param: integer $mode Which mailboxes to return. param: array $options Additional options. 'no_listext' will skip param: array $subscribed A list of subscribed mailboxes. |
_parseList(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a LIST/LSUB response (RFC 3501 [7.2.2 & 7.2.3]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The server response (includes |
_status($mboxes, $flags) X-Ref |
No description |
_parseStatus(Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a STATUS response (RFC 3501 [7.2.4]). param: Horde_Imap_Client_Tokenize $data Token data |
_prepareStatusResponse($request, $mailbox) X-Ref |
Prepares a status response for a mailbox. param: array $request The status keys to return. param: string $mailbox The mailbox to query. |
_append(Horde_Imap_Client_Mailbox $mailbox, $data,$options) X-Ref |
No description |
_appendData($data, &$asize) X-Ref |
Prepares append message data for insertion into the IMAP command string. return: Horde_Imap_Client_Data_Format_String_Nonascii The data object. param: mixed $data Either a resource or a string. param: integer &$asize Total append size. |
_convertCatenateUrl($url) X-Ref |
Converts a CATENATE URL to stream data. return: resource A stream containing the data. param: string $url The CATENATE URL. |
_check() X-Ref |
No description |
_close($options) X-Ref |
No description |
_expunge($options) X-Ref |
No description |
_parseVanished(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a VANISHED response (RFC 7162 [3.2.10]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The response data. |
_search($query, $options) X-Ref |
Search a mailbox. This driver supports all IMAP4rev1 search criteria as defined in RFC 3501. |
_parseSearch(Horde_Imap_Client_Interaction_Pipeline $pipeline,$data) X-Ref |
Parse a SEARCH/SORT response (RFC 3501 [7.2.5]; RFC 4466 [3]; RFC 5256 [4]; RFC 5267 [3]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: array $data A list of IDs (message sequence numbers or UIDs). |
_parseEsearch(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse an ESEARCH response (RFC 4466 [2.6.2]) Format: (TAG "a567") UID COUNT 5 ALL 4:19,21,28 param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The server response. |
_setComparator($comparator) X-Ref |
No description |
_getComparator() X-Ref |
No description |
_parseComparator(Horde_Imap_Client_Interaction_Pipeline $pipeline,$data) X-Ref |
Parse a COMPARATOR response (RFC 5255 [4.8]) param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The server response. |
_thread($options) X-Ref |
_parseThread(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a THREAD response (RFC 5256 [4]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data Thread data. |
_parseThreadLevel(&$thread,Horde_Imap_Client_Tokenize $data,$level = 0) X-Ref |
Parse a level of a THREAD response (RFC 5256 [4]). param: array $thread Results. param: Horde_Imap_Client_Tokenize $data Thread data. param: integer $level The current tree level. |
_fetch(Horde_Imap_Client_Fetch_Results $results,$queries) X-Ref |
No description |
_fetchCmd(Horde_Imap_Client_Interaction_Pipeline $pipeline,$options) X-Ref |
Add a FETCH command to the given pipeline. param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: array $options Fetch query |
_partialAtom($opts) X-Ref |
Add a partial atom to an IMAP command based on the criteria options. return: string The partial atom. param: array $opts Criteria options. |
_parseFetch(Horde_Imap_Client_Interaction_Pipeline $pipeline,$id,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a FETCH response (RFC 3501 [7.4.2]). A FETCH response may occur due to a FETCH command, or due to a change in a message's state (i.e. the flags change). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: integer $id The message sequence number. param: Horde_Imap_Client_Tokenize $data The server response. |
_parseBodystructure(Horde_Imap_Client_Tokenize $data) X-Ref |
Recursively parse BODYSTRUCTURE data from a FETCH return (see RFC 3501 [7.4.2]). return: Horde_Mime_Part Mime part object. param: Horde_Imap_Client_Tokenize $data Data returned from the server. |
_parseStructureParams($data) X-Ref |
Helper function to parse a parameters-like tokenized array. return: array The parameter array. param: mixed $data Message data. Either a Horde_Imap_Client_Tokenize |
_parseEnvelope(Horde_Imap_Client_Tokenize $data) X-Ref |
Parse ENVELOPE data from a FETCH return (see RFC 3501 [7.4.2]). return: Horde_Imap_Client_Data_Envelope An envelope object. param: Horde_Imap_Client_Tokenize $data Data returned from the server. |
_vanished($modseq, Horde_Imap_Client_Ids $ids) X-Ref |
No description |
_store($options) X-Ref |
No description |
_storeCmd($options) X-Ref |
Create a store command. return: Horde_Imap_Client_Interaction_Pipeline Pipeline object. param: array $options See Horde_Imap_Client_Base#_store(). |
_copy(Horde_Imap_Client_Mailbox $dest, $options) X-Ref |
No description |
_setQuota(Horde_Imap_Client_Mailbox $root, $resources) X-Ref |
No description |
_getQuota(Horde_Imap_Client_Mailbox $root) X-Ref |
No description |
_parseQuota(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a QUOTA response (RFC 2087 [5.1]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The server response. |
_getQuotaRoot(Horde_Imap_Client_Mailbox $mailbox) X-Ref |
No description |
_setACL(Horde_Imap_Client_Mailbox $mailbox, $identifier,$options) X-Ref |
No description |
_deleteACL(Horde_Imap_Client_Mailbox $mailbox, $identifier) X-Ref |
No description |
_getACL(Horde_Imap_Client_Mailbox $mailbox) X-Ref |
No description |
_parseACL(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse an ACL response (RFC 4314 [3.6]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The server response. |
_listACLRights(Horde_Imap_Client_Mailbox $mailbox,$identifier) X-Ref |
No description |
_parseListRights(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a LISTRIGHTS response (RFC 4314 [3.7]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The server response. |
_getMyACLRights(Horde_Imap_Client_Mailbox $mailbox) X-Ref |
No description |
_parseMyRights(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a MYRIGHTS response (RFC 4314 [3.8]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The server response. |
_getMetadata(Horde_Imap_Client_Mailbox $mailbox,$entries, $options) X-Ref |
No description |
_getAnnotateMoreEntry($name) X-Ref |
Split a name for the METADATA extension into the correct syntax for the older ANNOTATEMORE version. return: array A list of two elements: The entry name and the value param: string $name A name for a metadata entry. |
_setMetadata(Horde_Imap_Client_Mailbox $mailbox, $data) X-Ref |
No description |
_parseAnnotation(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse an ANNOTATION response (ANNOTATEMORE/ANNOTATEMORE2). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The server response. |
_parseMetadata(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Tokenize $data) X-Ref |
Parse a METADATA response (RFC 5464 [4.4]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Tokenize $data The server response. |
_deleteMsgs(Horde_Imap_Client_Mailbox $mailbox,Horde_Imap_Client_Ids $ids,array $opts = array() X-Ref |
param: array $opts Options: |
_getMboxFormatOb($mailbox, $list = false) X-Ref |
Return the proper mailbox format object based on the server's capabilities. return: Horde_Imap_Client_Data_Format_Mailbox A mailbox format object. param: string $mailbox The mailbox. param: boolean $list Is this object used in a LIST command? |
_sendCmd($cmd) X-Ref |
Sends command(s) to the IMAP server. A connection to the server must have already been made. return: Horde_Imap_Client_Interaction_Pipeline A pipeline object. param: mixed $cmd Either a Command object or a Pipeline object. |
_sendCmdChunk($pipeline, $chunk) X-Ref |
Send a chunk of commands and/or continuation fragments to the server. param: Horde_Imap_Client_Interaction_Pipeline $pipeline The pipeline param: array $chunk List of commands to send. |
_processCmd($pipeline, $cmd, $data) X-Ref |
Process/send a command to the remote server. return: boolean True if EOL needed to finish command. param: Horde_Imap_Client_Interaction_Pipeline $pipeline The pipeline param: Horde_Imap_Client_Interaction_Command $cmd The master command. param: Horde_Imap_Client_Data_Format_List $data Commands to send. |
_processCmdContinuation($pipeline, $noexception = false) X-Ref |
Process a command continuation response. return: mixed A Horde_Imap_Client_Interaction_Server_Continuation param: Horde_Imap_Client_Interaction_Pipeline $pipeline The pipeline param: boolean $noexception Don't throw |
_command($cmd) X-Ref |
Shortcut to creating a new IMAP client command object. return: Horde_Imap_Client_Interaction_Command A command object. param: string $cmd The IMAP command. |
_pipeline($cmd = null) X-Ref |
Shortcut to creating a new pipeline object. return: Horde_Imap_Client_Interaction_Pipeline A pipeline object. param: Horde_Imap_Client_Interaction_Command $cmd An IMAP command to |
_getLine(Horde_Imap_Client_Interaction_Pipeline $pipeline) X-Ref |
Gets data from the IMAP server stream and parses it. return: Horde_Imap_Client_Interaction_Server Server object. param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline |
_serverResponse(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Interaction_Server $ob) X-Ref |
Handle untagged server responses (see RFC 3501 [2.2.2]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Interaction_Server $ob Server |
_responseCode(Horde_Imap_Client_Interaction_Pipeline $pipeline,Horde_Imap_Client_Interaction_Server $ob) X-Ref |
Handle status responses (see RFC 3501 [7.1]). param: Horde_Imap_Client_Interaction_Pipeline $pipeline Pipeline param: Horde_Imap_Client_Interaction_Server $ob Server object. |