Class Zend_Mail_Storage_Mbox

Description

Located in /Mail/Storage/Mbox.php (line 48)

Zend_Mail_Storage_Abstract
   |
   --Zend_Mail_Storage_Mbox
Direct descendents
Class Description
 class Zend_Mail_Storage_Folder_Mbox
Variable Summary
 null|resource $_fh
 string $_filename
 array $_positions
Method Summary
 Zend_Mail_Storage_Mbox __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 = 0])
 array|string getUniqueId ([int|null $id = null])
 void noop ()
 null removeMessage ( $id)
 array _getPos (int $id)
 bool _isMboxFile (resource|string $file, [bool $fileIsString = true])
 null _openMboxFile (string $filename)
 array __sleep ()
 null __wakeup ()
Variables
null|resource $_fh (line 54)

file handle to mbox file

  • access: protected
int $_filemtime (line 66)

modification date of mbox file for __wakeup

  • access: protected
string $_filename (line 60)

filename of mbox file for __wakeup

  • access: protected
array $_positions (line 72)

start and end position of messages as array('start' => start, 'seperator' => headersep, 'end' => end)

  • 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 195)

Create instance with parameters Supported parameters are:

  • filename filename of mbox file

  • throws: Zend_Mail_Storage_Exception
  • access: public
Zend_Mail_Storage_Mbox __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 293)

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

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

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

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 177)
  • 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 158)
  • 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 93)

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
int|array getSize ([int|null $id = 0])
  • 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 333)

get unique id for one or all messages

Mbox does not support unique ids (yet) - it's always the same as the message number. That shouldn't be a problem, because we can't change mbox files. Therefor the message number is save enough.

  • 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 305)

Waste some CPU cycles doing nothing.

  • access: public
void noop ()

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

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
_getPos (line 116)

Get positions for mail message or throw exeption if id is invalid

  • return: positions as in _positions
  • throws: Zend_Mail_Storage_Exception
  • access: protected
array _getPos (int $id)
  • int $id: number of message
_isMboxFile (line 215)

check if given file is a mbox file

if $file is a resource its file pointer is moved after the first line

  • return: file is mbox file
  • access: protected
bool _isMboxFile (resource|string $file, [bool $fileIsString = true])
  • resource|string $file: stream resource of name of file
  • bool $fileIsString: file is string or resource
_openMboxFile (line 247)

open given file as current mbox file

  • throws: Zend_Mail_Storage_Exception
  • access: protected
null _openMboxFile (string $filename)
  • string $filename: filename of mbox file
__sleep (line 369)

magic method for serialize()

with this method you can cache the mbox class

  • return: name of variables
  • access: public
array __sleep ()

Redefined in descendants as:
__wakeup (line 383)

magic method for unserialize()

with this method you can cache the mbox class for cache validation the mtime of the mbox file is used

  • throws: Zend_Mail_Storage_Exception
  • access: public
null __wakeup ()

Redefined in descendants as:

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:43 -0700 by phpDocumentor 1.3.2