Zend_Mail_Storage_Imap Class Reference

Inheritance diagram for Zend_Mail_Storage_Imap:

Public Member Functions
	countMessages ($flags=null)
	getSize ($id=0)
	getMessage ($id)
	getRawHeader ($id, $part=null, $topLines=0)
	getRawContent ($id, $part=null)
	__construct ($params)
	close ()
	noop ()
	removeMessage ($id)
	getUniqueId ($id=null)
	getNumberByUniqueId ($id)
	getFolders ($rootFolder=null)
	selectFolder ($globalName)
	getCurrentFolder ()
	createFolder ($name, $parentFolder=null)
	removeFolder ($name)
	renameFolder ($oldName, $newName)
	appendMessage ($message, $folder=null, $flags=null)
	copyMessage ($id, $folder)
	moveMessage ($id, $folder)
	setFlags ($id, $flags)
Public Member Functions inherited from Zend_Mail_Storage_Abstract
	__get ($var)
	getCapabilities ()
	countMessages ()
	getSize ($id=0)
	getMessage ($id)
	getRawHeader ($id, $part=null, $topLines=0)
	getRawContent ($id, $part=null)
	__construct ($params)
	__destruct ()
	close ()
	noop ()
	removeMessage ($id)
	getUniqueId ($id=null)
	getNumberByUniqueId ($id)
	count ()
	offsetExists ($id)
	offsetGet ($id)
	offsetSet ($id, $value)
	offsetUnset ($id)
	rewind ()
	current ()
	key ()
	next ()
	valid ()
	seek ($pos)

Protected Attributes
	$_protocol
	$_currentFolder = ''
Protected Attributes inherited from Zend_Mail_Storage_Abstract
	$_has
	$_iterationPos = 0
	$_iterationMax = null
	$_messageClass = 'Zend_Mail_Message'

Static Protected Attributes
static	$_knownFlags
static	$_searchFlags

Detailed Description

Definition at line 66 of file Imap.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$params

)

create instance with parameters Supported paramters 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']

Parameters

array

$params

mail reader specific parameters

Exceptions

Zend_Mail_Storage_Exception
Zend_Mail_Protocol_Exception

See also

Zend_Mail_Storage_Exception

Zend_Mail_Storage_Exception

Zend_Mail_Storage_Exception

Definition at line 239 of file Imap.php.

    {
        if (is_array($params)) {
            $params = (object)$params;
        }

        $this->_has['flags'] = true;

        if ($params instanceof Zend_Mail_Protocol_Imap) {
            $this->_protocol = $params;
            try {
                $this->selectFolder('INBOX');
            } catch(Zend_Mail_Storage_Exception $e) {
                #require_once 'Zend/Mail/Storage/Exception.php';
                throw new Zend_Mail_Storage_Exception('cannot select INBOX, is this a valid transport?', 0, $e);
            }
            return;
        }

        if (!isset($params->user)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('need at least user in params');
        }

        $host     = isset($params->host)     ? $params->host     : 'localhost';
        $password = isset($params->password) ? $params->password : '';
        $port     = isset($params->port)     ? $params->port     : null;
        $ssl      = isset($params->ssl)      ? $params->ssl      : false;

        $this->_protocol = new Zend_Mail_Protocol_Imap();
        $this->_protocol->connect($host, $port, $ssl);
        if (!$this->_protocol->login($params->user, $password)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('cannot login, user or password wrong');
        }
        $this->selectFolder(isset($params->folder) ? $params->folder : 'INBOX');
    }

Member Function Documentation

appendMessage()

appendMessage	(		$message,
			$folder = null,
			$flags = null
	)

append a new message to mail storage

Parameters

string	$message	message as string or instance of message class
null | string | Zend_Mail_Storage_Folder	$folder	folder for new message, else current folder is taken
null | array	$flags	set flags for new message, else a default set is used

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Writable_Interface.

Definition at line 572 of file Imap.php.

    {
        if ($folder === null) {
            $folder = $this->_currentFolder;
        }

        if ($flags === null) {
            $flags = array(Zend_Mail_Storage::FLAG_SEEN);
        }

        // TODO: handle class instances for $message
        if (!$this->_protocol->append($folder, $message, $flags)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('cannot create message, please check if the folder exists and your flags');
        }
    }

