Zend_Mail_Storage_Pop3 Class Reference

Inheritance diagram for Zend_Mail_Storage_Pop3:

Public Member Functions
	countMessages ()
	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)
	__get ($var)
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
Protected Attributes inherited from Zend_Mail_Storage_Abstract
	$_has
	$_iterationPos = 0
	$_iterationMax = null
	$_messageClass = 'Zend_Mail_Message'

Detailed Description

Definition at line 47 of file Pop3.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$params

)

create instance with parameters Supported paramters are

• host hostname or ip address of POP3 server
• user username
• password password for user 'username' [optional, default = '']
• port port for POP3 server [optional, default = 110]
• ssl 'SSL' or 'TLS' for secure sockets

Parameters

array

$params

mail reader specific parameters

Exceptions

Zend_Mail_Storage_Exception
Zend_Mail_Protocol_Exception

See also

Zend_Mail_Storage_Exception

Definition at line 161 of file Pop3.php.

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

        $this->_has['fetchPart'] = false;
        $this->_has['top']       = null;
        $this->_has['uniqueid']  = null;

        if ($params instanceof Zend_Mail_Protocol_Pop3) {
            $this->_protocol = $params;
            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_Pop3();
        $this->_protocol->connect($host, $port, $ssl);
        $this->_protocol->login($params->user, $password);
    }

Member Function Documentation

__get()

__get

(

$var

)

Special handling for hasTop and hasUniqueid. The headers of the first message is retrieved if Top wasn't needed/tried yet.

See also

Zend_Mail_Storage_Abstract:__get()

Parameters

string

$var

Returns

string

Exceptions

Zend_Mail_Storage_Exception

Definition at line 295 of file Pop3.php.

    {
        $result = parent::__get($var);
        if ($result !== null) {
            return $result;
        }

        if (strtolower($var) == 'hastop') {
            if ($this->_protocol->hasTop === null) {
                // need to make a real call, because not all server are honest in their capas
                try {
                    $this->_protocol->top(1, 0, false);
                } catch(Zend_Mail_Exception $e) {
                    // ignoring error
                }
            }
            $this->_has['top'] = $this->_protocol->hasTop;
            return $this->_protocol->hasTop;
        }

        if (strtolower($var) == 'hasuniqueid') {
            $id = null;
            try {
                $id = $this->_protocol->uniqueid(1);
            } catch(Zend_Mail_Exception $e) {
                // ignoring error
            }
            $this->_has['uniqueid'] = $id ? true : false;
            return $this->_has['uniqueid'];
        }

        return $result;
    }

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 200 of file Pop3.php.

    {
        $this->_protocol->logout();
    }

countMessages()

countMessages

(

)

Count messages all messages in current box

Returns

int number of messages

Exceptions

Zend_Mail_Storage_Exception
Zend_Mail_Protocol_Exception

Definition at line 63 of file Pop3.php.

    {
        $this->_protocol->status($count, $null);
        return (int)$count;
    }

getMessage()

getMessage

(

$id

)

Fetch a message

Parameters

int

$id

number of message

Returns

Zend_Mail_Message

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 89 of file Pop3.php.

    {
        $bodyLines = 0;
        $message = $this->_protocol->top($id, $bodyLines, true);

        return new $this->_messageClass(array('handler' => $this, 'id' => $id, 'headers' => $message,
                                              'noToplines' => $bodyLines < 1));
    }

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 266 of file Pop3.php.

    {
        if (!$this->hasUniqueid) {
            return $id;
        }

        $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 131 of file Pop3.php.

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

        $content = $this->_protocol->retrieve($id);
        // TODO: find a way to avoid decoding the headers
        Zend_Mime_Decode::splitMessage($content, $null, $body);
        return $body;
    }

getRawHeader()

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

See also

Zend_Mail_Storage_Exception

Definition at line 108 of file Pop3.php.

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

        return $this->_protocol->top($id, 0, true);
    }

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 76 of file Pop3.php.

    {
        $id = $id ? $id : null;
        return $this->_protocol->getList($id);
    }

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 239 of file Pop3.php.

    {
        if (!$this->hasUniqueid) {
            if ($id) {
                return $id;
            }
            $count = $this->countMessages();
            if ($count < 1) {
                return array();
            }
            $range = range(1, $count);
            return array_combine($range, $range);
        }

        return $this->_protocol->uniqueid($id);
    }

noop()

noop

(

)

Keep the server busy.

Returns

null

Exceptions

Zend_Mail_Protocol_Exception

Definition at line 211 of file Pop3.php.

    {
        return $this->_protocol->noop();
    }

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_Protocol_Exception

Definition at line 225 of file Pop3.php.

    {
        $this->_protocol->delete($id);
    }

Field Documentation

$_protocol

$_protocol

protected

Definition at line 53 of file Pop3.php.

---

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

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