Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes

Zend_Mail_Storage_Maildir Class Reference

Inheritance diagram for Zend_Mail_Storage_Maildir:
Zend_Mail_Storage_Abstract Zend_Mail_Storage_Folder_Maildir Zend_Mail_Storage_Writable_Maildir

Public Member Functions

 countMessages ($flags=null)
 getSize ($id=null)
 getMessage ($id)
 getRawHeader ($id, $part=null, $topLines=0)
 getRawContent ($id, $part=null)
 __construct ($params)
 close ()
 noop ()
 removeMessage ($id)
 getUniqueId ($id=null)
 getNumberByUniqueId ($id)

Protected Member Functions

 _getFileData ($id, $field=null)
 _isMaildir ($dirname)
 _openMaildir ($dirname)
 _getMaildirFiles ($dh, $dirname, $default_flags=array())

Protected Attributes

 $_messageClass = 'Zend_Mail_Message_File'
 $_files = array()

Static Protected Attributes

static $_knownFlags

Detailed Description

Definition at line 47 of file Maildir.php.


Constructor & Destructor Documentation

__construct ( params )

Create instance with parameters Supported parameters are:

  • dirname dirname of mbox file
Parameters:
$paramsarray mail reader specific parameters
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception
Zend_Mail_Storage_Exception

Reimplemented from Zend_Mail_Storage_Abstract.

Reimplemented in Zend_Mail_Storage_Folder_Maildir, and Zend_Mail_Storage_Writable_Maildir.

Definition at line 263 of file Maildir.php.


Member Function Documentation

_getFileData ( id,
field = null 
) [protected]

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

Parameters:
int$idmessage number
string | null$fieldwanted field
Returns:
string|array wanted field or all fields as array
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception
Zend_Mail_Storage_Exception

Definition at line 119 of file Maildir.php.

_getMaildirFiles ( dh,
dirname,
default_flags = array() 
) [protected]

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

Parameters:
resource$dhdir handle used for search
string$dirnamedirname of dir in $dh
array$default_flagsdefault flags for given dir
Returns:
null

Definition at line 352 of file Maildir.php.

_isMaildir ( dirname ) [protected]

check if a given dir is a valid maildir

Parameters:
string$dirnamename of dir
Returns:
bool dir is valid maildir

Definition at line 296 of file Maildir.php.

_openMaildir ( dirname ) [protected]

open given dir as current maildir

Parameters:
string$dirnamename of maildir
Returns:
null
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception
Zend_Mail_Storage_Exception

Definition at line 314 of file Maildir.php.

close (  )

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

Returns:
void

Reimplemented from Zend_Mail_Storage_Abstract.

Definition at line 397 of file Maildir.php.

countMessages ( flags = null )

Count messages all messages in current box

Returns:
int number of messages
Exceptions:
Zend_Mail_Storage_Exception

Definition at line 83 of file Maildir.php.

getMessage ( id )

Fetch a message

Parameters:
int$idnumber of message
Returns:
Zend_Mail_Message_File
Exceptions:
Zend_Mail_Storage_Exception

Reimplemented from Zend_Mail_Storage_Abstract.

Definition at line 175 of file Maildir.php.

getNumberByUniqueId ( id )

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:
string$idunique id
Returns:
int message number
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception

Reimplemented from Zend_Mail_Storage_Abstract.

Definition at line 461 of file Maildir.php.

getRawContent ( id,
part = null 
)

Get raw content of message or part

Parameters:
int$idnumber of message
null | array | string$partpath to part or null for messsage content
Returns:
string raw content

See also:
Zend_Mail_Storage_Exception

Reimplemented from Zend_Mail_Storage_Abstract.

Definition at line 230 of file Maildir.php.

getRawHeader ( id,
part = null,
topLines = 0 
)

Get raw header of message or part

Parameters:
int$idnumber of message
null | array | string$partpath to part or null for messsage header
int$topLinesinclude this many lines with header (after an empty line)
Returns:
string raw header

See also:
Zend_Mail_Storage_Exception

Reimplemented from Zend_Mail_Storage_Abstract.

Definition at line 196 of file Maildir.php.

getSize ( id = null )

Get a list of messages with number and size

Parameters:
int | null$idnumber of message or null for all messages
Returns:
int|array size of given message of list with all messages as array(num => size)
Exceptions:
Zend_Mail_Storage_Exception

Reimplemented from Zend_Mail_Storage_Abstract.

Definition at line 151 of file Maildir.php.

getUniqueId ( id = null )

get unique id for one or all messages

if storage does not support unique ids it's the same as the message number

Parameters:
int | null$idmessage number
Returns:
array|string message number for given message or all messages as array
Exceptions:
Zend_Mail_Storage_Exception

Reimplemented from Zend_Mail_Storage_Abstract.

Definition at line 438 of file Maildir.php.

noop (  )

Waste some CPU cycles doing nothing.

Returns:
void

Reimplemented from Zend_Mail_Storage_Abstract.

Definition at line 408 of file Maildir.php.

removeMessage ( id )

stub for not supported message deletion

Returns:
null
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception

Reimplemented from Zend_Mail_Storage_Abstract.

Reimplemented in Zend_Mail_Storage_Writable_Maildir.

Definition at line 420 of file Maildir.php.


Field Documentation

$_knownFlags [static, protected]
Initial value:
 array('D' => Zend_Mail_Storage::FLAG_DRAFT,
                                          'F' => Zend_Mail_Storage::FLAG_FLAGGED,
                                          'P' => Zend_Mail_Storage::FLAG_PASSED,
                                          'R' => Zend_Mail_Storage::FLAG_ANSWERED,
                                          'S' => Zend_Mail_Storage::FLAG_SEEN,
                                          'T' => Zend_Mail_Storage::FLAG_DELETED)

Definition at line 68 of file Maildir.php.


The documentation for this class was generated from the following file: