Class Zend_Mail_Storage_Maildir

Description

Located in /Mail/Storage/Maildir.php (line 47)

Zend_Mail_Storage_Abstract
   |
   --Zend_Mail_Storage_Maildir
Direct descendents
Variable Summary
 static array $_knownFlags
 array $_files
Method Summary
 Zend_Mail_Storage_Maildir __construct ($params $params)
 void close ()
 int countMessages ()
 int getNumberByUniqueId (string $id)
 void getRawContent ( $id, [ $part = null])
 void getRawHeader ( $id, [ $part = null], [ $topLines = 0])
 int|array getSize ([int|null $id = null])
 array|string getUniqueId ([int|null $id = null])
 void noop ()
 null removeMessage ( $id)
 string|array _getFileData (int $id, [string|null $field = null])
 null _getMaildirFiles (resource $dh, string $dirname, [array $default_flags = array()])
 bool _isMaildir (string $dirname)
 null _openMaildir (string $dirname)
Variables
static array $_knownFlags = 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)
(line 62)

known flag chars in filenames

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

  • access: protected
array $_files = array() (line 53)

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
Zend_Mail_Storage_Abstract::$_messageClass
Methods
Constructor __construct (line 209)

Create instance with parameters Supported parameters are:

  • dirname dirname of mbox file

  • throws: Zend_Mail_Storage_Exception
  • access: public
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:
close (line 311)

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 75)

Count messages all messages in current box

  • return: number of messages
  • throws: Zend_Mail_Storage_Exception
  • access: public
int countMessages ()

Redefinition of:
Zend_Mail_Storage_Abstract::countMessages()
Count messages messages in current box/folder
getMessage (line 135)

Fetch a message

  • throws: Zend_Mail_Storage_Exception
  • access: public
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
getNumberByUniqueId (line 371)

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

  • return: message number
  • throws: Zend_Mail_Storage_Exception
  • access: public
int getNumberByUniqueId (string $id)
  • string $id: unique id

Redefinition of:
Zend_Mail_Storage_Abstract::getNumberByUniqueId()
get a message number from a unique id
getRawContent (line 180)
  • 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 150)
  • access: public
void getRawHeader ( $id, [ $part = null], [ $topLines = 0])
  • $id
  • $part
  • $topLines

Redefinition of:
Zend_Mail_Storage_Abstract::getRawHeader()
Get raw header of message or part
getSize (line 112)

Get a list of messages with number and size

  • return: size of given message of list with all messages as array(num => size)
  • throws: Zend_Mail_Storage_Exception
  • access: public
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
getUniqueId (line 348)

get unique id for one or all messages

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

  • return: message number for given message or all messages as array
  • throws: Zend_Mail_Storage_Exception
  • access: public
array|string getUniqueId ([int|null $id = null])
  • int|null $id: message number

Redefinition of:
Zend_Mail_Storage_Abstract::getUniqueId()
get unique id for one or all messages
noop (line 322)

Waste some CPU cycles doing nothing.

  • access: public
void noop ()

Redefinition of:
Zend_Mail_Storage_Abstract::noop()
Keep the resource alive.
removeMessage (line 334)

stub for not supported message deletion

  • throws: Zend_Mail_Storage_Exception
  • access: public
null removeMessage ( $id)
  • $id

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

Redefined in descendants as:
_getFileData (line 88)

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

  • return: wanted field or all fields as array
  • throws: Zend_Mail_Storage_Exception
  • access: protected
string|array _getFileData (int $id, [string|null $field = null])
  • int $id: message number
  • string|null $field: wanted field
_getMaildirFiles (line 278)

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

  • access: protected
null _getMaildirFiles (resource $dh, string $dirname, [array $default_flags = array()])
  • resource $dh: dir handle used for search
  • string $dirname: dirname of dir in $dh
  • array $default_flags: default flags for given dir
_isMaildir (line 230)

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 248)

open given dir as current maildir

  • throws: Zend_Mail_Storage_Exception
  • access: protected
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::getNumberByUniqueId()
 Zend_Mail_Storage_Abstract::getRawContent()
 Zend_Mail_Storage_Abstract::getRawHeader()
 Zend_Mail_Storage_Abstract::getSize()
 Zend_Mail_Storage_Abstract::getUniqueId()
 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 Sun, 27 May 2007 23:25:37 -0700 by phpDocumentor 1.3.2