Mail/Storage/Pop3.php

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

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Mail  
Subpackage
Storage  
Version
$Id: Pop3.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Mail_Storage_Pop3
jump to top

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

Properties

>VPropertyprotectedarray $_has = array('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)
inherited
class capabilities with default values
Inherited from: \Zend_Mail_Storage_Abstract::$$_has
Default valuearray('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)Details
Type
array
Inherited_from
\Zend_Mail_Storage_Abstract::$$_has  
>VPropertyprotectednull|int $_iterationMax = null
inherited
maximum iteration position (= message count)
Inherited from: \Zend_Mail_Storage_Abstract::$$_iterationMax
Default valuenullDetails
Type
null | int
Inherited_from
\Zend_Mail_Storage_Abstract::$$_iterationMax  
>VPropertyprotectedint $_iterationPos = 0
inherited
current iteration position
Inherited from: \Zend_Mail_Storage_Abstract::$$_iterationPos
Default value0Details
Type
int
Inherited_from
\Zend_Mail_Storage_Abstract::$$_iterationPos  
>VPropertyprotectedstring $_messageClass = 'Zend_Mail_Message'
inherited
used message class, change it in an extened class to extend the returned message class
Inherited from: \Zend_Mail_Storage_Abstract::$$_messageClass
Default value'Zend_Mail_Message'Details
Type
string
Inherited_from
\Zend_Mail_Storage_Abstract::$$_messageClass  
>VPropertyprotectednull|\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
NameTypeDescription
$paramsarray

mail reader specific parameters

Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
\Zend_Mail_Protocol_Exception
methodpublic__destruct() : void
inherited

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.

Parameters
NameTypeDescription
$varstring
Returns
TypeDescription
string
Throws
ExceptionDescription
\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
TypeDescription
null
methodpubliccount() : int
inherited

Countable::count()

Inherited from: \Zend_Mail_Storage_Abstract::count()
Returns
TypeDescription
int
methodpubliccountMessages() : int

Count messages all messages in current box

Returns
TypeDescription
intnumber of messages
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
\Zend_Mail_Protocol_Exception
methodpubliccurrent() : \Zend_Mail_Message
inherited

Iterator::current()

Inherited from: \Zend_Mail_Storage_Abstract::current()
Returns
TypeDescription
\Zend_Mail_Messagecurrent message
methodpublicgetCapabilities() : array
inherited

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

Inherited from: \Zend_Mail_Storage_Abstract::getCapabilities()
Returns
TypeDescription
arraylist of features as array(featurename => true|false[|null])
methodpublicgetMessage(int $id) : \Zend_Mail_Message

Fetch a message

Parameters
NameTypeDescription
$idint

number of message

Returns
TypeDescription
\Zend_Mail_Message
Throws
ExceptionDescription
\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
NameTypeDescription
$idstring

unique id

Returns
TypeDescription
intmessage number
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicgetRawContent(int $id, null | array | string $part = null) : string

Get raw content of message or part

Parameters
NameTypeDescription
$idint

number of message

$partnull | array | string

path to part or null for messsage content

Returns
TypeDescription
stringraw content
methodpublicgetRawHeader(int $id, null | array | string $part = null, int $topLines = 0) : string

Get raw header of message or part

Parameters
NameTypeDescription
$idint

number of message

$partnull | array | string

path to part or null for messsage header

$topLinesint

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

Returns
TypeDescription
stringraw header
methodpublicgetSize(int $id = 0) : int | array

get a list of messages with number and size

Parameters
NameTypeDescription
$idint

number of message

Returns
TypeDescription
int | arraysize of given message of list with all messages as array(num => size)
Throws
ExceptionDescription
\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
NameTypeDescription
$idint | null

message number

Returns
TypeDescription
array | stringmessage number for given message or all messages as array
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublickey() : int
inherited

Iterator::key()

Inherited from: \Zend_Mail_Storage_Abstract::key()
Returns
TypeDescription
intid of current position
methodpublicnext() : void
inherited

Iterator::next()

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

Keep the server busy.

Returns
TypeDescription
null
Throws
ExceptionDescription
\Zend_Mail_Protocol_Exception
methodpublicoffsetExists(int $id) : boolean
inherited

ArrayAccess::offsetExists()

Inherited from: \Zend_Mail_Storage_Abstract::offsetExists()
Parameters
NameTypeDescription
$idint
Returns
TypeDescription
boolean
methodpublicoffsetGet(int $id) : \Zend_Mail_Message
inherited

ArrayAccess::offsetGet()

Inherited from: \Zend_Mail_Storage_Abstract::offsetGet()
Parameters
NameTypeDescription
$idint
Returns
TypeDescription
\Zend_Mail_Messagemessage object
methodpublicoffsetSet(\id $id, mixed $value) : void
inherited

ArrayAccess::offsetSet()

Inherited from: \Zend_Mail_Storage_Abstract::offsetSet()
Parameters
NameTypeDescription
$id\id
$valuemixed
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicoffsetUnset(int $id) : boolean
inherited

ArrayAccess::offsetUnset()

Inherited from: \Zend_Mail_Storage_Abstract::offsetUnset()
Parameters
NameTypeDescription
$idint
Returns
TypeDescription
booleansuccess
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
NameTypeDescription
$idint

number of message

Returns
TypeDescription
null
Throws
ExceptionDescription
\Zend_Mail_Protocol_Exception
methodpublicrewind() : void
inherited

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
inherited

SeekableIterator::seek()

Inherited from: \Zend_Mail_Storage_Abstract::seek()
Parameters
NameTypeDescription
$posint
Throws
ExceptionDescription
\OutOfBoundsException
methodpublicvalid() : boolean
inherited

Iterator::valid()

Inherited from: \Zend_Mail_Storage_Abstract::valid()
Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.