Docs For Class Net_IMAPProtocol

Net_IMAPProtocol (Constructor) [line 123]

Net_IMAPProtocol Net_IMAPProtocol(
)

Constructor

Instantiates a new Net_IMAP object.

Since: 1.0

[ Top ]

cmdAppend [line 1060]

mixed cmdAppend(

$mailbox, 
$msg, [
$flags_list = ''], [
$time = ''])

Send the APPEND Command

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

	`$mailbox`	—
	`$msg`	—
	`$flags_list`	—
	`$time`	—

[ Top ]

cmdAuthenticate [line 423]

array cmdAuthenticate(
string
$uid, string
$pwd, [string
$userMethod = null])

Attempt to authenticate to the iMAP server.

Return: Returns an array containing the response
Since: 1.0
Access: public

Parameters:

string	`$uid`	—	The userid to authenticate as.
string	`$pwd`	—	The password to authenticate with.
string	`$userMethod`	—	The cmdID.

[ Top ]

cmdCapability [line 951]

mixed cmdCapability(
)

Send the CAPABILITY Command

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

[ Top ]

cmdCheck [line 741]

array cmdCheck(
)

Send the CHECK command.

Return: Returns an array containing the response
Since: 1.0
Access: public

[ Top ]

cmdClose [line 1108]

mixed cmdClose(
)

Send the CLOSE command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

[ Top ]

cmdConnect [line 151]

mixed cmdConnect(
[
$host = "localhost"], [
$port = 143])

Attempt to connect to the IMAP server.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

	`$host`	—
	`$port`	—

[ Top ]

cmdCopy [line 1230]

mixed cmdCopy(

$message_set, 
$mailbox)

Send the COPY command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

	`$message_set`	—
	`$mailbox`	—

[ Top ]

cmdCreate [line 821]

array cmdCreate(
string
$mailbox)

Send the CREATE Mailbox Command

Return: Returns an array containing the response
Since: 1.0
Access: public

Parameters:

string $mailbox — The mailbox to create.

[ Top ]

cmdDelete [line 868]

array cmdDelete(
string
$mailbox)

Send the DELETE Mailbox Command

Return: Returns an array containing the response
Since: 1.0
Access: public

Parameters:

string $mailbox — The mailbox name to delete.

[ Top ]

cmdDeleteACL [line 1531]

void cmdDeleteACL(

$mailbox_name, 
$user)

Parameters:

	`$mailbox_name`	—
	`$user`	—

[ Top ]

cmdDeleteAnnotation [line 1671]

void cmdDeleteAnnotation(

$mailbox_name, 
$entry, 
$values)

Parameters:

	`$mailbox_name`	—
	`$entry`	—
	`$values`	—

[ Top ]

cmdExamine [line 792]

array cmdExamine(
string
$mailbox)

Send the EXAMINE Mailbox Command

Return: Returns an array containing the response
Since: 1.0
Access: public

Parameters:

string $mailbox — The mailbox to examine.

[ Top ]

cmdExpunge [line 1126]

mixed cmdExpunge(
)

Send the EXPUNGE command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

[ Top ]

cmdFetch [line 932]

mixed cmdFetch(

$msgset, 
$fetchparam)

Send the FETCH Command

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

	`$msgset`	—
	`$fetchparam`	—

[ Top ]

cmdGetACL [line 1557]

void cmdGetACL(

$mailbox_name)

Parameters:

$mailbox_name —

[ Top ]

cmdGetAnnotation [line 1701]

void cmdGetAnnotation(

$mailbox_name, 
$entries, 
$values)

Parameters:

	`$mailbox_name`	—
	`$entries`	—
	`$values`	—

[ Top ]

cmdGetQuota [line 1388]

void cmdGetQuota(

$mailbox_name)

******************************************************************

** RFC2087 IMAP4 QUOTA extension BEGINS HERE ******************************************************************

Parameters:

$mailbox_name —

[ Top ]

cmdGetQuotaRoot [line 1408]

void cmdGetQuotaRoot(

$mailbox_name)

Parameters:

$mailbox_name —

[ Top ]

cmdList [line 1020]

mixed cmdList(

$mailbox_base, 
$mailbox)

Send the LIST Command

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

	`$mailbox_base`	—
	`$mailbox`	—

[ Top ]

cmdListRights [line 1578]

void cmdListRights(

$mailbox_name, 
$user)

Parameters:

	`$mailbox_name`	—
	`$user`	—

[ Top ]

cmdLogin [line 401]

array cmdLogin(
string
$uid, string
$pwd)

Attempt to login to the iMAP server.

Return: Returns an array containing the response
Since: 1.0
Access: public

Parameters:

string	`$uid`	—	The userid to authenticate as.
string	`$pwd`	—	The password to authenticate with.

[ Top ]

cmdLogout [line 685]

array cmdLogout(
)

Attempt to disconnect from the iMAP server.

Return: Returns an array containing the response
Since: 1.0
Access: public

