Zend_Mail_Protocol_Imap Class Reference

Public Member Functions
	__construct ($host='', $port=null, $ssl=false)
	__destruct ()
	connect ($host, $port=null, $ssl=false)
	readLine (&$tokens=array(), $wantedTag=' *', $dontParse=false)
	readResponse ($tag, $dontParse=false)
	sendRequest ($command, $tokens=array(), &$tag=null)
	requestAndResponse ($command, $tokens=array(), $dontParse=false)
	escapeString ($string)
	escapeList ($list)
	login ($user, $password)
	logout ()
	capability ()
	examineOrSelect ($command='EXAMINE', $box='INBOX')
	select ($box='INBOX')
	examine ($box='INBOX')
	fetch ($items, $from, $to=null)
	listMailbox ($reference='', $mailbox=' *')
	store (array $flags, $from, $to=null, $mode=null, $silent=true)
	append ($folder, $message, $flags=null, $date=null)
	copy ($folder, $from, $to=null)
	create ($folder)
	rename ($old, $new)
	delete ($folder)
	expunge ()
	noop ()
	search (array $params)

Data Fields
const	TIMEOUT_CONNECTION = 30

Protected Member Functions
	_nextLine ()
	_assumedNextLine ($start)
	_nextTaggedLine (&$tag)
	_decodeLine ($line)

Protected Attributes
	$_socket
	$_tagCount = 0

Detailed Description

Definition at line 31 of file Imap.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$host = '',
			$port = null,
			$ssl = false
	)

Public constructor

Parameters

string	$host	hostname or IP address of IMAP server, if given connect() is called
int | null	$port	port of IMAP server, null for default (143 or 993 for ssl)
bool	$ssl	use ssl? 'SSL', 'TLS' or false

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 58 of file Imap.php.

    {
        if ($host) {
            $this->connect($host, $port, $ssl);
        }
    }

__destruct()

__destruct

(

)

Public destructor

Definition at line 68 of file Imap.php.

    {
        $this->logout();
    }

Member Function Documentation

_assumedNextLine()

_assumedNextLine (   $start )

protected

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.

Parameters

string

$start

the first bytes we assume to be in the next line

Returns

bool line starts with $start

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 154 of file Imap.php.

    {
        $line = $this->_nextLine();
        return strpos($line, $start) === 0;
    }

_decodeLine()

_decodeLine (   $line )

protected

split a given line in tokens. a token is literal of any form or a list

Parameters

string

$line

line to decode

Returns

array tokens, literals are returned as string, lists as array

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 184 of file Imap.php.

    {
        $tokens = array();
        $stack = array();

        /*
            We start to decode the response here. The unterstood tokens are:
                literal
                "literal" or also "lit\\er\"al"
                {bytes}<NL>literal
                (literals*)
            All tokens are returned in an array. Literals in braces (the last unterstood
            token in the list) are returned as an array of tokens. I.e. the following response:
                "foo" baz {3}<NL>bar ("f\\\"oo" bar)
            would be returned as:
                array('foo', 'baz', 'bar', array('f\\\"oo', 'bar'));

            // TODO: add handling of '[' and ']' to parser for easier handling of response text
        */
        //  replace any trailling <NL> including spaces with a single space
        $line = rtrim($line) . ' ';
        while (($pos = strpos($line, ' ')) !== false) {
            $token = substr($line, 0, $pos);
            while ($token[0] == '(') {
                array_push($stack, $tokens);
                $tokens = array();
                $token = substr($token, 1);
            }
            if ($token[0] == '"') {
                if (preg_match('%^\(*"((.|\\\\|\\")*?)" *%', $line, $matches)) {
                    $tokens[] = $matches[1];
                    $line = substr($line, strlen($matches[0]));
                    continue;
                }
            }
            if ($token[0] == '{') {
                $endPos = strpos($token, '}');
                $chars = substr($token, 1, $endPos - 1);
                if (is_numeric($chars)) {
                    $token = '';
                    while (strlen($token) < $chars) {
                        $token .= $this->_nextLine();
                    }
                    $line = '';
                    if (strlen($token) > $chars) {
                        $line = substr($token, $chars);
                        $token = substr($token, 0, $chars);
                    } else {
                        $line .= $this->_nextLine();
                    }
                    $tokens[] = $token;
                    $line = trim($line) . ' ';
                    continue;
                }
            }
            if ($stack && $token[strlen($token) - 1] == ')') {
                // closing braces are not seperated by spaces, so we need to count them
                $braces = strlen($token);
                $token = rtrim($token, ')');
                // only count braces if more than one
                $braces -= strlen($token) + 1;
                // only add if token had more than just closing braces
                if (rtrim($token) != '') {
                    $tokens[] = rtrim($token);
                }
                $token = $tokens;
                $tokens = array_pop($stack);
                // special handline if more than one closing brace
                while ($braces-- > 0) {
                    $tokens[] = $token;
                    $token = $tokens;
                    $tokens = array_pop($stack);
                }
            }
            $tokens[] = $token;
            $line = substr($line, $pos + 1);
        }

        // maybe the server forgot to send some closing braces
        while ($stack) {
            $child = $tokens;
            $tokens = array_pop($stack);
            $tokens[] = $child;
        }

        return $tokens;
    }

