Class Zend_Mail_Storage_Writable_Maildir

Description

Implements interfaces:

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

Zend_Mail_Storage_Abstract
   |
   --Zend_Mail_Storage_Maildir
      |
      --Zend_Mail_Storage_Folder_Maildir
         |
         --Zend_Mail_Storage_Writable_Maildir
Method Summary
 void appendMessage (string $message, [null|string|Zend_Mail_Storage_Folder $folder = null], [null|array $flags = null])
 null copyMessage (int $id, string|Zend_Mail_Storage_Folder $folder)
 string createFolder (string $name, [string|Zend_Mail_Storage_Folder $parentFolder = null])
 null removeFolder (string|Zend_Mail_Storage_Folder $name)
 null removeMessage ( $id)
 null renameFolder (string|Zend_Mail_Storage_Folder $oldName, string $newName)
 void setFlags (int $id, array $flags)
 array _createTmpFile (string $folder)
 string _createUniqueId ()
 string _getInfoString ( &$flags, array $flags)
Variables
Methods
appendMessage (line 377)

append a new message to mail storage

  • access: public
void appendMessage (string $message, [null|string|Zend_Mail_Storage_Folder $folder = null], [null|array $flags = null])
  • string $message: message as string or instance of message class
  • null|string|Zend_Mail_Storage_Folder $folder: folder for new message, else current folder is taken
  • null|array $flags: set flags for new message, else a default set is used

Implementation of:
Zend_Mail_Storage_Writable_Interface::appendMessage()
append a new message to mail storage
copyMessage (line 429)

copy an existing message

  • access: public
null copyMessage (int $id, string|Zend_Mail_Storage_Folder $folder)

Implementation of:
Zend_Mail_Storage_Writable_Interface::copyMessage()
copy an existing message
createFolder (line 56)

create a new folder

This method also creates parent folders if necessary. Some mail storages may restrict, which folder may be used as parent or which chars may be used in the folder name

  • return: only used internally (new created maildir)
  • access: public
string createFolder (string $name, [string|Zend_Mail_Storage_Folder $parentFolder = null])
  • string $name: global name of folder, local name if $parentFolder is set
  • string|Zend_Mail_Storage_Folder $parentFolder: parent folder for new folder, else root folder is parent

Implementation of:
Zend_Mail_Storage_Writable_Interface::createFolder()
create a new folder
removeFolder (line 128)

remove a folder

  • access: public
null removeFolder (string|Zend_Mail_Storage_Folder $name)

Implementation of:
Zend_Mail_Storage_Writable_Interface::removeFolder()
remove a folder
removeMessage (line 514)

stub for not supported message deletion

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

Redefinition of:
Zend_Mail_Storage_Maildir::removeMessage()
stub for not supported message deletion
renameFolder (line 204)

rename and/or move folder

The new name has the same restrictions as in createFolder()

  • access: public
null renameFolder (string|Zend_Mail_Storage_Folder $oldName, string $newName)

Implementation of:
Zend_Mail_Storage_Writable_Interface::renameFolder()
rename and/or move folder
setFlags (line 489)

set flags for message

NOTE: this method can't set the recent flag.

  • access: public
void setFlags (int $id, array $flags)
  • int $id: number of message
  • array $flags: new flags for message

Implementation of:
Zend_Mail_Storage_Writable_Interface::setFlags()
set flags for message
_createTmpFile (line 295)

open a temporary maildir file

makes sure tmp/ exists and create a file with a unique name you should close the returned filehandle!

  • return: array('dirname' => dir of maildir folder, 'uniq' => unique id, 'filename' => name of create file 'handle' => file opened for writing)
  • access: protected
array _createTmpFile (string $folder)
  • string $folder: name of current folder without leading .
_createUniqueId (line 274)

create a uniqueid for maildir filename

This is nearly the format defined in the maildir standard. The microtime() call should already create a uniqueid, the pid is for multicore/-cpu machine that manage to call this function at the exact same time, and uname() gives us the hostname for multiple machines accessing the same storage.

If someone disables posix we create a random number of the same size, so this method should also work on Windows - if you manage to get maildir working on Windows. Microtime could also be disabled, altough I've never seen it.

  • return: new uniqueid
  • access: protected
string _createUniqueId ()
_getInfoString (line 340)

create an info string for filenames with given flags

  • return: info string for version 2 filenames including the leading colon
  • access: protected
string _getInfoString ( &$flags, array $flags)
  • array $flags: wanted flags, with the reference you'll get the set flags with correct key (= char for flag)
  • &$flags

Inherited Methods

Inherited From Zend_Mail_Storage_Folder_Maildir

 Zend_Mail_Storage_Folder_Maildir::__construct()
 Zend_Mail_Storage_Folder_Maildir::getCurrentFolder()
 Zend_Mail_Storage_Folder_Maildir::getFolders()
 Zend_Mail_Storage_Folder_Maildir::selectFolder()
 Zend_Mail_Storage_Folder_Maildir::_buildFolderTree()

Inherited From Zend_Mail_Storage_Maildir

 Zend_Mail_Storage_Maildir::__construct()
 Zend_Mail_Storage_Maildir::close()
 Zend_Mail_Storage_Maildir::countMessages()
 Zend_Mail_Storage_Maildir::getMessage()
 Zend_Mail_Storage_Maildir::getNumberByUniqueId()
 Zend_Mail_Storage_Maildir::getRawContent()
 Zend_Mail_Storage_Maildir::getRawHeader()
 Zend_Mail_Storage_Maildir::getSize()
 Zend_Mail_Storage_Maildir::getUniqueId()
 Zend_Mail_Storage_Maildir::noop()
 Zend_Mail_Storage_Maildir::removeMessage()
 Zend_Mail_Storage_Maildir::_getFileData()
 Zend_Mail_Storage_Maildir::_getMaildirFiles()
 Zend_Mail_Storage_Maildir::_isMaildir()
 Zend_Mail_Storage_Maildir::_openMaildir()

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