close()

close

(

)

Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.

Returns

null

Definition at line 292 of file Imap.php.

    {
        $this->_currentFolder = '';
        $this->_protocol->logout();
    }

copyMessage()

copyMessage	(		$id,
			$folder
	)

copy an existing message

Parameters

int	$id	number of message
string | Zend_Mail_Storage_Folder	$folder	name or instance of targer folder

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Writable_Interface.

Definition at line 600 of file Imap.php.

    {
        if (!$this->_protocol->copy($folder, $id)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('cannot copy message, does the folder exist?');
        }
    }

countMessages()

countMessages

(

$flags = null

)

Count messages all messages in current box

Returns

int number of messages

Exceptions

Zend_Mail_Storage_Exception
Zend_Mail_Protocol_Exception

See also

Zend_Mail_Storage_Exception

Definition at line 115 of file Imap.php.

    {
        if (!$this->_currentFolder) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('No selected folder to count');
        }

        if ($flags === null) {
            return count($this->_protocol->search(array('ALL')));
        }

        $params = array();
        foreach ((array)$flags as $flag) {
            if (isset(self::$_searchFlags[$flag])) {
                $params[] = self::$_searchFlags[$flag];
            } else {
                $params[] = 'KEYWORD';
                $params[] = $this->_protocol->escapeString($flag);
            }
        }
        return count($this->_protocol->search($params));
    }

createFolder()

createFolder	(		$name,
			$parentFolder = null
	)

create a new folder

This method also creates parent folders if necessary. Some mail storages may restrict, which folder may be used as parent or which chars may be used in the folder name

Parameters

string	$name	global name of folder, local name if $parentFolder is set
string | Zend_Mail_Storage_Folder	$parentFolder	parent folder for new folder, else root folder is parent

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Writable_Interface.

Definition at line 496 of file Imap.php.

    {
        // TODO: we assume / as the hierarchy delim - need to get that from the folder class!
        if ($parentFolder instanceof Zend_Mail_Storage_Folder) {
            $folder = $parentFolder->getGlobalName() . '/' . $name;
        } else if ($parentFolder != null) {
            $folder = $parentFolder . '/' . $name;
        } else {
            $folder = $name;
        }

        if (!$this->_protocol->create($folder)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('cannot create folder');
        }
    }

getCurrentFolder()

getCurrentFolder

(

)

get Zend_Mail_Storage_Folder instance for current folder

Returns

Zend_Mail_Storage_Folder instance of current folder

Exceptions

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Folder_Interface.

Definition at line 480 of file Imap.php.

    {
        return $this->_currentFolder;
    }

getFolders()

getFolders

(

$rootFolder = null

)

get root folder or given folder

Parameters

string

$rootFolder

get folder structure for given folder, else root

Returns

Zend_Mail_Storage_Folder root or wanted folder

Exceptions

Zend_Mail_Storage_Exception
Zend_Mail_Protocol_Exception

See also

Zend_Mail_Storage_Exception

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Folder_Interface.

Definition at line 397 of file Imap.php.

    {
        $folders = $this->_protocol->listMailbox((string)$rootFolder);
        if (!$folders) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('folder not found');
        }

        ksort($folders, SORT_STRING);
        $root = new Zend_Mail_Storage_Folder('/', '/', false);
        $stack = array(null);
        $folderStack = array(null);
        $parentFolder = $root;
        $parent = '';

        foreach ($folders as $globalName => $data) {
            do {
                if (!$parent || strpos($globalName, $parent) === 0) {
                    $pos = strrpos($globalName, $data['delim']);
                    if ($pos === false) {
                        $localName = $globalName;
                    } else {
                        $localName = substr($globalName, $pos + 1);
                    }
                    $selectable = !$data['flags'] || !in_array('\\Noselect', $data['flags']);

                    array_push($stack, $parent);
                    $parent = $globalName . $data['delim'];
                    $folder = new Zend_Mail_Storage_Folder($localName, $globalName, $selectable);
                    $parentFolder->$localName = $folder;
                    array_push($folderStack, $parentFolder);
                    $parentFolder = $folder;
                    break;
                } else if ($stack) {
                    $parent = array_pop($stack);
                    $parentFolder = array_pop($folderStack);
                }
            } while ($stack);
            if (!$stack) {
                #require_once 'Zend/Mail/Storage/Exception.php';
                throw new Zend_Mail_Storage_Exception('error while constructing folder tree');
            }
        }

        return $root;
    }

