package Default
inherited_from \Zend\Mail\Storage\Maildir

 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(array $params) 
inherited_from \Zend\Mail\Storage\Maildir::__construct()

Parameters

$params

array mail reader specific parameters

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Create instance with parameters

__construct(array $params) 
Inherited

Parameters

$params

array

mail reader specific parameters

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Destructor calls close() and therefore closes the resource.

__destruct() 
Inherited

Getter for has-properties. The standard has properties are: hasFolder, hasUniqueid, hasDelete, hasCreate, hasTop

__get(string $var) : boolean
Inherited

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

Parameters

$var

string

property name

Exceptions

\Zend\Mail\Storage\Exception\InvalidArgumentException

Returns

booleansupported or not

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

close() 
Inherited

Countable::count()

count() : integer
Inherited

Returns

integer

Count messages messages in current box/folder

countMessages() : integer
Inherited

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

integernumber of messages

Iterator::current()

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

Returns

\Zend\Mail\Storage\Messagecurrent message

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

getCapabilities() : array
Inherited

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
inherited_from \Zend\Mail\Storage\Folder\FolderInterface::getCurrentFolder()

Returns

\Zend\Mail\Storage\Folderinstance of current folder

get root folder or given folder

getFolders(string $rootFolder = null) : \Zend\Mail\Storage\Folder
inherited_from \Zend\Mail\Storage\Folder\FolderInterface::getFolders()

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

Get a message with headers and body

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

Parameters

$id

int number of message

Returns

\Zend\Mail\Storage\Message

get a message number from a unique id

getNumberByUniqueId(string $id) : integer
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()

Parameters

$id

string

unique id

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

integermessage number

Get raw content of message or part

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

Parameters

$id

integer

number of message

$part

nullarraystring

path to part or null for message content

Returns

stringraw content

Get raw header of message or part

getRawHeader(integer $id, null|array|string $part = null, integer $topLines = 0) : string
Inherited

Parameters

$id

integer

number of message

$part

nullarraystring

path to part or null for message header

$topLines

integer

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

Returns

stringraw header

Get a list of messages with number and size

getSize(integer $id = 0) : integer | array
Inherited

Parameters

$id

integer

number of message

Returns

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

get unique id for one or all messages

getUniqueId(integer|null $id = null) : array | string
Inherited

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

Parameters

$id

integernull

message number

Exceptions

\Zend\Mail\Storage\Exception\ExceptionInterface

Returns

arraystringmessage number for given message or all messages as array

Iterator::key()

key() : integer
Inherited

Returns

integerid of current position

Iterator::next()

next() 
Inherited

Keep the resource alive.

noop() 
Inherited

ArrayAccess::offsetExists()

offsetExists(integer $id) : boolean
Inherited

Parameters

$id

integer

Returns

boolean

ArrayAccess::offsetGet()

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

Parameters

$id

integer

Returns

\Zend\Mail\Storage\Messagemessage object

ArrayAccess::offsetSet()

offsetSet(mixed $id, mixed $value) 
Inherited

Parameters

$id

mixed

$value

mixed

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

ArrayAccess::offsetUnset()

offsetUnset(integer $id) : boolean
Inherited

Parameters

$id

integer

Returns

booleansuccess

delete a message from current box/folder

removeMessage($id) 
Inherited

Parameters

$id

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.

SeekableIterator::seek()

seek(integer $pos) 
Inherited

Parameters

$pos

integer

Exceptions

\Zend\Mail\Storage\Exception\OutOfBoundsException

select given folder

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

folder must be selectable!

inherited_from \Zend\Mail\Storage\Folder\FolderInterface::selectFolder()

Parameters

$globalName

\Zend\Mail\Storage\Folderstring

global name of folder or instance for subfolder

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

Iterator::valid()

valid() : boolean
Inherited

Returns

boolean

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. Also checks if message is valid

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

Parameters

$id

integer

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 = array()
Inherited

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) : boolean
Inherited

Parameters

$dirname

string

name of dir

Returns

booleandir is valid maildir

open given dir as current maildir

_openMaildir(string $dirname) 
Inherited

Parameters

$dirname

string

name of maildir

Exceptions

\Zend\Mail\Storage\Exception\RuntimeException

 Properties

 

name of current folder

$currentFolder : string

Default

 

delim char for subfolders

$delim : string

Default

 

data of found message files in maildir dir

$files : array

Default

array()
 

class capabilities with default values

$has : array

Default

array('uniqueid' => true, 'delete' => false, 'create' => false, 'top' => false, 'fetchPart' => true, 'flags' => false)
 

maximum iteration position (= message count)

$iterationMax : null | integer

Default

null
 

current iteration position

$iterationPos : integer

Default

0
 

known flag chars in filenames

$knownFlags : array

Default

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

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

 

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

$messageClass : string

Default

'Zend\Mail\Storage\Message'
 

root folder for folder structure

$rootFolder : \Zend\Mail\Storage\Folder

Default

 

rootdir of folder structure

$rootdir : string

Default