Mail/Storage/Abstract.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 [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_Abstract

Package: Zend_Mail\Storage
Implements
Children
\Zend_Mail_Storage_Pop3
\Zend_Mail_Storage_Mbox
\Zend_Mail_Storage_Imap
\Zend_Mail_Storage_Maildir
Category
Zend  
Copyright
Copyright (c) 2005-2014 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)
class capabilities with default values
Default valuearray('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)Details
Type
array
>VPropertyprotectednull|int $_iterationMax = null
maximum iteration position (= message count)
Default valuenullDetails
Type
null | int
>VPropertyprotectedint $_iterationPos = 0
current iteration position
Default value0Details
Type
int
>VPropertyprotectedstring $_messageClass = 'Zend_Mail_Message'
used message class, change it in an extened class to extend the returned message class
Default value'Zend_Mail_Message'Details
Type
string

Methods

methodpublic__construct(array $params) : void
abstract

Create instance with parameters

Parameters
NameTypeDescription
$paramsarray

mail reader specific parameters

Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublic__destruct() : void

Destructor calls close() and therefore closes the resource.

methodpublic__get(string $var) : bool

Getter for has-properties. The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop

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
NameTypeDescription
$varstring

property name

Returns
TypeDescription
boolsupported or not
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicclose() : null
abstract

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

Countable::count()

Returns
TypeDescription
int
methodpubliccountMessages() : int
abstract

Count messages messages in current box/folder

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

Iterator::current()

Returns
TypeDescription
\Zend_Mail_Messagecurrent message
methodpublicgetCapabilities() : array

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

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

Get a message with headers and body

Parameters
NameTypeDescription
$idint

number of message

Returns
TypeDescription
\Zend_Mail_Message
methodpublicgetNumberByUniqueId(string $id) : int
abstract

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
abstract

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
abstract

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
abstract

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)
methodpublicgetUniqueId(int | null $id = null) : array | string
abstract

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

Iterator::key()

Returns
TypeDescription
intid of current position
methodpublicnext() : void

Iterator::next()

methodpublicnoop() : null
abstract

Keep the resource alive.

Returns
TypeDescription
null
methodpublicoffsetExists(int $id) : boolean

ArrayAccess::offsetExists()

Parameters
NameTypeDescription
$idint
Returns
TypeDescription
boolean
methodpublicoffsetGet(int $id) : \Zend_Mail_Message

ArrayAccess::offsetGet()

Parameters
NameTypeDescription
$idint
Returns
TypeDescription
\Zend_Mail_Messagemessage object
methodpublicoffsetSet(\id $id, mixed $value) : void

ArrayAccess::offsetSet()

Parameters
NameTypeDescription
$id\id
$valuemixed
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicoffsetUnset(int $id) : boolean

ArrayAccess::offsetUnset()

Parameters
NameTypeDescription
$idint
Returns
TypeDescription
booleansuccess
methodpublicremoveMessage( $id) : null
abstract

delete a message from current box/folder

Parameters
NameTypeDescription
$id
Returns
TypeDescription
null
methodpublicrewind() : void

Iterator::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()

Parameters
NameTypeDescription
$posint
Throws
ExceptionDescription
\OutOfBoundsException
methodpublicvalid() : boolean

Iterator::valid()

Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.2.0 .