Zend\Mail\Protocol\Imap
Synopsis
class Imap
{
- // constants
- const TIMEOUT_CONNECTION = 30;
- // methods
- public void __construct()
- public void __destruct()
- public string connect()
- protected string _nextLine()
- protected bool _assumedNextLine()
- protected string _nextTaggedLine()
- protected array _decodeLine()
- public bool readLine()
- public null|bool|array readResponse()
- public void sendRequest()
- public mixed requestAndResponse()
- public string|array escapeString()
- public string escapeList()
- public bool login()
- public bool logout()
- public array capability()
- public bool|array examineOrSelect()
- public bool|array select()
- public bool|array examine()
- public string|array fetch()
- public array listMailbox()
- public bool|array store()
- public bool append()
- public bool copy()
- public bool create()
- public bool rename()
- public bool delete()
- public bool expunge()
- public bool noop()
- public array search()
Tasks
Line | Task |
---|---|
178 | add handling of '[' and ']' to parser for easier handling of response text |
762 | parse response? |
773 | parse response |
Constants
Name | Value |
---|---|
TIMEOUT_CONNECTION | 30 |
Members
protected
- $socket
—
Zend\Mail\Protocol\resource|null
socket to imap server - $tagCount
—
int
counter for request tag
Methods
protected
- _assumedNextLine() — get next line and assume it starts with $start. some requests give a simple feedback so we can quickly check if we can go on.
- _decodeLine() — split a given line in tokens. a token is literal of any form or a list
- _nextLine() — get the next line from socket with error checking, but nothing else
- _nextTaggedLine() — get next line and split the tag. that's the normal case for a response line
public
- __construct() — Public constructor
- __destruct() — Public destructor
- append() — append a new message to given folder
- capability() — Get capabilities from IMAP server
- connect() — Open connection to IMAP server
- copy() — copy message set from current folder to other folder
- create() — create a new folder (and parent folders if needed)
- delete() — remove a folder
- escapeList() — escape a list with literals or lists
- escapeString() — escape one or more literals i.e. for sendRequest
- examine() — examine folder
- examineOrSelect() — Examine and select have the same response. The common code for both is in this method
- expunge() — permanently remove messages
- fetch() — fetch one or more items of one or more messages
- listMailbox() — get mailbox list
- login() — Login to IMAP server.
- logout() — logout of imap server
- noop() — send noop
- readLine() — read a response "line" (could also be more than one real line if response has {..}<NL>) and do a simple decode
- readResponse() — read all lines of response until given tag is found (last line of response)
- rename() — rename an existing folder
- requestAndResponse() — send a request and get response at once
- search() — do a search request
- select() — change folder
- sendRequest() — send a request
- store() — set flags