_nextLine()

_nextLine ( )

protected

get the next line from socket with error checking, but nothing else

Returns

string next line

Exceptions

Zend_Mail_Protocol_Exception

See also

Zend_Mail_Protocol_Exception

Definition at line 132 of file Imap.php.

    {
        $line = @fgets($this->_socket);
        if ($line === false) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('cannot read - connection closed?');
        }

        return $line;
    }

_nextTaggedLine()

_nextTaggedLine ( &  $tag )

protected

get next line and split the tag. that's the normal case for a response line

Parameters

string

$tag

tag of line is returned by reference

Returns

string next line

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 167 of file Imap.php.

    {
        $line = $this->_nextLine();

        // seperate tag from line
        list($tag, $line) = explode(' ', $line, 2);

        return $line;
    }

append()

append	(		$folder,
			$message,
			$flags = null,
			$date = null
	)

append a new message to given folder

Parameters

string	$folder	name of target folder
string	$message	full message content
array	$flags	flags for new message
string	$date	date for new message

Returns

bool success

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 724 of file Imap.php.

    {
        $tokens = array();
        $tokens[] = $this->escapeString($folder);
        if ($flags !== null) {
            $tokens[] = $this->escapeList($flags);
        }
        if ($date !== null) {
            $tokens[] = $this->escapeString($date);
        }
        $tokens[] = $this->escapeString($message);

        return $this->requestAndResponse('APPEND', $tokens, true);
    }

capability()

capability

(

)

Get capabilities from IMAP server

Returns

array list of capabilities

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 477 of file Imap.php.

    {
        $response = $this->requestAndResponse('CAPABILITY');

        if (!$response) {
            return $response;
        }

        $capabilities = array();
        foreach ($response as $line) {
            $capabilities = array_merge($capabilities, $line);
        }
        return $capabilities;
    }

connect()

connect	(		$host,
			$port = null,
			$ssl = false
	)

Open connection to IMAP server

Parameters

string	$host	hostname or IP address of IMAP server
int | null	$port	of IMAP server, default is 143 (993 for ssl)
string | bool	$ssl	use 'SSL', 'TLS' or false

Returns

string welcome message

Exceptions

Zend_Mail_Protocol_Exception

See also

Zend_Mail_Protocol_Exception

Zend_Mail_Protocol_Exception

Zend_Mail_Protocol_Exception

