category Zend
package Zend_Mail
subpackage Storage

 Methods

Create instance with parameters Supported parameters are: - dirname rootdir of maildir structure - delim delim char for folder structure, default is '.' - folder initial selected folder, default is 'INBOX'

__construct(\Zend\Mail\Storage\Folder\$params $params) 

Parameters

$params

\Zend\Mail\Storage\Folder\$params

array mail reader specific parameters

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Destructor calls close() and therefore closes the resource.

__destruct() 
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::__destruct()
inherited_from \Zend\Mail\Storage\Maildir::__destruct()

Getter for has-properties.

__get(string $var) : bool
Inherited

The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop

The valid values for the has-properties are: - true if a feature is supported - false if a feature is not supported - null is it's not yet known or it can't be know if a feature is supported

inherited_from \Zend\Mail\Storage\AbstractStorage::__get()
inherited_from \Zend\Mail\Storage\Maildir::__get()

Parameters

$var

string

property name

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Returns

boolsupported or not

Close resource for mail lib.

close() 
Inherited

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

inherited_from \Zend\Mail\Storage\Maildir::close()

Countable::count()

count() : int
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::count()
inherited_from \Zend\Mail\Storage\Maildir::count()

Returns

int

Count messages all messages in current box

countMessages(mixed $flags) : int
Inherited

inherited_from \Zend\Mail\Storage\Maildir::countMessages()

Parameters

$flags

mixed

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

intnumber of messages

Iterator::current()

current() : \Zend\Mail\Storage\Message
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::current()
inherited_from \Zend\Mail\Storage\Maildir::current()

Returns

Get a full list of features supported by the specific mail lib and the server

getCapabilities() : array
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::getCapabilities()
inherited_from \Zend\Mail\Storage\Maildir::getCapabilities()

Returns

arraylist of features as array(feature_name => true|false[|null])

get \Zend\Mail\Storage\Folder instance for current folder

getCurrentFolder() : \Zend\Mail\Storage\Folder

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

\Zend\Mail\Storage\Folderinstance of current folder

get root folder or given folder

getFolders(string $rootFolder) : \Zend\Mail\Storage\Folder

Parameters

$rootFolder

string

get folder structure for given folder, else root

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Returns

\Zend\Mail\Storage\Folderroot or wanted folder

Fetch a message

getMessage(int $id) : \Zend\Mail\Storage\Message\File
Inherited

inherited_from \Zend\Mail\Storage\Maildir::getMessage()

Parameters

$id

int

number of message

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

get a message number from a unique id

getNumberByUniqueId(string $id) : int
Inherited

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

inherited_from \Zend\Mail\Storage\Maildir::getNumberByUniqueId()

Parameters

$id

string

unique id

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Returns

intmessage number

Get raw content of message or part

getRawContent(int $id, null | array | string $part) : string
Inherited

inherited_from \Zend\Mail\Storage\Maildir::getRawContent()

Parameters

$id

int

number of message

$part

nullarraystring

path to part or null for message content

Returns

stringraw content

Get raw header of message or part

getRawHeader(int $id, null | array | string $part, int $topLines) : string
Inherited

inherited_from \Zend\Mail\Storage\Maildir::getRawHeader()

Parameters

$id

int

number of message

$part

nullarraystring

path to part or null for message header

$topLines

int

include this many lines with header (after an empty line)

Returns

stringraw header

Get a list of messages with number and size

getSize(int | null $id) : int | array
Inherited

inherited_from \Zend\Mail\Storage\Maildir::getSize()

Parameters

$id

intnull

number of message or null for all messages

Returns

intarraysize of given message of list with all messages as array(num => size)

get unique id for one or all messages

getUniqueId(int | null $id) : array | string
Inherited

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

inherited_from \Zend\Mail\Storage\Maildir::getUniqueId()

Parameters

$id

intnull

message number

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

arraystringmessage number for given message or all messages as array

Iterator::key()

key() : int
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::key()
inherited_from \Zend\Mail\Storage\Maildir::key()

Returns

intid of current position

Waste some CPU cycles doing nothing.

noop() : bool
Inherited

inherited_from \Zend\Mail\Storage\Maildir::noop()

Returns

boolalways return true

ArrayAccess::offsetExists()

offsetExists(int $id) : boolean
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::offsetExists()
inherited_from \Zend\Mail\Storage\Maildir::offsetExists()

