API Documentation

Zend/Mail/Storage/Imap.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: Imap.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Mail_Storage_Imap

Package: Zend\Mail\Storage

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

Properties

Propertyprotectedstring  $_currentFolder= ''''

name of current folder

Default value''Details
Type
string
Propertyprotectedarray  $_knownFlags= 'array('\Passed' => Zend_Mail_Storage::FLAG_PASSED'
static

imap flags to constants translation

Default valuearray('\Passed' => Zend_Mail_Storage::FLAG_PASSEDDetails
Type
array
Propertyprotectednull|\Zend_Mail_Protocol_Imap  $_protocol= ''

protocol handler

Details
Type
null\Zend_Mail_Protocol_Imap
Propertyprotectedarray  $_searchFlags= 'array('\Recent' => 'RECENT''
static

map flags to search criterias

Default valuearray('\Recent' => 'RECENT'Details
Type
array

Methods

methodpublic__construct( array $params ) : void

create instance with parameters Supported paramters are - user username - host hostname or ip address of IMAP server [optional, default = 'localhost'] - password password for user 'username' [optional, default = ''] - port port for IMAP server [optional, default = 110] - ssl 'SSL' or 'TLS' for secure sockets - folder select this folder [optional, default = 'INBOX']

Parameters
Name Type Description
$params array

mail reader specific parameters

Throws
Exception Description
\Zend_Mail_Storage_Exception
\Zend_Mail_Protocol_Exception
methodpublicappendMessage( string $message, null|string|\Zend_Mail_Storage_Folder $folder = null, null|array $flags = null ) : void

append a new message to mail storage

Parameters
Name Type Description
$message string

message as string or instance of message class

$folder null|string|\Zend_Mail_Storage_Folder

folder for new message, else current folder is taken

$flags null|array

set flags for new message, else a default set is used

Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicclose( ) : null

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

Returns
Type Description
null
methodpubliccopyMessage( int $id, string|\Zend_Mail_Storage_Folder $folder ) : null

copy an existing message

Parameters
Name Type Description
$id int

number of message

$folder string|\Zend_Mail_Storage_Folder

name or instance of targer folder

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
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
\Zend_Mail_Protocol_Exception
methodpubliccreateFolder( string $name, string|\Zend_Mail_Storage_Folder $parentFolder = null ) : null

create a new folder

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

Parameters
Name Type Description
$name string

global name of folder, local name if $parentFolder is set

$parentFolder string|\Zend_Mail_Storage_Folder

parent folder for new folder, else root folder is parent

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicgetCurrentFolder( ) : \Zend_Mail_Storage_Folder

get Zend_Mail_Storage_Folder instance for current folder

Returns
Type Description
\Zend_Mail_Storage_Folder instance of current folder
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicgetFolders( string $rootFolder = null ) : \Zend_Mail_Storage_Folder

get root folder or given folder

Parameters
Name Type Description
$rootFolder string

get folder structure for given folder, else root

Returns
Type Description
\Zend_Mail_Storage_Folder root or wanted folder
Throws
Exception Description
\Zend_Mail_Storage_Exception
\Zend_Mail_Protocol_Exception
methodpublicgetMessage( int $id ) : \Zend_Mail_Message

Fetch a message

Parameters
Name Type Description
$id int

number of message

Returns
Type Description
\Zend_Mail_Message
Throws
Exception Description
\Zend_Mail_Protocol_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 $id = 0 ) : int|array

get a list of messages with number and size

Parameters
Name Type Description
$id int

number of message

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

move an existing message

NOTE: imap has no native move command, thus it's emulated with copy and delete

Parameters
Name Type Description
$id int

number of message

$folder string|\Zend_Mail_Storage_Folder

name or instance of targer folder

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicnoop( ) : null

Keep the server busy.

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicremoveFolder( string|\Zend_Mail_Storage_Folder $name ) : null

remove a folder

Parameters
Name Type Description
$name string|\Zend_Mail_Storage_Folder

name or instance of folder

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicremoveMessage( int $id ) : null

Remove a message from server. If you're doing that from a web enviroment you should be careful and use a uniqueid as parameter if possible to identify the message.

Parameters
Name Type Description
$id int

number of message

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicrenameFolder( string|\Zend_Mail_Storage_Folder $oldName, string $newName ) : null

rename and/or move folder

The new name has the same restrictions as in createFolder()

Parameters
Name Type Description
$oldName string|\Zend_Mail_Storage_Folder

name or instance of folder

$newName string

new global name of folder

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
methodpublicselectFolder( \Zend_Mail_Storage_Folder|string $globalName ) : null

select given folder

folder must be selectable!

Parameters
Name Type Description
$globalName \Zend_Mail_Storage_Folder|string

global name of folder or instance for subfolder

Returns
Type Description
null
Throws
Exception Description
\Zend_Mail_Storage_Exception
\Zend_Mail_Protocol_Exception
methodpublicsetFlags( int $id, array $flags ) : void

set flags for message

NOTE: this method can't set the recent flag.

Parameters
Name Type Description
$id int

number of message

$flags array

new flags for message

Throws
Exception Description
\Zend_Mail_Storage_Exception
Documentation was generated by DocBlox 0.15.1.