Definition at line 82 of file Imap.php.

    {
        if ($ssl == 'SSL') {
            $host = 'ssl://' . $host;
        }

        if ($port === null) {
            $port = $ssl === 'SSL' ? 993 : 143;
        }

        $errno  =  0;
        $errstr = '';
        $this->_socket = @fsockopen($host, $port, $errno, $errstr, self::TIMEOUT_CONNECTION);
        if (!$this->_socket) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('cannot connect to host; error = ' . $errstr .
                                                   ' (errno = ' . $errno . ' )');
        }

        if (!$this->_assumedNextLine('* OK')) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('host doesn\'t allow connection');
        }

        if ($ssl === 'TLS') {
            $result = $this->requestAndResponse('STARTTLS');
            // TODO: Add STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT in the future when it is supported by PHP
            $result = $result && stream_socket_enable_crypto($this->_socket, true, STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT);
            if (!$result) {
                #require_once 'Zend/Mail/Protocol/Exception.php';
                throw new Zend_Mail_Protocol_Exception('cannot enable TLS');
            }
        }
    }

copy()

copy	(		$folder,
			$from,
			$to = null
	)

copy message set from current folder to other folder

Parameters

string	$folder	destination folder
int | null	$to	if null only one message ($from) is fetched, else it's the last message, INF means last message avaible

Returns

bool success

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 748 of file Imap.php.

    {
        $set = (int)$from;
        if ($to != null) {
            $set .= ':' . ($to == INF ? '*' : (int)$to);
        }

        return $this->requestAndResponse('COPY', array($set, $this->escapeString($folder)), true);
    }

create()

create

(

$folder

)

create a new folder (and parent folders if needed)

Parameters

string

$folder

folder name

Returns

bool success

Definition at line 764 of file Imap.php.

    {
        return $this->requestAndResponse('CREATE', array($this->escapeString($folder)), true);
    }

delete()

delete

(

$folder

)

remove a folder

Parameters

string

$folder

folder name

Returns

bool success

Definition at line 787 of file Imap.php.

    {
        return $this->requestAndResponse('DELETE', array($this->escapeString($folder)), true);
    }

escapeList()

escapeList

(

$list

)

escape a list with literals or lists

Parameters

array

$list

list with literals or lists as PHP array

Returns

string escaped list for imap

Definition at line 423 of file Imap.php.

    {
        $result = array();
        foreach ($list as $k => $v) {
            if (!is_array($v)) {
//              $result[] = $this->escapeString($v);
                $result[] = $v;
                continue;
            }
            $result[] = $this->escapeList($v);
        }
        return '(' . implode(' ', $result) . ')';
    }

escapeString()

escapeString

(

$string

)

escape one or more literals i.e. for sendRequest

Parameters

string | array

$string

the literal/-s

Returns

string|array escape literals, literals with newline ar returned as array('{size}', 'string');

Definition at line 401 of file Imap.php.

    {
        if (func_num_args() < 2) {
            if (strpos($string, "\n") !== false) {
                return array('{' . strlen($string) . '}', $string);
            } else {
                return '"' . str_replace(array('\\', '"'), array('\\\\', '\\"'), $string) . '"';
            }
        }
        $result = array();
        foreach (func_get_args() as $string) {
            $result[] = $this->escapeString($string);
        }
        return $result;
    }

examine()

examine

(

$box = 'INBOX'

)

examine folder

Parameters

string

$box

examine this folder

Returns

bool|array see examineOrselect()

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 551 of file Imap.php.

    {
        return $this->examineOrSelect('EXAMINE', $box);
    }

examineOrSelect()

examineOrSelect	(		$command = 'EXAMINE',
			$box = 'INBOX'
	)

Examine and select have the same response. The common code for both is in this method

Parameters

string	$command	can be 'EXAMINE' or 'SELECT' and this is used as command
string	$box	which folder to change to or examine

Returns

