Zend\Mail\Storage\Imap
Synopsis
class Imap
extends AbstractStorage
implements
FolderInterface,WritableInterface
{
- // members
- protected Imap $protocol;
- protected string $currentFolder;
- protected array $knownFlags;
- protected array $searchFlags;
- // Inherited members from AbstractStorage
- protected array $has;
- protected integer $iterationPos;
- protected null|int $iterationMax;
- protected string $messageClass;
- // methods
- public int countMessages()
- public int|array getSize()
- public Message getMessage()
- public void getRawHeader()
- public void getRawContent()
- public void __construct()
- public void close()
- public void noop()
- public void removeMessage()
- public array|string getUniqueId()
- public int getNumberByUniqueId()
- public Folder getFolders()
- public void selectFolder()
- public Folder getCurrentFolder()
- public void createFolder()
- public void removeFolder()
- public void renameFolder()
- public void appendMessage()
- public void copyMessage()
- public void moveMessage()
- public void setFlags()
- // Inherited methods from AbstractStorage
- public bool __get()
- public array getCapabilities()
- public abstract int countMessages()
- public abstract int|array getSize()
- public abstract Message getMessage()
- public abstract string getRawHeader()
- public abstract string getRawContent()
- public abstract void __construct()
- public void __destruct()
- public abstract void close()
- public abstract void noop()
- public abstract void removeMessage()
- public abstract array|string getUniqueId()
- public abstract int getNumberByUniqueId()
- public int count()
- public bool offsetExists()
- public Message offsetGet()
- public void offsetSet()
- public bool offsetUnset()
- public void rewind()
- public Message current()
- public int key()
- public void next()
- public bool valid()
- public void seek()
Hierarchy
Extends
Implements
Tasks
Line | Task |
---|---|
133 | implement |
137 | toplines |
153 | implement |
245 | expunge here or at close? we can handle an error here better and are more fail safe |
281 | use search to find number directly |
388 | we assume / as the hierarchy delim - need to get that from the folder class! |
458 | handle class instances for $message |
Members
protected
- $currentFolder
—
string
name of current folder - $has
—
array
class capabilities with default values - $iterationMax
—
Zend\Mail\Storage\null|int
maximum iteration position (= message count) - $iterationPos
—
int
current iteration position - $knownFlags
—
array
IMAP flags to constants translation - $messageClass
—
string
used message class, change it in an extended class to extend the returned message class - $protocol
—
Zend\Mail\Storage\null|\Zend\Mail\Protocol\Imap
protocol handler - $searchFlags
—
array
IMAP flags to search criteria
Methods
public
- __construct() — create instance with parameters Supported parameters are - user username - host hostname or ip address of IMAP server [optional, default = 'localhost'] - password password for user 'username' [optional, default = ''] - port port for IMAP server [optional, default = 110] - ssl 'SSL' or 'TLS' for secure sockets - folder select this folder [optional, default = 'INBOX']
- appendMessage()
- close() — Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
- copyMessage() — copy an existing message
- countMessages() — Count messages all messages in current box
- createFolder() — create a new folder
- getCurrentFolder() — get \Zend\Mail\Storage\Folder instance for current folder
- getFolders() — get root folder or given folder
- getMessage() — Fetch a message
- getNumberByUniqueId() — get a message number from a unique id
- getRawContent()
- getRawHeader()
- getSize() — get a list of messages with number and size
- getUniqueId() — get unique id for one or all messages
- moveMessage() — move an existing message
- noop() — Keep the server busy.
- removeFolder() — remove a folder
- removeMessage() — Remove a message from server. If you're doing that from a web environment you should be careful and use a uniqueid as parameter if possible to identify the message.
- renameFolder() — rename and/or move folder
- selectFolder() — select given folder
- setFlags() — set flags for message
Inherited from Zend\Mail\Storage\AbstractStorage
public
- __get() — Getter for has-properties. The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop
- close() — Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.
- count() — Countable::count()
- countMessages() — Count messages messages in current box/folder
- current() — Iterator::current()
- getCapabilities() — Get a full list of features supported by the specific mail lib and the server
- getMessage() — Get a message with headers and body
- getNumberByUniqueId() — get a message number from a unique id
- getRawContent() — Get raw content of message or part
- getRawHeader() — Get raw header of message or part
- getSize() — Get a list of messages with number and size
- getUniqueId() — get unique id for one or all messages
- key() — Iterator::key()
- next() — Iterator::next()
- noop() — Keep the resource alive.
- offsetExists() — ArrayAccess::offsetExists()
- offsetGet() — ArrayAccess::offsetGet()
- offsetSet() — ArrayAccess::offsetSet()
- offsetUnset() — ArrayAccess::offsetUnset()
- removeMessage() — delete a message from current box/folder
- rewind() — Iterator::rewind()
- seek() — SeekableIterator::seek()
- valid() — Iterator::valid()