Mail/Storage/Imap.php

Show:

inherited

Classes
- \Zend_Mail_Storage_Imap

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_Imap
jump to top

Package: Zend_Mail\Storage

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

Properties

string $_currentFolder = ''

name of current folder

Default value''Details

Type: string

array $_knownFlags = array('\Passed' => \Zend_Mail_Storage::FLAG_PASSED, '\Answered' => \Zend_Mail_Storage::FLAG_ANSWERED, '\Seen' => \Zend_Mail_Storage::FLAG_SEEN, '\Deleted' => \Zend_Mail_Storage::FLAG_DELETED, '\Draft' => \Zend_Mail_Storage::FLAG_DRAFT, '\Flagged' => \Zend_Mail_Storage::FLAG_FLAGGED)

static

imap flags to constants translation

Default value

array('\Passed' => \Zend_Mail_Storage::FLAG_PASSED, '\Answered' => \Zend_Mail_Storage::FLAG_ANSWERED, '\Seen' => \Zend_Mail_Storage::FLAG_SEEN, '\Deleted' => \Zend_Mail_Storage::FLAG_DELETED, '\Draft' => \Zend_Mail_Storage::FLAG_DRAFT, '\Flagged' => \Zend_Mail_Storage::FLAG_FLAGGED)

Details

Type: array

null|\Zend_Mail_Protocol_Imap $_protocol

protocol handler

Details

Type: null | \Zend_Mail_Protocol_Imap

array $_searchFlags = array('\Recent' => 'RECENT', '\Answered' => 'ANSWERED', '\Seen' => 'SEEN', '\Deleted' => 'DELETED', '\Draft' => 'DRAFT', '\Flagged' => 'FLAGGED')

static

map flags to search criterias

Default value

array('\Recent' => 'RECENT', '\Answered' => 'ANSWERED', '\Seen' => 'SEEN', '\Deleted' => 'DELETED', '\Draft' => 'DRAFT', '\Flagged' => 'FLAGGED')

Details

Type: array

Methods

__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

appendMessage( $message, $folder = null, $flags = null) : void

Parameters

Name	Type	Description
$message
$folder
$flags

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

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

countMessages( $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

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

getCurrentFolder() : \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

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

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

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

getRawContent( $id, $part = null) : void

Parameters

Name	Type	Description
$id
$part

getRawHeader( $id, $part = null, $topLines = 0) : void

Parameters

Name	Type	Description
$id
$part
$topLines

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

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

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

noop() : null

Keep the server busy.

Returns

Type	Description
null

Throws

Exception	Description
\Zend_Mail_Storage_Exception

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

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

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

selectFolder(\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

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

Mail/Storage/Imap.php

\Zend_Mail_Storage_Imapjump to top

Properties

Methods

\Zend_Mail_Storage_Imap
jump to top