bool|array false if error, array with returned information otherwise (flags, exists, recent, uidvalidity)

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 502 of file Imap.php.

    {
        $this->sendRequest($command, array($this->escapeString($box)), $tag);

        $result = array();
        while (!$this->readLine($tokens, $tag)) {
            if ($tokens[0] == 'FLAGS') {
                array_shift($tokens);
                $result['flags'] = $tokens;
                continue;
            }
            switch ($tokens[1]) {
                case 'EXISTS':
                case 'RECENT':
                    $result[strtolower($tokens[1])] = $tokens[0];
                    break;
                case '[UIDVALIDITY':
                    $result['uidvalidity'] = (int)$tokens[2];
                    break;
                default:
                    // ignore
            }
        }

        if ($tokens[0] != 'OK') {
            return false;
        }
        return $result;
    }

expunge()

expunge

(

)

permanently remove messages

Returns

bool success

Definition at line 797 of file Imap.php.

    {
        // TODO: parse response?
        return $this->requestAndResponse('EXPUNGE');
    }

fetch()

fetch	(		$items,
			$from,
			$to = null
	)

fetch one or more items of one or more messages

Parameters

string | array	$items	items to fetch from message(s) as string (if only one item) or array of strings
int	$from	message for items or start message if $to !== null
int | null	$to	if null only one message ($from) is fetched, else it's the last message, INF means last message avaible

Returns

string|array if only one item of one message is fetched it's returned as string if items of one message are fetched it's returned as (name => value) if one items of messages are fetched it's returned as (msgno => value) if items of messages are fetchted it's returned as (msgno => (name => value))

Exceptions

Zend_Mail_Protocol_Exception

See also

Zend_Mail_Protocol_Exception

Definition at line 570 of file Imap.php.

    {
        if (is_array($from)) {
            $set = implode(',', $from);
        } else if ($to === null) {
            $set = (int)$from;
        } else if ($to === INF) {
            $set = (int)$from . ':*';
        } else {
            $set = (int)$from . ':' . (int)$to;
        }

        $items = (array)$items;
        $itemList = $this->escapeList($items);

        $this->sendRequest('FETCH', array($set, $itemList), $tag);

        $result = array();
        while (!$this->readLine($tokens, $tag)) {
            // ignore other responses
            if ($tokens[1] != 'FETCH') {
                continue;
            }
            // ignore other messages
            if ($to === null && !is_array($from) && $tokens[0] != $from) {
                continue;
            }
            // if we only want one item we return that one directly
            if (count($items) == 1) {
                if ($tokens[2][0] == $items[0]) {
                    $data = $tokens[2][1];
                } else {
                    // maybe the server send an other field we didn't wanted
                    $count = count($tokens[2]);
                    // we start with 2, because 0 was already checked
                    for ($i = 2; $i < $count; $i += 2) {
                        if ($tokens[2][$i] != $items[0]) {
                            continue;
                        }
                        $data = $tokens[2][$i + 1];
                        break;
                    }
                }
            } else {
                $data = array();
                while (key($tokens[2]) !== null) {
                    $data[current($tokens[2])] = next($tokens[2]);
                    next($tokens[2]);
                }
            }
            // if we want only one message we can ignore everything else and just return
            if ($to === null && !is_array($from) && $tokens[0] == $from) {
                // we still need to read all lines
                while (!$this->readLine($tokens, $tag));
                return $data;
            }
            $result[$tokens[0]] = $data;
        }

        if ($to === null && !is_array($from)) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('the single id was not found in response');
        }

        return $result;
    }

listMailbox()

listMailbox	(		$reference = '',
			$mailbox = '*'
	)

get mailbox list

this method can't be named after the IMAP command 'LIST', as list is a reserved keyword

Parameters

string	$reference	mailbox reference for list
string	$mailbox	mailbox name match with wildcards

Returns