getMessage()

getMessage

(

$id

)

Fetch a message

Parameters

int

$id

number of message

Returns

Zend_Mail_Message

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 163 of file Imap.php.

    {
        $data = $this->_protocol->fetch(array('FLAGS', 'RFC822.HEADER'), $id);
        $header = $data['RFC822.HEADER'];

        $flags = array();
        foreach ($data['FLAGS'] as $flag) {
            $flags[] = isset(self::$_knownFlags[$flag]) ? self::$_knownFlags[$flag] : $flag;
        }

        return new $this->_messageClass(array('handler' => $this, 'id' => $id, 'headers' => $header, 'flags' => $flags));
    }

getNumberByUniqueId()

getNumberByUniqueId

(

$id

)

get a message number from a unique id

I.e. if you have a webmailer that supports deleting messages you should use unique ids as parameter and use this method to translate it to message number right before calling removeMessage()

Parameters

string

$id

unique id

Returns

int message number

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Definition at line 371 of file Imap.php.

    {
        // TODO: use search to find number directly
        $ids = $this->getUniqueId();
        foreach ($ids as $k => $v) {
            if ($v == $id) {
                return $k;
            }
        }

        #require_once 'Zend/Mail/Storage/Exception.php';
        throw new Zend_Mail_Storage_Exception('unique id not found');
    }

getRawContent()

getRawContent	(		$id,
			$part = null
	)

See also

Zend_Mail_Storage_Exception

Definition at line 211 of file Imap.php.

    {
        if ($part !== null) {
            // TODO: implement
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('not implemented');
        }

        return $this->_protocol->fetch('RFC822.TEXT', $id);
    }

getRawHeader()

getRawHeader	(		$id,
			$part = null,
			$topLines = 0
	)

See also

Zend_Mail_Storage_Exception

Definition at line 187 of file Imap.php.

    {
        if ($part !== null) {
            // TODO: implement
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('not implemented');
        }

        // TODO: toplines
        return $this->_protocol->fetch('RFC822.HEADER', $id);
    }

getSize()

getSize

(

$id = 0

)

get a list of messages with number and size

Parameters

int

$id

number of message

Returns

int|array size of given message of list with all messages as array(num => size)

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 148 of file Imap.php.

    {
        if ($id) {
            return $this->_protocol->fetch('RFC822.SIZE', $id);
        }
        return $this->_protocol->fetch('RFC822.SIZE', 1, INF);
    }

getUniqueId()

getUniqueId

(

$id = null

)

get unique id for one or all messages

if storage does not support unique ids it's the same as the message number

Parameters

int | null

$id

message number

Returns

array|string message number for given message or all messages as array

Exceptions

Zend_Mail_Storage_Exception

Definition at line 352 of file Imap.php.

    {
        if ($id) {
            return $this->_protocol->fetch('UID', $id);
        }

        return $this->_protocol->fetch('UID', 1, INF);
    }

moveMessage()

moveMessage	(		$id,
			$folder
	)

move an existing message

NOTE: imap has no native move command, thus it's emulated with copy and delete

Parameters

int	$id	number of message
string | Zend_Mail_Storage_Folder	$folder	name or instance of targer folder

Returns

null

Exceptions

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Writable_Interface.

Definition at line 621 of file Imap.php.

                                              {
        $this->copyMessage($id, $folder);
        $this->removeMessage($id);
    }

noop()

noop

(

)

Keep the server busy.

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Definition at line 304 of file Imap.php.

    {
        if (!$this->_protocol->noop()) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('could not do nothing');
        }
    }

removeFolder()

removeFolder

(

$name

)

remove a folder

Parameters