[ Top ]

cmdLsub [line 1040]

mixed cmdLsub(

$mailbox_base, 
$mailbox)

Send the LSUB Command

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

	`$mailbox_base`	—
	`$mailbox`	—

[ Top ]

cmdMyRights [line 1604]

void cmdMyRights(

$mailbox_name)

Parameters:

$mailbox_name —

[ Top ]

cmdNoop [line 720]

array cmdNoop(
)

Send the NOOP command.

Return: Returns an array containing the response
Since: 1.0
Access: public

[ Top ]

cmdRename [line 844]

array cmdRename(
string
$mailbox, string
$new_mailbox)

Send the RENAME Mailbox Command

Return: Returns an array containing the response
Since: 1.0
Access: public

Parameters:

string	`$mailbox`	—	The old mailbox name.
string	`$new_mailbox`	—	The new (renamed) mailbox name.

[ Top ]

cmdSearch [line 1159]

mixed cmdSearch(

$search_cmd)

Send the SEARCH command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

$search_cmd —

[ Top ]

cmdSelect [line 765]

array cmdSelect(
string
$mailbox)

Send the Select Mailbox Command

Return: Returns an array containing the response
Since: 1.0
Access: public

Parameters:

string $mailbox — The mailbox to select.

[ Top ]

cmdSetACL [line 1511]

void cmdSetACL(

$mailbox_name, 
$user, 
$acl)

******************************************************************

** RFC2086 IMAP4 ACL extension BEGINS HERE ******************************************************************

Parameters:

	`$mailbox_name`	—
	`$user`	—
	`$acl`	—

[ Top ]

cmdSetAnnotation [line 1640]

void cmdSetAnnotation(

$mailbox_name, 
$entry, 
$values)

*****************************************************************************

** draft-daboo-imap-annotatemore-05 IMAP4 ANNOTATEMORE extension BEGINS HERE ******************************************************************************

Parameters:

	`$mailbox_name`	—
	`$entry`	—
	`$values`	—

[ Top ]

cmdSetQuota [line 1429]

void cmdSetQuota(

$mailbox_name, [
$storageQuota = null], [
$messagesQuota = null])

Parameters:

	`$mailbox_name`	—
	`$storageQuota`	—
	`$messagesQuota`	—

[ Top ]

cmdSetQuotaRoot [line 1464]

void cmdSetQuotaRoot(

$mailbox_name, [
$storageQuota = null], [
$messagesQuota = null])

Parameters:

	`$mailbox_name`	—
	`$storageQuota`	—
	`$messagesQuota`	—

[ Top ]

cmdStatus [line 990]

array cmdStatus(
string
$mailbox, string
$request)

Send the STATUS Mailbox Command

Return: Returns a Parsed Response
Since: 1.0
Access: public

Parameters:

string	`$mailbox`	—	the mailbox name
string	`$request`	—	the request status it could be: MESSAGES \| RECENT \| UIDNEXT UIDVALIDITY \| UNSEEN

[ Top ]

cmdStore [line 1198]

mixed cmdStore(
string
$message_set, 
$dataitem, string
$value, string
$dataitem:)

Send the STORE command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

string	`$message_set`	—	the sessage_set
string	`$dataitem:`	—	the way we store the flags FLAGS: replace the flags whith $value FLAGS.SILENT: replace the flags whith $value but don't return untagged responses +FLAGS: Add the flags whith $value +FLAGS.SILENT: Add the flags whith $value but don't return untagged responses -FLAGS: Remove the flags whith $value -FLAGS.SILENT: Remove the flags whith $value but don't return untagged responses
string	`$value`	—
	`$dataitem`	—

[ Top ]

cmdSubscribe [line 890]

array cmdSubscribe(
string
$mailbox)

Send the SUSCRIBE Mailbox Command

Return: Returns an array containing the response
Since: 1.0
Access: public

Parameters:

string $mailbox — The mailbox name to suscribe.

[ Top ]

cmdUidCopy [line 1260]

void cmdUidCopy(

$message_set, 
$mailbox)

Parameters:

	`$message_set`	—
	`$mailbox`	—

[ Top ]

cmdUidFetch [line 1248]

void cmdUidFetch(

$msgset, 
$fetchparam)

Parameters:

	`$msgset`	—
	`$fetchparam`	—

[ Top ]

cmdUidSearch [line 1328]

mixed cmdUidSearch(

$search_cmd)

Send the SEARCH command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

$search_cmd —

[ Top ]

cmdUidStore [line 1294]

mixed cmdUidStore(
string
$message_set, 
$dataitem, string
$value, string
$dataitem:)

Send the UID STORE command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

string	`$message_set`	—	the sessage_set
string	`$dataitem:`	—	the way we store the flags FLAGS: replace the flags whith $value FLAGS.SILENT: replace the flags whith $value but don't return untagged responses +FLAGS: Add the flags whith $value +FLAGS.SILENT: Add the flags whith $value but don't return untagged responses -FLAGS: Remove the flags whith $value -FLAGS.SILENT: Remove the flags whith $value but don't return untagged responses
string	`$value`	—
	`$dataitem`	—