array mailboxes that matched $mailbox as array(globalName => array('delim' => .., 'flags' => ..))

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 650 of file Imap.php.

    {
        $result = array();
        $list = $this->requestAndResponse('LIST', $this->escapeString($reference, $mailbox));
        if (!$list || $list === true) {
            return $result;
        }

        foreach ($list as $item) {
            if (count($item) != 4 || $item[0] != 'LIST') {
                continue;
            }
            $result[$item[3]] = array('delim' => $item[2], 'flags' => $item[1]);
        }

        return $result;
    }

login()

login	(		$user,
			$password
	)

Login to IMAP server.

Parameters

string	$user	username
string	$password	password

Returns

bool success

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 445 of file Imap.php.

    {
        return $this->requestAndResponse('LOGIN', $this->escapeString($user, $password), true);
    }

logout()

logout

(

)

logout of imap server

Returns

bool success

Definition at line 455 of file Imap.php.

    {
        $result = false;
        if ($this->_socket) {
            try {
                $result = $this->requestAndResponse('LOGOUT', array(), true);
            } catch (Zend_Mail_Protocol_Exception $e) {
                // ignoring exception
            }
            fclose($this->_socket);
            $this->_socket = null;
        }
        return $result;
    }

noop()

noop

(

)

send noop

Returns

bool success

Definition at line 808 of file Imap.php.

    {
        // TODO: parse response
        return $this->requestAndResponse('NOOP');
    }

readLine()

readLine	(	&	$tokens = array(),
			$wantedTag = '*',
			$dontParse = false
	)

read a response "line" (could also be more than one real line if response has {..}<NL>) and do a simple decode

Parameters

array | string	$tokens	decoded tokens are returned by reference, if $dontParse is true the unparsed line is returned here
string	$wantedTag	check for this tag for response code. Default '*' is continuation tag.
bool	$dontParse	if true only the unparsed line is returned $tokens

Returns

bool if returned tag matches wanted tag

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 284 of file Imap.php.

    {
        $line = $this->_nextTaggedLine($tag);
        if (!$dontParse) {
            $tokens = $this->_decodeLine($line);
        } else {
            $tokens = $line;
        }

        // if tag is wanted tag we might be at the end of a multiline response
        return $tag == $wantedTag;
    }

readResponse()

readResponse	(		$tag,
			$dontParse = false
	)

read all lines of response until given tag is found (last line of response)

Parameters

string	$tag	the tag of your request
string | array	$filter	you can filter the response so you get only the given response lines
bool	$dontParse	if true every line is returned unparsed instead of the decoded tokens

Returns

null|bool|array tokens if success, false if error, null if bad request

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 308 of file Imap.php.

    {
        $lines = array();
        while (!$this->readLine($tokens, $tag, $dontParse)) {
            $lines[] = $tokens;
        }

        if ($dontParse) {
            // last to chars are still needed for response code
            $tokens = array(substr($tokens, 0, 2));
        }
        // last line has response code
        if ($tokens[0] == 'OK') {
            return $lines ? $lines : true;
        } else if ($tokens[0] == 'NO'){
            return false;
        }
        return null;
    }

rename()

rename	(		$old,
			$new
	)

rename an existing folder

Parameters

string	$old	old name
string	$new	new name

Returns

bool success

Definition at line 776 of file Imap.php.

    {
        return $this->requestAndResponse('RENAME', $this->escapeString($old, $new), true);
    }

requestAndResponse()

requestAndResponse	(		$command,
			$tokens = array(),
			$dontParse = false
	)

send a request and get response at once

Parameters

string	$command	command as in sendRequest()
array	$tokens	parameters as in sendRequest()
bool	$dontParse	if true unparsed lines are returned instead of tokens

Returns

mixed response as in readResponse()

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 386 of file Imap.php.

    {
        $this->sendRequest($command, $tokens, $tag);
        $response = $this->readResponse($tag, $dontParse);

        return $response;
    }

search()

search

(

array

$params

)

do a search request

This method is currently marked as internal as the API might change and is not safe if you don't take precautions.

