Mail/Storage/Maildir.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework
LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Mail  
Subpackage
Storage  
Version
$Id$  

\Zend_Mail_Storage_Maildir
jump to top

Package: Zend_Mail\Storage
Parent(s)
\Zend_Mail_Storage_Abstract
Children
\Zend_Mail_Storage_Folder_Maildir
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_files = array()
data of found message files in maildir dir
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_knownFlags = 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
known flag chars in filenames
This list has to be in alphabetical order for setFlags()
Default valuearray('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)Details
Type
array
>VPropertyprotectedstring $_messageClass = 'Zend_Mail_Message_File'
used message class, change it in an extened class to extend the returned message class
Default value'Zend_Mail_Message_File'Details
Type
string

Methods

methodpublic__construct(array $params) : void

Create instance with parameters Supported parameters are: - dirname dirname of mbox file

Parameters
NameTypeDescription
$paramsarray

mail reader specific parameters

Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodprotected_getFileData(int $id, string | null $field = null) : string | array

Get one or all fields from file structure. Also checks if message is valid

Parameters
NameTypeDescription
$idint

message number

$fieldstring | null

wanted field

Returns
TypeDescription
string | arraywanted field or all fields as array
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodprotected_getMaildirFiles(resource $dh, string $dirname, array $default_flags = array()) : null

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

Parameters
NameTypeDescription
$dhresource

dir handle used for search

$dirnamestring

dirname of dir in $dh

$default_flagsarray

default flags for given dir

Returns
TypeDescription
null
methodprotected_isMaildir(string $dirname) : bool

check if a given dir is a valid maildir

Parameters
NameTypeDescription
$dirnamestring

name of dir

Returns
TypeDescription
booldir is valid maildir
methodprotected_openMaildir(string $dirname) : null

open given dir as current maildir

Parameters
NameTypeDescription
$dirnamestring

name of maildir

Returns
TypeDescription
null
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicclose() : void

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

methodpubliccountMessages( $flags = null) : int

Count messages all messages in current box

Parameters
NameTypeDescription
$flags
Returns
TypeDescription
intnumber of messages
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicgetMessage(int $id) : \Zend_Mail_Message_File

Fetch a message

Parameters
NameTypeDescription
$idint

number of message

Returns
TypeDescription
\Zend_Mail_Message_File
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicgetNumberByUniqueId(string $id) : int

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()
Parameters
NameTypeDescription
$idstring

unique id

Returns
TypeDescription
intmessage number
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicgetRawContent( $id,  $part = null) : void

Parameters
NameTypeDescription
$id
$part
methodpublicgetRawHeader( $id,  $part = null,  $topLines = 0) : void

Parameters
NameTypeDescription
$id
$part
$topLines
methodpublicgetSize(int | null $id = null) : int | array

Get a list of messages with number and size

Parameters
NameTypeDescription
$idint | null

number of message or null for all messages

Returns
TypeDescription
int | arraysize of given message of list with all messages as array(num => size)
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicgetUniqueId(int | null $id = null) : array | string

get unique id for one or all messages

if storage does not support unique ids it's the same as the message number
Parameters
NameTypeDescription
$idint | null

message number

Returns
TypeDescription
array | stringmessage number for given message or all messages as array
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
methodpublicnoop() : void

Waste some CPU cycles doing nothing.

methodpublicremoveMessage( $id) : null

stub for not supported message deletion

Parameters
NameTypeDescription
$id
Returns
TypeDescription
null
Throws
ExceptionDescription
\Zend_Mail_Storage_Exception
Documentation was generated by phpDocumentor 2.2.0 .