string | Zend_Mail_Storage_Folder

$name

name or instance of folder

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Writable_Interface.

Definition at line 523 of file Imap.php.

    {
        if ($name instanceof Zend_Mail_Storage_Folder) {
            $name = $name->getGlobalName();
        }

        if (!$this->_protocol->delete($name)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('cannot delete folder');
        }
    }

removeMessage()

removeMessage

(

$id

)

Remove a message from server. If you're doing that from a web enviroment you should be careful and use a uniqueid as parameter if possible to identify the message.

Parameters

int

$id

number of message

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Zend_Mail_Storage_Exception

Definition at line 324 of file Imap.php.

    {
        if (!$this->_protocol->store(array(Zend_Mail_Storage::FLAG_DELETED), $id, null, '+')) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('cannot set deleted flag');
        }
        // TODO: expunge here or at close? we can handle an error here better and are more fail safe
        if (!$this->_protocol->expunge()) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('message marked as deleted, but could not expunge');
        }
    }

renameFolder()

renameFolder	(		$oldName,
			$newName
	)

rename and/or move folder

The new name has the same restrictions as in createFolder()

Parameters

string | Zend_Mail_Storage_Folder	$oldName	name or instance of folder
string	$newName	new global name of folder

Returns

null

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Writable_Interface.

Definition at line 548 of file Imap.php.

    {
        if ($oldName instanceof Zend_Mail_Storage_Folder) {
            $oldName = $oldName->getGlobalName();
        }

        if (!$this->_protocol->rename($oldName, $newName)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('cannot rename folder');
        }
    }

selectFolder()

selectFolder

(

$globalName

)

select given folder

folder must be selectable!

Parameters

Zend_Mail_Storage_Folder | string

$globalName

global name of folder or instance for subfolder

Returns

null

Exceptions

Zend_Mail_Storage_Exception
Zend_Mail_Protocol_Exception

See also

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Folder_Interface.

Definition at line 460 of file Imap.php.

    {
        $this->_currentFolder = $globalName;
        if (!$this->_protocol->select($this->_currentFolder)) {
            $this->_currentFolder = '';
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('cannot change folder, maybe it does not exist');
        }
    }

setFlags()

setFlags	(		$id,
			$flags
	)

set flags for message

NOTE: this method can't set the recent flag.

Parameters

int	$id	number of message
array	$flags	new flags for message

Exceptions

Zend_Mail_Storage_Exception

See also

Zend_Mail_Storage_Exception

Implements Zend_Mail_Storage_Writable_Interface.

Definition at line 635 of file Imap.php.

    {
        if (!$this->_protocol->store($flags, $id)) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception('cannot set flags, have you tried to set the recent flag or special chars?');
        }
    }

Field Documentation

$_currentFolder

$_currentFolder = ''

protected

Definition at line 82 of file Imap.php.

$_knownFlags

$_knownFlags

staticprotected

Initial value:

= array('\Passed'   => Zend_Mail_Storage::FLAG_PASSED,
                                          '\Answered' => Zend_Mail_Storage::FLAG_ANSWERED,
                                          '\Seen'     => Zend_Mail_Storage::FLAG_SEEN,
                                          '\Unseen'   => Zend_Mail_Storage::FLAG_UNSEEN,
                                          '\Deleted'  => Zend_Mail_Storage::FLAG_DELETED,
                                          '\Draft'    => Zend_Mail_Storage::FLAG_DRAFT,
                                          '\Flagged'  => Zend_Mail_Storage::FLAG_FLAGGED)

Definition at line 88 of file Imap.php.

$_protocol

$_protocol

protected

Definition at line 76 of file Imap.php.

$_searchFlags

$_searchFlags

staticprotected

Initial value:

= array('\Recent'   => 'RECENT',
                                           '\Answered' => 'ANSWERED',
                                           '\Seen'     => 'SEEN',
                                           '\Unseen'   => 'UNSEEN',
                                           '\Deleted'  => 'DELETED',
                                           '\Draft'    => 'DRAFT',
                                           '\Flagged'  => 'FLAGGED')

Definition at line 100 of file Imap.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Mail/Storage/Imap.php