## Zend_Mail_Storage_Maildir

Description

- license: Zend Framework License version 1.0
- copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Mail/Storage/Maildir.php (line 42)

    Zend_Mail_Storage_Abstract
       |
       --Zend_Mail_Storage_Maildir

Direct descendents

Class | Description
--- | ---
Zend_Mail_Storage_Folder_Maildir |

Variable Summary
static array $_knownFlags
array $_files
Method Summary
Zend_Mail_Storage_Maildir __construct ($params $params)
void close ()
int countMessages ()
Zend_Mail_Message getMessage (int $id)
void getRawContent ( $id, [ $part = null])
void getRawHeader ( $id, [ $part = null], [ $topLines = 0])
int|array getSize ([int|null $id = null])
void noop ()
null removeMessage ( $id)
string|array _getFileData (int $id, [string|null $field = null])
bool _isMaildir (string $dirname)
null _openMaildir (string $dirname)
Variables
static array $_knownFlags = array('P' => 'Passed',
'R' => 'Replied',
'S' => 'Seen',
'T' => 'Trashed',
'D' => 'Draft',
'F' => 'Flagged') (line 54)

known flag chars in filenames

- access: protected

array $_files = array() (line 48)

data of found message files in maildir dir

- access: protected

#### Inherited Variables

Inherited from Zend_Mail_Storage_Abstract

> Zend_Mail_Storage_Abstract::$_has
> Zend_Mail_Storage_Abstract::$_iterationMax
> Zend_Mail_Storage_Abstract::$_iterationPos

Methods
Constructor __construct (line 200)

Create instance with parameters Supported parameters are:

- dirname dirname of mbox file

- access: public
- throws: Zend_Mail_Storage_Exception

Zend_Mail_Storage_Maildir __construct ($params $params)

- $params $params: array mail reader specific parameters

Redefinition of:

Zend_Mail_Storage_Abstract::__construct()
  Create instance with parameters

Redefined in descendants as:

- Zend_Mail_Storage_Folder_Maildir::__construct() : Create instance with parameters

close (line 273)

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

- access: public

void close ()

Redefinition of:

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

countMessages (line 67)

Count messages all messages in current box

- return: number of messages
- access: public
- throws: Zend_Mail_Storage_Exception

int countMessages ()

Redefinition of:

Zend_Mail_Storage_Abstract::countMessages()
  Count messages messages in current box/folder

getMessage (line 127)

Fetch a message

- access: public
- throws: Zend_Mail_Storage_Exception

Zend_Mail_Message getMessage (int $id)

- int $id: number of message

Redefinition of:

Zend_Mail_Storage_Abstract::getMessage()
  Get a message with headers and body

getRawContent (line 171)

- access: public

void getRawContent ( $id, [ $part = null])

- $id
- $part

Redefinition of:

Zend_Mail_Storage_Abstract::getRawContent()
  Get raw content of message or part

getRawHeader (line 141)

- access: public

void getRawHeader ( $id, [ $part = null], $topLines)

- $id
- $part
- $topLines

Redefinition of:

Zend_Mail_Storage_Abstract::getRawHeader()
  Get raw header of message or part

getSize (line 104)

Get a list of messages with number and size

- return: size of given message of list with all messages as array(num => size)
- access: public
- throws: Zend_Mail_Storage_Exception

int|array getSize ([int|null $id = null])

- int|null $id: number of message or null for all messages

Redefinition of:

Zend_Mail_Storage_Abstract::getSize()
  Get a list of messages with number and size

noop (line 284)

Waste some CPU cycles doing nothing.

- access: public

void noop ()

Redefinition of:

Zend_Mail_Storage_Abstract::noop()
  Keep the resource alive.

removeMessage (line 296)

stub for not supported message deletion

- access: public
- throws: Zend_Mail_Storage_Exception

null removeMessage ( $id)

- $id

Redefinition of:

Zend_Mail_Storage_Abstract::removeMessage()
  delete a message from current box/folder

_getFileData (line 80)

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

- return: wanted field or all fields as array
- access: protected
- throws: Zend_Mail_Storage_Exception

string|array _getFileData (int $id, [string|null $field = null])

- int $id: message number
- string|null $field: wanted field

_isMaildir (line 220)

check if a given dir is a valid maildir

- return: dir is valid maildir
- access: protected

bool _isMaildir (string $dirname)

- string $dirname: name of dir

_openMaildir (line 232)

open given dir as current maildir

- access: protected
- throws: Zend_Mail_Storage_Exception

null _openMaildir (string $dirname)

- string $dirname: name of maildir

#### Inherited Methods

Inherited From Zend_Mail_Storage_Abstract

> Zend_Mail_Storage_Abstract::__construct()
> Zend_Mail_Storage_Abstract::close()
> Zend_Mail_Storage_Abstract::count()
> Zend_Mail_Storage_Abstract::countMessages()
> Zend_Mail_Storage_Abstract::current()
> Zend_Mail_Storage_Abstract::getCapabilities()
> Zend_Mail_Storage_Abstract::getMessage()
> Zend_Mail_Storage_Abstract::getRawContent()
> Zend_Mail_Storage_Abstract::getRawHeader()
> Zend_Mail_Storage_Abstract::getSize()
> Zend_Mail_Storage_Abstract::key()
> Zend_Mail_Storage_Abstract::next()
> Zend_Mail_Storage_Abstract::noop()
> Zend_Mail_Storage_Abstract::offsetExists()
> Zend_Mail_Storage_Abstract::offsetGet()
> Zend_Mail_Storage_Abstract::offsetSet()
> Zend_Mail_Storage_Abstract::offsetUnset()
> Zend_Mail_Storage_Abstract::removeMessage()
> Zend_Mail_Storage_Abstract::rewind()
> Zend_Mail_Storage_Abstract::seek()
> Zend_Mail_Storage_Abstract::valid()
> Zend_Mail_Storage_Abstract::__destruct()
> Zend_Mail_Storage_Abstract::__get()

Documentation generated on Wed, 21 Feb 2007 11:53:36 -0800 by phpDocumentor 1.3.1