Definition at line 823 of file Imap.php.

    {
        $response = $this->requestAndResponse('SEARCH', $params);
        if (!$response) {
            return $response;
        }

        foreach ($response as $ids) {
            if ($ids[0] == 'SEARCH') {
                array_shift($ids);
                return $ids;
            }
        }
        return array();
    }

select()

select

(

$box = 'INBOX'

)

change folder

Parameters

string

$box

change to this folder

Returns

bool|array see examineOrselect()

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 539 of file Imap.php.

    {
        return $this->examineOrSelect('SELECT', $box);
    }

sendRequest()

sendRequest	(		$command,
			$tokens = array(),
		&	$tag = null
	)

send a request

Parameters

string	$command	your request command
array	$tokens	additional parameters to command, use escapeString() to prepare
string	$tag	provide a tag otherwise an autogenerated is returned

Returns

null

Exceptions

Zend_Mail_Protocol_Exception

See also

Zend_Mail_Protocol_Exception

Zend_Mail_Protocol_Exception

Zend_Mail_Protocol_Exception

Definition at line 337 of file Imap.php.

    {
        if (!$tag) {
            ++$this->_tagCount;
            $tag = 'TAG' . $this->_tagCount;
        }

        $line = $tag . ' ' . $command;

        foreach ($tokens as $token) {
            if (is_array($token)) {
                if (@fputs($this->_socket, $line . ' ' . $token[0] . "\r\n") === false) {
                    #require_once 'Zend/Mail/Protocol/Exception.php';
                    throw new Zend_Mail_Protocol_Exception('cannot write - connection closed?');
                }
                if (!$this->_assumedNextLine('+ ')) {
                    #require_once 'Zend/Mail/Protocol/Exception.php';
                    throw new Zend_Mail_Protocol_Exception('cannot send literal string');
                }
                $line = $token[1];
            } else {
                $line .= ' ' . $token;
            }
        }

        if (@fputs($this->_socket, $line . "\r\n") === false) {
            #require_once 'Zend/Mail/Protocol/Exception.php';
            throw new Zend_Mail_Protocol_Exception('cannot write - connection closed?');
        }
    }

store()

store	(	array	$flags,
			$from,
			$to = null,
			$mode = null,
			$silent = true
	)

set flags

Parameters

array	$flags	flags to set, add or remove - see $mode
int	$from	message for items or start message if $to !== null
int | null	$to	if null only one message ($from) is fetched, else it's the last message, INF means last message avaible
string | null	$mode	'+' to add flags, '-' to remove flags, everything else sets the flags as given
bool	$silent	if false the return values are the new flags for the wanted messages

Returns

bool|array new flags if $silent is false, else true or false depending on success

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 680 of file Imap.php.

    {
        $item = 'FLAGS';
        if ($mode == '+' || $mode == '-') {
            $item = $mode . $item;
        }
        if ($silent) {
            $item .= '.SILENT';
        }

        $flags = $this->escapeList($flags);
        $set = (int)$from;
        if ($to != null) {
            $set .= ':' . ($to == INF ? '*' : (int)$to);
        }

        $result = $this->requestAndResponse('STORE', array($set, $item, $flags), $silent);

        if ($silent) {
            return $result ? true : false;
        }

        $tokens = $result;
        $result = array();
        foreach ($tokens as $token) {
            if ($token[1] != 'FETCH' || $token[2][0] != 'FLAGS') {
                continue;
            }
            $result[$token[0]] = $token[2][1];
        }

        return $result;
    }

Field Documentation

$_socket

$_socket

protected

Definition at line 42 of file Imap.php.

$_tagCount

$_tagCount = 0

protected

Definition at line 48 of file Imap.php.

TIMEOUT_CONNECTION

const TIMEOUT_CONNECTION = 30

Default timeout in seconds for initiating session

Definition at line 36 of file Imap.php.

---

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

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