Mail/Storage/Pop3.php

Show:

inherited

Classes
- \Zend_Mail_Storage_Pop3

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Mail
Subpackage: Storage
Version: $Id$

\Zend_Mail_Storage_Pop3
jump to top

Package: Zend_Mail\Storage

Parent(s): \Zend_Mail_Storage_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

null|\Zend_Mail_Protocol_Pop3 $_protocol

protocol handler

Details

Type: null | \Zend_Mail_Protocol_Pop3

Methods

__construct(array $params) : void

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

Name	Type	Description
$params	array	mail reader specific parameters

Throws

Exception	Description
\Zend_Mail_Storage_Exception
\Zend_Mail_Protocol_Exception

__get(string $var) : string

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

Parameters

Name	Type	Description
$var	string

Returns

Type	Description
string

Throws

Exception	Description
\Zend_Mail_Storage_Exception

Details

See

close() : null

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

Returns

Type	Description
null

countMessages() : int

Count messages all messages in current box

Returns

Type	Description
int	number of messages

Throws

Exception	Description
\Zend_Mail_Storage_Exception
\Zend_Mail_Protocol_Exception

getMessage(int $id) : \Zend_Mail_Message

Fetch a message

Parameters

Name	Type	Description
$id	int	number of message

Returns

Type	Description
\Zend_Mail_Message

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

getNumberByUniqueId(string $id) : int

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

Name	Type	Description
$id	string	unique id

Returns

Type	Description
int	message number

Throws

Exception	Description
\Zend_Mail_Storage_Exception

getRawContent( $id, $part = null) : void

Parameters

Name	Type	Description
$id
$part

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

Parameters

Name	Type	Description
$id
$part
$topLines

getSize(int $id = 0) : int | array

get a list of messages with number and size

Parameters

Name	Type	Description
$id	int	number of message

Returns

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

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

getUniqueId(int | null $id = null) : array | string

get unique id for one or all messages

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

Parameters

Name	Type	Description
$id	int \| null	message number

Returns

Type	Description
array \| string	message number for given message or all messages as array

Throws

Exception	Description
\Zend_Mail_Storage_Exception

noop() : null

Keep the server busy.

Returns

Type	Description
null

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

removeMessage(int $id) : null

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

Name	Type	Description
$id	int	number of message

Returns

Type	Description
null

Throws

Exception	Description
\Zend_Mail_Protocol_Exception

Mail/Storage/Pop3.php

\Zend_Mail_Storage_Pop3jump to top

Properties

Methods

\Zend_Mail_Storage_Pop3
jump to top