API Documentation

Zend/Mail/Storage/Abstract.php

Show: inherited
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: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

\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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_has= 'array('uniqueid' => true'

class capabilities with default values

Default valuearray('uniqueid' => trueDetails
Type
array
Propertyprotectednull|int  $_iterationMax= 'null'

maximum iteration position (= message count)

Default valuenullDetails
Type
nullint
Propertyprotectedint  $_iterationPos= '0'

current iteration position

Default value0Details
Type
int
Propertyprotectedstring  $_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
Name Type Description
$params array

mail reader specific parameters

Throws
Exception Description
\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
Name Type Description
$var string

property name

Returns
Type Description
bool supported or not
Throws
Exception Description
\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
Type Description
null
methodpubliccount( ) : int

Countable::count()

Returns
Type Description
int
methodpubliccountMessages( ) : int
abstract

Count messages messages in current box/folder

Returns
Type Description
int number of messages
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpubliccurrent( ) : \Zend_Mail_Message

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

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

Get a message with headers and body

Parameters
Name Type Description
$id int

number of message

Returns
Type Description
\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
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
abstract

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
abstract

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
abstract

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)
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
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
methodpublickey( ) : int

Iterator::key()

Returns
Type Description
int id of current position
methodpublicnext( ) : void

Iterator::next()

methodpublicnoop( ) : null
abstract

Keep the resource alive.

Returns
Type Description
null
methodpublicoffsetExists( int $id ) : boolean

ArrayAccess::offsetExists()

Parameters
Name Type Description
$id int
Returns
Type Description
boolean
methodpublicoffsetGet( int $id ) : \Zend_Mail_Message

ArrayAccess::offsetGet()

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

ArrayAccess::offsetSet()

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

ArrayAccess::offsetUnset()

Parameters
Name Type Description
$id int
Returns
Type Description
boolean success
methodpublicremoveMessage(  $id ) : null
abstract

delete a message from current box/folder

Parameters
Name Type Description
$id
Returns
Type Description
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
Name Type Description
$pos int
Throws
Exception Description
\OutOfBoundsException
methodpublicvalid( ) : boolean

Iterator::valid()

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.15.1.