| category |
Zend |
| package |
Zend_Mail |
| subpackage |
Storage |
| copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license |
New BSD License |
| inherited_from |
\Zend_Mail_Storage_Abstract |
Methods
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
__construct(array $params)
| inherited_from |
\Zend_Mail_Storage_Abstract::__construct() |
Parameters
$params
arraymail reader specific parameters
Exceptions
\Zend_Mail_Storage_Exception |
|
\Zend_Mail_Protocol_Exception |
|
Create instance with parameters
__construct(array $params)
Inherited
Parameters
$params
arraymail reader specific parameters
Exceptions
\Zend_Mail_Storage_Exception |
|
Destructor calls close() and therefore closes the resource.
__destruct()
Inherited
Special handling for hasTop and hasUniqueid. The headers of the first message is
retrieved if Top wasn't needed/tried yet.
__get(string $var) : string
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
| see |
|
| inherited_from |
\Zend_Mail_Storage_Abstract::__get() |
Parameters
$var
string
Exceptions
\Zend_Mail_Storage_Exception |
|
Returns
string
Getter for has-properties. The standard has properties
are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop
__get(string $var) : boolean
Inherited
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
Exceptions
\Zend_Mail_Storage_Exception |
|
Returns
booleansupported or not
Close resource for mail lib. If you need to control, when the resource
is closed. Otherwise the destructor would call this.
close() : null
| inherited_from |
\Zend_Mail_Storage_Abstract::close() |
Returns
null
Close resource for mail lib. If you need to control, when the resource
is closed. Otherwise the destructor would call this.
close() : null
Inherited
Countable::count()
count() : integer
Inherited
Count messages all messages in current box
countMessages() : integer
| inherited_from |
\Zend_Mail_Storage_Abstract::countMessages() |
Exceptions
\Zend_Mail_Storage_Exception |
|
\Zend_Mail_Protocol_Exception |
|
Returns
integernumber of messages
Count messages messages in current box/folder
countMessages() : integer
Inherited
Exceptions
\Zend_Mail_Storage_Exception |
|
Returns
integernumber of messages
Iterator::current()
current() : \Zend_Mail_Message
Inherited
Returns
\Zend_Mail_Messagecurrent message
Get a full list of features supported by the specific mail lib and the server
getCapabilities() : array
Inherited
Returns
arraylist of features as array(featurename => true|false[|null])
Fetch a message
getMessage(integer $id) : \Zend_Mail_Message
| inherited_from |
\Zend_Mail_Storage_Abstract::getMessage() |
Parameters
$id
integernumber of message
Exceptions
\Zend_Mail_Protocol_Exception |
|
Returns
\Zend_Mail_Message
Get a message with headers and body
getMessage(integer $id) : \Zend_Mail_Message
Inherited
Parameters
$id
integernumber of message
Returns
\Zend_Mail_Message
get a message number from a unique id
getNumberByUniqueId(string $id) : integer
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()
| inherited_from |
\Zend_Mail_Storage_Abstract::getNumberByUniqueId() |
Parameters
Exceptions
\Zend_Mail_Storage_Exception |
|
Returns
integermessage number
get a message number from a unique id
getNumberByUniqueId(string $id) : integer
Inherited
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
Exceptions
\Zend_Mail_Storage_Exception |
|
Returns
integermessage number
Get raw content of message or part
getRawContent(integer $id, null|array|string $part = null)
| inherited_from |
\Zend_Mail_Storage_Abstract::getRawContent() |
Parameters
$id
$part
Get raw content of message or part
getRawContent(integer $id, null|array|string $part = null) : string
Inherited
Parameters
$id
integernumber of message
$part
nullarraystringpath to part or null for messsage content
Returns
stringraw content
get a list of messages with number and size
getSize(integer $id = 0) : integer | array
| inherited_from |
\Zend_Mail_Storage_Abstract::getSize() |
Parameters
$id
integernumber of message
Exceptions
\Zend_Mail_Protocol_Exception |
|
Returns
integerarraysize of given message of list with all messages as array(num => size)
Get a list of messages with number and size
getSize(integer $id = 0) : integer | array
Inherited
Parameters
$id
integernumber of message
Returns
integerarraysize of given message of list with all messages as array(num => size)
get unique id for one or all messages
getUniqueId(integer|null $id = null) : array | string
if storage does not support unique ids it's the same as the message number
| inherited_from |
\Zend_Mail_Storage_Abstract::getUniqueId() |
Parameters
$id
integernullmessage number
Exceptions
\Zend_Mail_Storage_Exception |
|
Returns
arraystringmessage number for given message or all messages as array
get unique id for one or all messages
getUniqueId(integer|null $id = null) : array | string
Inherited
if storage does not support unique ids it's the same as the message number
Parameters
$id
integernullmessage number
Exceptions
\Zend_Mail_Storage_Exception |
|
Returns
arraystringmessage number for given message or all messages as array
Iterator::key()
key() : integer
Inherited
Returns
integerid of current position
Iterator::next()
next() : void
Inherited
Keep the server busy.
noop() : null
| inherited_from |
\Zend_Mail_Storage_Abstract::noop() |
Exceptions
\Zend_Mail_Protocol_Exception |
|
Returns
null
Keep the resource alive.
noop() : null
Inherited
ArrayAccess::offsetExists()
offsetExists(integer $id) : boolean
Inherited
Parameters
$id
integer
Returns
boolean
ArrayAccess::offsetGet()
offsetGet(integer $id) : \Zend_Mail_Message
Inherited
Parameters
$id
integer
Returns
\Zend_Mail_Messagemessage object
ArrayAccess::offsetSet()
offsetSet(\id $id, mixed $value) : void
Inherited
Parameters
$id
\id
$value
mixed
Exceptions
\Zend_Mail_Storage_Exception |
|
ArrayAccess::offsetUnset()
offsetUnset(integer $id) : boolean
Inherited
Parameters
$id
integer
Returns
booleansuccess
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.
removeMessage(integer $id) : null
| inherited_from |
\Zend_Mail_Storage_Abstract::removeMessage() |
Parameters
$id
integernumber of message
Exceptions
\Zend_Mail_Protocol_Exception |
|
Returns
null
delete a message from current box/folder
removeMessage($id) : null
Inherited
Parameters
$id
Returns
null
Iterator::rewind()
rewind() : void
Inherited
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.
SeekableIterator::seek()
seek(integer $pos) : void
Inherited
Parameters
$pos
integer
Exceptions
Iterator::valid()
valid() : boolean
Inherited
Properties
class capabilities with default values
$_has : array
Default
array('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)
maximum iteration position (= message count)
$_iterationMax : null | integer
current iteration position
$_iterationPos : integer
used message class, change it in an extened class to extend the returned message class
$_messageClass : string
Default
'Zend_Mail_Message'
protocol handler
$_protocol : null | \Zend_Mail_Protocol_Pop3