API Documentation

Mail/Storage/Maildir.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: Maildir.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Mail_Storage_Maildir

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

Propertyprotectedarray  $_files= 'array'

data of found message files in maildir dir

Default valuearrayDetails
Type
array
Propertyprotectedarray  $_knownFlags= 'array'
static

known flag chars in filenames

This list has to be in alphabetical order for setFlags()

Default valuearrayDetails
Type
array
Propertyprotectedstring  $_messageClass= 'Zend_Mail_Message_File'

used message class, change it in an extened class to extend the returned message class

Default valueZend_Mail_Message_FileDetails
Type
string

Methods

methodpublic__construct( array $params ) : void

Create instance with parameters Supported parameters are: - dirname dirname of mbox file

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.

Inherited from: \Zend_Mail_Storage_Abstract::__destruct()
methodpublic__get( string $var ) : bool

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

Inherited from: \Zend_Mail_Storage_Abstract::__get()

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
methodprotected_getFileData( int $id, string|null $field = null ) : string|array

Get one or all fields from file structure. Also checks if message is valid

Parameters
Name Type Description
$id int message number
$field string|null wanted field
Returns
Type Description
stringarray wanted field or all fields as array
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodprotected_getMaildirFiles( resource $dh, string $dirname, array $default_flags = array ) : null

find all files in opened dir handle and add to maildir files

Parameters
Name Type Description
$dh resource dir handle used for search
$dirname string

dirname of dir in $dh

$default_flags array default flags for given dir
Returns
Type Description
null
methodprotected_isMaildir( string $dirname ) : bool

check if a given dir is a valid maildir

Parameters
Name Type Description
$dirname string name of dir
Returns
Type Description
bool dir is valid maildir
methodprotected_openMaildir( string $dirname ) : null

open given dir as current maildir

Parameters
Name Type Description
$dirname string name of maildir
Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicclose( ) : void

Close resource for mail lib. If you need to control, when the resource is closed. Otherwise the destructor would call this.

methodpubliccount( ) : int

Countable::count()

Inherited from: \Zend_Mail_Storage_Abstract::count()
Returns
Type Description
int
methodpubliccountMessages(  $flags = null ) : int

Count messages all messages in current box

Parameters
Name Type Description
$flags
Returns
Type Description
int number of messages
Throws
Exception Description
\Zend_Mail_Storage_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_File

Fetch a message

Parameters
Name Type Description
$id int number of message
Returns
Type Description
\Zend_Mail_Message_File
Throws
Exception Description
\Zend_Mail_Storage_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|null $id = null ) : int|array

Get a list of messages with number and size

Parameters
Name Type Description
$id int|null number of message or null for all messages
Returns
Type Description
intarray size of given message of list with all messages as array(num => size)
Throws
Exception Description
\Zend_Mail_Storage_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( ) : void

Waste some CPU cycles doing nothing.

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(  $id ) : null

stub for not supported message deletion

Parameters
Name Type Description
$id
Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_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.