API Documentation

Zend/Mail/Storage/Maildir.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Mail  
Subpackage
Storage  
Version
$Id: Maildir.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Mail_Storage_Maildir

Package: Zend\Mail\Storage

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

Properties

Propertyprotectedarray  $_files= 'array()'

data of found message files in maildir dir

Default valuearray()Details
Type
array
Propertyprotectedarray  $_knownFlags= 'array('D' => Zend_Mail_Storage::FLAG_DRAFT'
static

known flag chars in filenames

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

Default valuearray('D' => Zend_Mail_Storage::FLAG_DRAFTDetails
Type
array
Propertyprotectedstring  $_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
Name Type Description
$params array

mail reader specific parameters

Throws
Exception Description
\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
Name Type Description
$id int

message number

$field string|null

wanted field

Returns
Type Description
string|array wanted field or all fields as array
Throws
Exception Description
\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
Name Type Description
$dh resource

dir handle used for search

$dirname string

dirname of dir in $dh

$default_flags array

default flags for given dir

Returns
Type Description
null
methodprotected_isMaildir( string $dirname ) : bool

check if a given dir is a valid maildir

Parameters
Name Type Description
$dirname string

name of dir

Returns
Type Description
bool dir is valid maildir
methodprotected_openMaildir( string $dirname ) : null

open given dir as current maildir

Parameters
Name Type Description
$dirname string

name of maildir

Returns
Type Description
null
Throws
Exception Description
\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
Name Type Description
$flags
Returns
Type Description
int number of messages
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicgetMessage( int $id ) : \Zend_Mail_Message_File

Fetch a message

Parameters
Name Type Description
$id int

number of message

Returns
Type Description
\Zend_Mail_Message_File
Throws
Exception Description
\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
Name Type Description
$id string

unique id

Returns
Type Description
int message number
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicgetRawContent(  $id,  $part = null ) : void

Parameters
Name Type Description
$id
$part
methodpublicgetRawHeader(  $id,  $part = null,  $topLines = 0 ) : void

Parameters
Name Type Description
$id
$part
$topLines
methodpublicgetSize( int|null $id = null ) : int|array

Get a list of messages with number and size

Parameters
Name Type Description
$id int|null

number of message or null for all messages

Returns
Type Description
int|array size of given message of list with all messages as array(num => size)
Throws
Exception Description
\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
Name Type Description
$id int|null

message number

Returns
Type Description
array|string message number for given message or all messages as array
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicnoop( ) : void

Waste some CPU cycles doing nothing.

methodpublicremoveMessage(  $id ) : null

stub for not supported message deletion

Parameters
Name Type Description
$id
Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
Documentation was generated by DocBlox 0.15.1.