[ Top ]

cmdUnsubscribe [line 911]

mixed cmdUnsubscribe(

$mailbox)

Send the UNSUSCRIBE Mailbox Command

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

$mailbox —

[ Top ]

cmdX [line 1356]

mixed cmdX(

$atom, 
$parameters)

Send the X command.

Return: Returns a PEAR_Error with an error message on any kind of failure, or true on success.
Since: 1.0
Access: public

Parameters:

	`$atom`	—
	`$parameters`	—

[ Top ]

getCurrentMailbox [line 207]

string getCurrentMailbox(
)

get current mailbox name

Return: Returns the current mailbox
Since: 1.0
Access: public

[ Top ]

getDebugDialog [line 230]

void getDebugDialog(
)

[ Top ]

getLastCmdId [line 191]

string getLastCmdId(
)

get the last cmd ID

Return: Returns the last cmdId
Since: 1.0
Access: public

[ Top ]

getServerAuthMethods [line 1770]

true getServerAuthMethods(
)

tell if the server has capability $capability

Return: or false
Since: 1.0
Access: public

[ Top ]

getUnparsedResponse [line 361]

boolean getUnparsedResponse(
)

get the "returning of the unparsed response" feature status

Return: return if the unparsed response is returned or not
Since: 1.0
Access: public

[ Top ]

hasAclSupport [line 1833]

true hasAclSupport(
)

tell if the server has Quota support

Return: or false
Since: 1.0
Access: public

[ Top ]

hasAnnotateMoreSupport [line 1850]

true hasAnnotateMoreSupport(
)

tell if the server has support for the ANNOTATEMORE extension

Return: or false
Since: 1.0
Access: public

[ Top ]

hasCapability [line 1793]

true hasCapability(

$capability)

tell if the server has capability $capability

Return: or false
Since: 1.0
Access: public

Parameters:

$capability —

[ Top ]

hasQuotaSupport [line 1816]

true hasQuotaSupport(
)

tell if the server has Quota support

Return: or false
Since: 1.0
Access: public

[ Top ]

setDebug [line 224]

nothing setDebug(
[boolean
$debug = true])

Sets the debuging information on or off

Since: 1.0
Access: public

Parameters:

boolean $debug — True or false

[ Top ]

setUnparsedResponse [line 380]

nothing setUnparsedResponse(

$status, boolean
$status:)

set the "returning of the unparsed response" feature on or off

Since: 1.0
Access: public

Parameters:

boolean	`$status:`	—	true: feature is on
	`$status`	—

[ Top ]

utf_7_decode [line 2984]

void utf_7_decode(

$str)

Parameters:

$str —

[ Top ]

utf_7_encode [line 2940]

void utf_7_encode(

$str)

Parameters:

$str —

[ Top ]

Class: Net_IMAPProtocol

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$currentMailbox = "INBOX"

$dbgDialog = ''

$supportedAuthMethods = array('DIGEST-MD5', 'CRAM-MD5', 'LOGIN')

$supportedSASLAuthMethods = array('DIGEST-MD5', 'CRAM-MD5')

Method Detail

Net_IMAPProtocol (Constructor) [line 123]

cmdAppend [line 1060]

Parameters:

cmdAuthenticate [line 423]

Parameters:

cmdCapability [line 951]

cmdCheck [line 741]

cmdClose [line 1108]

cmdConnect [line 151]

Parameters:

cmdCopy [line 1230]

Parameters:

cmdCreate [line 821]

Parameters:

cmdDelete [line 868]

Parameters:

cmdDeleteACL [line 1531]

Parameters:

cmdDeleteAnnotation [line 1671]

Parameters:

cmdExamine [line 792]

Parameters:

cmdExpunge [line 1126]

cmdFetch [line 932]

Parameters:

cmdGetACL [line 1557]

Parameters:

cmdGetAnnotation [line 1701]

Parameters:

cmdGetQuota [line 1388]

Parameters:

cmdGetQuotaRoot [line 1408]

Parameters:

cmdList [line 1020]

Parameters:

cmdListRights [line 1578]

Parameters:

cmdLogin [line 401]

Parameters:

cmdLogout [line 685]

cmdLsub [line 1040]

Parameters:

cmdMyRights [line 1604]

Parameters:

cmdNoop [line 720]

cmdRename [line 844]

Parameters:

cmdSearch [line 1159]

Parameters:

cmdSelect [line 765]

Parameters:

cmdSetACL [line 1511]

Parameters:

cmdSetAnnotation [line 1640]

Parameters:

cmdSetQuota [line 1429]

Parameters:

cmdSetQuotaRoot [line 1464]

Parameters:

cmdStatus [line 990]

Parameters:

cmdStore [line 1198]

Parameters:

cmdSubscribe [line 890]

Parameters: