API Documentation

Mail/Storage/Pop3.php

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 license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Mail  
subpackage
Storage  
version
$Id: Pop3.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Mail_Storage_Pop3

Extends from
\Zend_Mail_Storage_Abstract
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Mail  
subpackage
Storage  

Properties

Propertyprotectednull|\Zend_Mail_Protocol_Pop3  $_protocol= ''

protocol handler

Details
Type
null\Zend_Mail_Protocol_Pop3

Methods

methodpublic__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
methodpublic__destruct( ) : void

Destructor calls close() and therefore closes the resource.

Inherited from: \Zend_Mail_Storage_Abstract::__destruct()
methodpublic__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.

The valid values for the has-properties are: - true if a feature is supported - false if a feature is not supported - null is it's not yet known or it can't be know if a feature is supported

Parameters
Name Type Description
$var string
Returns
Type Description
string
Throws
Exception Description
\Zend_Mail_Storage_Exception
Details
see
\Zend_Mail_Storage_Abstract:__get()  
methodpublicclose( ) : 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
methodpubliccount( ) : int

Countable::count()

Inherited from: \Zend_Mail_Storage_Abstract::count()
Returns
Type Description
int
methodpubliccountMessages( ) : 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
methodpubliccurrent( ) : \Zend_Mail_Message

Iterator::current()

Inherited from: \Zend_Mail_Storage_Abstract::current()
Returns
Type Description
\Zend_Mail_Message current message
methodpublicgetCapabilities( ) : array

Get a full list of features supported by the specific mail lib and the server

Inherited from: \Zend_Mail_Storage_Abstract::getCapabilities()
Returns
Type Description
array list of features as array(featurename => true|false[|null])
methodpublicgetMessage( 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
methodpublicgetNumberByUniqueId( 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
methodpublicgetRawContent( int $id, null|array|string $part = null ) : string

Get raw content of message or part

Parameters
Name Type Description
$id int number of message
$part null|array|string path to part or null for messsage content
Returns
Type Description
string raw content
methodpublicgetRawHeader( int $id, null|array|string $part = null, int $topLines = 0 ) : string

Get raw header of message or part

Parameters
Name Type Description
$id int number of message
$part null|array|string path to part or null for messsage header
$topLines int

include this many lines with header (after an empty line)

Returns
Type Description
string raw header
methodpublicgetSize( 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
intarray size of given message of list with all messages as array(num => size)
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicgetUniqueId( 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
arraystring message number for given message or all messages as array
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublickey( ) : int

Iterator::key()

Inherited from: \Zend_Mail_Storage_Abstract::key()
Returns
Type Description
int id of current position
methodpublicnext( ) : void

Iterator::next()

Inherited from: \Zend_Mail_Storage_Abstract::next()
methodpublicnoop( ) : null

Keep the server busy.

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Protocol_Exception
methodpublicoffsetExists( int $id ) : boolean

ArrayAccess::offsetExists()

Inherited from: \Zend_Mail_Storage_Abstract::offsetExists()
Parameters
Name Type Description
$id int
Returns
Type Description
boolean
methodpublicoffsetGet( int $id ) : \Zend_Mail_Message

ArrayAccess::offsetGet()

Inherited from: \Zend_Mail_Storage_Abstract::offsetGet()
Parameters
Name Type Description
$id int
Returns
Type Description
\Zend_Mail_Message message object
methodpublicoffsetSet( \id $id, mixed $value ) : void

ArrayAccess::offsetSet()

Inherited from: \Zend_Mail_Storage_Abstract::offsetSet()
Parameters
Name Type Description
$id \id
$value mixed
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicoffsetUnset( int $id ) : boolean

ArrayAccess::offsetUnset()

Inherited from: \Zend_Mail_Storage_Abstract::offsetUnset()
Parameters
Name Type Description
$id int
Returns
Type Description
boolean success
methodpublicremoveMessage( 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
methodpublicrewind( ) : void

Iterator::rewind()

Inherited from: \Zend_Mail_Storage_Abstract::rewind()

Rewind always gets the new count from the storage. Thus if you use the interfaces and your scripts take long you should use reset() from time to time.

methodpublicseek( int $pos ) : void

SeekableIterator::seek()

Inherited from: \Zend_Mail_Storage_Abstract::seek()
Parameters
Name Type Description
$pos int
Throws
Exception Description
\OutOfBoundsException
methodpublicvalid( ) : boolean

Iterator::valid()

Inherited from: \Zend_Mail_Storage_Abstract::valid()
Returns
Type Description
boolean
Documentation was generated by DocBlox 0.13.3.