Parameters

$id

int

Returns

boolean

ArrayAccess::offsetGet()

offsetGet(int $id) : \Zend\Mail\Storage\Message
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::offsetGet()
inherited_from \Zend\Mail\Storage\Maildir::offsetGet()

Parameters

$id

int

Returns

ArrayAccess::offsetSet()

offsetSet(mixed $id, mixed $value) 
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::offsetSet()
inherited_from \Zend\Mail\Storage\Maildir::offsetSet()

Parameters

$id

mixed

$value

mixed

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

ArrayAccess::offsetUnset()

offsetUnset(int $id) : boolean
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::offsetUnset()
inherited_from \Zend\Mail\Storage\Maildir::offsetUnset()

Parameters

$id

int

Returns

booleansuccess

stub for not supported message deletion

removeMessage($id) 
Inherited

inherited_from \Zend\Mail\Storage\Maildir::removeMessage()

Parameters

$id

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

Iterator::rewind()

rewind() 
Inherited

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.

inherited_from \Zend\Mail\Storage\AbstractStorage::rewind()
inherited_from \Zend\Mail\Storage\Maildir::rewind()

SeekableIterator::seek()

seek(int $pos) 
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::seek()
inherited_from \Zend\Mail\Storage\Maildir::seek()

Parameters

$pos

int

Exceptions

\Zend\Mail\Storage\Exception\OutOfBoundsException

select given folder

selectFolder(\Zend\Mail\Storage\Folder | string $globalName) 

folder must be selectable!

Parameters

$globalName

\Zend\Mail\Storage\Folderstring

global name of folder or instance for subfolder

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

Iterator::valid()

valid() : bool
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::valid()
inherited_from \Zend\Mail\Storage\Maildir::valid()

Returns

bool

find all subfolders and mbox files for folder structure

_buildFolderTree() 

Result is save in \Zend\Mail\Storage\Folder instances with the root in $this->rootFolder. $parentFolder and $parentGlobalName are only used internally for recursion.

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

Get one or all fields from file structure.

_getFileData(int $id, string | null $field) : string | array
Inherited

Also checks if message is valid

inherited_from \Zend\Mail\Storage\Maildir::_getFileData()

Parameters

$id

int

message number

$field

stringnull

wanted field

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Returns

stringarraywanted field or all fields as array

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

_getMaildirFiles(resource $dh, string $dirname, array $defaultFlags) 
Inherited

inherited_from \Zend\Mail\Storage\Maildir::_getMaildirFiles()

Parameters

$dh

resource

dir handle used for search

$dirname

string

dirname of dir in $dh

$defaultFlags

array

default flags for given dir

check if a given dir is a valid maildir

_isMaildir(string $dirname) : bool
Inherited

inherited_from \Zend\Mail\Storage\Maildir::_isMaildir()

Parameters

$dirname

string

name of dir

Returns

booldir is valid maildir

open given dir as current maildir

_openMaildir(string $dirname) 
Inherited

inherited_from \Zend\Mail\Storage\Maildir::_openMaildir()

Parameters

$dirname

string

name of maildir

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

 Properties

 

name of current folder

$currentFolder : string

 

delim char for subfolders

$delim : string

 

data of found message files in maildir dir

$files : array
Inherited

inherited_from \Zend\Mail\Storage\Maildir::$$files
 

class capabilities with default values

$has : array
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::$$has
inherited_from \Zend\Mail\Storage\Maildir::$$has
 

maximum iteration position (= message count)

$iterationMax : null | int
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::$$iterationMax
inherited_from \Zend\Mail\Storage\Maildir::$$iterationMax
 

current iteration position

$iterationPos : int
Inherited

inherited_from \Zend\Mail\Storage\AbstractStorage::$$iterationPos
inherited_from \Zend\Mail\Storage\Maildir::$$iterationPos
 

known flag chars in filenames

$knownFlags : array
Inherited

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

inherited_from \Zend\Mail\Storage\Maildir::$$knownFlags
 

used message class, change it in an extended class to extend the returned message class

$messageClass : string
Inherited

inherited_from \Zend\Mail\Storage\Maildir::$$messageClass
 

root folder for folder structure

$rootFolder : \Zend\Mail\Storage\Folder

 

rootdir of folder structure

$rootdir : string