category | Zend |
---|---|
package | Zend_Mail |
subpackage | Storage |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Mail_Storage_Folder_Maildir |
__construct(array $params)
inherited_from | \Zend_Mail_Storage_Folder_Maildir::__construct() |
---|
array
mail reader specific parameters
\Zend_Mail_Storage_Exception |
---|
__construct(array $params)
array
mail reader specific parameters
\Zend_Mail_Storage_Exception |
---|
__destruct()
__get(string $var) : boolean
The valid values for the has-properties are:
string
property name
\Zend_Mail_Storage_Exception |
---|
boolean
supported or notappendMessage(string|\Zend_Mail_Message|\Zend_Mime_Message $message, null|string|\Zend_Mail_Storage_Folder $folder= null
, null|array $flags= null
, $recent= false
)
inherited_from | \Zend_Mail_Storage_Writable_Interface::appendMessage() |
---|
checkQuota(boolean $detailedResponse= false
, $forceRecalc= false
) : boolean | array
boolean
return known data of quota and current size and message count @see _calculateQuota()
boolean
array
over quota state or detailed responseclose() : null
null
copyMessage(integer $id, string|\Zend_Mail_Storage_Folder $folder) : null
inherited_from | \Zend_Mail_Storage_Writable_Interface::copyMessage() |
---|
integer
number of message
string
\Zend_Mail_Storage_Folder
name or instance of targer folder
\Zend_Mail_Storage_Exception |
---|
null
count() : integer
integer
countMessages() : integer
\Zend_Mail_Storage_Exception |
---|
integer
number of messagescreateFolder(string $name, string|\Zend_Mail_Storage_Folder $parentFolder = null
) : string
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
inherited_from | \Zend_Mail_Storage_Writable_Interface::createFolder() |
---|
string
global name of folder, local name if $parentFolder is set
string
\Zend_Mail_Storage_Folder
parent folder for new folder, else root folder is parent
\Zend_Mail_Storage_Exception |
---|
string
only used internally (new created maildir)current() : \Zend_Mail_Message
\Zend_Mail_Message
current messagegetCapabilities() : array
array
list of features as array(featurename => true|false[|null])getCurrentFolder() : \Zend_Mail_Storage_Folder
inherited_from | \Zend_Mail_Storage_Folder_Interface::getCurrentFolder() |
---|
\Zend_Mail_Storage_Exception |
---|
\Zend_Mail_Storage_Folder
instance of current foldergetFolders(string $rootFolder = null
) : \Zend_Mail_Storage_Folder
inherited_from | \Zend_Mail_Storage_Folder_Interface::getFolders() |
---|
string
get folder structure for given folder, else root
\Zend_Mail_Storage_Exception |
---|
\Zend_Mail_Storage_Folder
root or wanted foldergetMessage(integer $id) : \Zend_Mail_Message
integer
number of message
\Zend_Mail_Message
getNumberByUniqueId(string $id) : integer
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()
string
unique id
\Zend_Mail_Storage_Exception |
---|
integer
message numbergetQuota($fromStorage = false
) : boolean | array
getRawContent(integer $id, null|array|string $part = null
) : string
integer
number of message
null
array
string
path to part or null for messsage content
string
raw contentgetRawHeader(integer $id, null|array|string $part= null
, integer $topLines= 0
) : string
integer
number of message
null
array
string
path to part or null for messsage header
integer
include this many lines with header (after an empty line)
string
raw headergetSize(integer $id = 0
) : integer | array
integer
number of message
integer
array
size of given message of list with all messages as array(num => size)getUniqueId(integer|null $id = null
) : array | string
if storage does not support unique ids it's the same as the message number
integer
null
message number
\Zend_Mail_Storage_Exception |
---|
array
string
message number for given message or all messages as arrayinitMaildir(string $dir) : null
If the given dir is already a valid maildir this will not fail.
string
directory for the new maildir (may already exist)
\Zend_Mail_Storage_Exception |
---|
null
key() : integer
integer
id of current positionmoveMessage(integer $id, string|\Zend_Mail_Storage_Folder $folder) : null
inherited_from | \Zend_Mail_Storage_Writable_Interface::moveMessage() |
---|
integer
number of message
string
\Zend_Mail_Storage_Folder
name or instance of targer folder
\Zend_Mail_Storage_Exception |
---|
null
next() : void
noop() : null
null
offsetExists(integer $id) : boolean
integer
boolean
offsetGet(integer $id) : \Zend_Mail_Message
integer
\Zend_Mail_Message
message objectoffsetSet(\id $id, mixed $value) : void
\id
mixed
\Zend_Mail_Storage_Exception |
---|
offsetUnset(integer $id) : boolean
integer
boolean
successremoveFolder(string|\Zend_Mail_Storage_Folder $name) : null
inherited_from | \Zend_Mail_Storage_Writable_Interface::removeFolder() |
---|
string
\Zend_Mail_Storage_Folder
name or instance of folder
\Zend_Mail_Storage_Exception |
---|
null
removeMessage($id) : null
\Zend_Mail_Storage_Exception |
---|
null
removeMessage($id) : null
null
renameFolder(string|\Zend_Mail_Storage_Folder $oldName, string $newName) : null
The new name has the same restrictions as in createFolder()
inherited_from | \Zend_Mail_Storage_Writable_Interface::renameFolder() |
---|
string
\Zend_Mail_Storage_Folder
name or instance of folder
string
new global name of folder
\Zend_Mail_Storage_Exception |
---|
null
rewind() : void
Rewind always gets the new count from the storage. Thus if you use the interfaces and your scripts take long you should use reset() from time to time.
seek(integer $pos) : void
integer
\OutOfBoundsException |
---|
selectFolder(\Zend_Mail_Storage_Folder|string $globalName) : null
folder must be selectable!
inherited_from | \Zend_Mail_Storage_Folder_Interface::selectFolder() |
---|
\Zend_Mail_Storage_Folder
string
global name of folder or instance for subfolder
\Zend_Mail_Storage_Exception |
---|
null
setFlags(integer $id, array $flags)
NOTE: this method can't set the recent flag.
inherited_from | \Zend_Mail_Storage_Writable_Interface::setFlags() |
---|
integer
number of message
array
new flags for message
\Zend_Mail_Storage_Exception |
---|
setQuota(boolean|array $value) : null
You can enable/disable quota with true/false. If you don't have a MDA or want to enforce a quota value you can also set this value here. Use array('size' => SIZE_QUOTA, 'count' => MAX_MESSAGE) do define your quota. Order of these fields does matter!
boolean
array
new quota value
null
valid() : boolean
boolean
_addQuotaEntry($size, $count = 1
)
_buildFolderTree() : null
Result is save in Zend_Mail_Storage_Folder instances with the root in $this->_rootFolder. $parentFolder and $parentGlobalName are only used internally for recursion.
\Zend_Mail_Storage_Exception |
---|
null
_calculateQuota($forceRecalc = false
)
_createTmpFile(string $folder = 'INBOX'
) : array
makes sure tmp/ exists and create a file with a unique name you should close the returned filehandle!
string
name of current folder without leading .
\Zend_Mail_Storage_Exception |
---|
array
array('dirname' => dir of maildir folder, 'uniq' => unique id, 'filename' => name of create file
'handle' => file opened for writing)_createUniqueId() : string
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.
string
new uniqueid_getFileData(integer $id, string|null $field = null
) : string | array
integer
message number
string
null
wanted field
\Zend_Mail_Storage_Exception |
---|
string
array
wanted field or all fields as array_getInfoString(array $flags) : string
array
wanted flags, with the reference you'll get the set flags with correct key (= char for flag)
\Zend_Mail_Storage_Exception |
---|
string
info string for version 2 filenames including the leading colon_getMaildirFiles(resource $dh, string $dirname, array $default_flags = array()
) : null
resource
dir handle used for search
string
dirname of dir in $dh
array
default flags for given dir
null
_isMaildir(string $dirname) : boolean
string
name of dir
boolean
dir is valid maildir_openMaildir(string $dirname) : null
string
name of maildir
\Zend_Mail_Storage_Exception |
---|
null
$_currentFolder : string
$_delim : string
$_files : array
array()
$_has : array
array('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)
$_iterationMax : null | integer
null
$_iterationPos : integer
0
$_knownFlags : array
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)
This list has to be in alphabetical order for setFlags()
$_quota : boolean | integer
$_rootFolder : \Zend_Mail_Storage_Folder
$_rootdir : string