Docs For Class Net_IMAPProtocol

Methods

Constructor Net_IMAPProtocol [line 123]

Net_IMAPProtocol Net_IMAPProtocol(
)

Constructor

Instantiates a new Net_IMAP object.

Information Tags:

Since:

1.0

[ Top ]

cmdAppend [line 1073]

mixed cmdAppend(

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

Send the APPEND Command

Parameters:

	$mailbox:
	$msg:
	$flags_list:
	$time:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdAuthenticate [line 423]

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

Attempt to authenticate to the iMAP server.

Parameters:

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

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdCapability [line 939]

mixed cmdCapability(
)

Send the CAPABILITY Command

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdCheck [line 737]

array cmdCheck(
)

Send the CHECK command.

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdClose [line 1124]

mixed cmdClose(
)

Send the CLOSE command.

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdConnect [line 151]

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

Attempt to connect to the IMAP server.

Parameters:

	$host:
	$port:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdCopy [line 1246]

mixed cmdCopy(

$message_set, 
$mailbox 
)

Send the COPY command.

Parameters:

	$message_set:
	$mailbox:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdCreate [line 818]

array cmdCreate(
string
$mailbox, [array
$options = null] 
)

Send the CREATE Mailbox Command

Parameters:

string	$mailbox:	The mailbox to create.
array	$options:	options to pass to create

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdDelete [line 856]

array cmdDelete(
string
$mailbox 
)

Send the DELETE Mailbox Command

Parameters:

string

$mailbox:

The mailbox name to delete.

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdDeleteACL [line 1591]

void cmdDeleteACL(

$mailbox_name, 
$user 
)

Parameters:

	$mailbox_name:
	$user:

[ Top ]

cmdDeleteAnnotation [line 1720]

void cmdDeleteAnnotation(

$mailbox_name, 
$entry, 
$values 
)

Parameters:

	$mailbox_name:
	$entry:
	$values:

[ Top ]

cmdExamine [line 788]

array cmdExamine(
string
$mailbox 
)

Send the EXAMINE Mailbox Command

Parameters:

string

$mailbox:

The mailbox to examine.

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdExpunge [line 1142]

mixed cmdExpunge(
)

Send the EXPUNGE command.

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdFetch [line 920]

mixed cmdFetch(

$msgset, 
$fetchparam 
)

Send the FETCH Command

Parameters:

	$msgset:
	$fetchparam:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdGetACL [line 1610]

void cmdGetACL(

$mailbox_name 
)

Parameters:

$mailbox_name:

[ Top ]

cmdGetAnnotation [line 1750]

void cmdGetAnnotation(

$mailbox_name, 
$entries, 
$values 
)

Parameters:

	$mailbox_name:
	$entries:
	$values:

[ Top ]

cmdGetQuota [line 1412]

mixed cmdGetQuota(
string
$mailbox_name 
)

Send the GETQUOTA command.

Parameters:

string

$mailbox_name:

the mailbox name to query for quota data

API Tags:

Return:	Returns a PEAR_Error with an error message on any kind of failure, or quota data on success
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdGetQuotaRoot [line 1440]

mixed cmdGetQuotaRoot(
string
$mailbox_name 
)

Send the GETQUOTAROOT command.

Parameters:

string

$mailbox_name:

the mailbox name to query for quota data

API Tags:

Return:	Returns a PEAR_Error with an error message on any kind of failure, or quota data on success
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdList [line 1033]

mixed cmdList(

$mailbox_base, 
$mailbox 
)

Send the LIST Command

Parameters:

	$mailbox_base:
	$mailbox:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdListRights [line 1631]

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.

Parameters:

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

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdLogout [line 685]

array cmdLogout(
)

Attempt to disconnect from the iMAP server.

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdLsub [line 1053]

mixed cmdLsub(

$mailbox_base, 
$mailbox 
)

Send the LSUB Command

Parameters:

	$mailbox_base:
	$mailbox:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdMyRights [line 1653]

void cmdMyRights(

$mailbox_name 
)

Parameters:

$mailbox_name:

[ Top ]

cmdNamespace [line 965]

mixed cmdNamespace(
)

Send the CAPABILITY Command

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdNoop [line 716]

array cmdNoop(
)

Send the NOOP command.

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdRename [line 838]

array cmdRename(
string
$mailbox, string
$new_mailbox, [array
$options = null] 
)

Send the RENAME Mailbox Command

Parameters:

string	$mailbox:	The old mailbox name.
string	$new_mailbox:	The new (renamed) mailbox name.
array	$options:	options to pass to create

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdSearch [line 1175]

mixed cmdSearch(

$search_cmd 
)

Send the SEARCH command.

Parameters:

$search_cmd:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdSelect [line 761]

array cmdSelect(
string
$mailbox 
)

Send the Select Mailbox Command

Parameters:

string

$mailbox:

The mailbox to select.

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdSetACL [line 1571]

void cmdSetACL(

$mailbox_name, 
$user, 
$acl 
)

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

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

Parameters:

	$mailbox_name:
	$user:
	$acl:

[ Top ]

cmdSetAnnotation [line 1689]

void cmdSetAnnotation(

$mailbox_name, 
$entry, 
$values 
)

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

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

Parameters:

	$mailbox_name:
	$entry:
	$values:

[ Top ]

cmdSetQuota [line 1471]

mixed cmdSetQuota(
string
$mailbox_name, [string
$storageQuota = null], [string
$messagesQuota = null] 
)

Send the SETQUOTA command.

Parameters:

string	$mailbox_name:	the mailbox name to query for quota data
string	$storageQuota:	sets the max number of bytes this mailbox can handle
string	$messagesQuota:	sets the max number of messages this mailbox can handle

API Tags:

Return:	Returns a PEAR_Error with an error message on any kind of failure, or quota data on success
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdSetQuotaRoot [line 1523]

mixed cmdSetQuotaRoot(
string
$mailbox_name, [string
$storageQuota = null], [string
$messagesQuota = null] 
)

Send the SETQUOTAROOT command.

Parameters:

string	$mailbox_name:	the mailbox name to query for quota data
string	$storageQuota:	sets the max number of bytes this mailbox can handle
string	$messagesQuota:	sets the max number of messages this mailbox can handle

API Tags:

Return:	Returns a PEAR_Error with an error message on any kind of failure, or quota data on success
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdStartTLS [line 3164]

mixed cmdStartTLS(
)

Return true if the TLS negotiation was successful

API Tags:

Return:	true on success, PEAR_Error on failure
Access:	public

[ Top ]

cmdStatus [line 992]

array cmdStatus(
string
$mailbox, mixed
$request 
)

Send the STATUS Mailbox Command

Parameters:

string	$mailbox:	the mailbox name
mixed	$request:	the request status it could be an array or space separated string of MESSAGES \| RECENT \| UIDNEXT UIDVALIDITY \| UNSEEN

API Tags:

Return:	Returns a Parsed Response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdStore [line 1214]

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

Send the STORE command.

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:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdSubscribe [line 878]

array cmdSubscribe(
string
$mailbox 
)

Send the SUSCRIBE Mailbox Command

Parameters:

string

$mailbox:

The mailbox name to suscribe.

API Tags:

Return:	Returns an array containing the response
Access:	public

Information Tags:

Since:

1.0

[ Top ]

cmdUidCopy [line 1276]

void cmdUidCopy(

$message_set, 
$mailbox 
)

Parameters:

	$message_set:
	$mailbox:

[ Top ]

cmdUidFetch [line 1264]

void cmdUidFetch(

$msgset, 
$fetchparam 
)

Parameters:

	$msgset:
	$fetchparam:

[ Top ]

cmdUidSearch [line 1344]

mixed cmdUidSearch(

$search_cmd 
)

Send the SEARCH command.

Parameters:

$search_cmd:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdUidStore [line 1310]

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

Send the UID STORE command.

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:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdUnsubscribe [line 899]

mixed cmdUnsubscribe(

$mailbox 
)

Send the UNSUSCRIBE Mailbox Command

Parameters:

$mailbox:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

cmdX [line 1372]

mixed cmdX(

$atom, 
$parameters 
)

Send the X command.

Parameters:

	$atom:
	$parameters:

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

getCurrentMailbox [line 207]

string getCurrentMailbox(
)

get current mailbox name

API Tags:

Return:	Returns the current mailbox
Access:	public

Information Tags:

Since:

1.0

[ Top ]

getDebugDialog [line 230]

void getDebugDialog(
)

[ Top ]

getLastCmdId [line 191]

string getLastCmdId(
)

get the last cmd ID

API Tags:

Return:	Returns the last cmdId
Access:	public

Information Tags:

Since:

1.0

[ Top ]

getServerAuthMethods [line 1819]

true getServerAuthMethods(
)

tell if the server has capability $capability

API Tags:

Return:	or false
Access:	public

Information Tags:

Since:

1.0

[ Top ]

getUnparsedResponse [line 361]

boolean getUnparsedResponse(
)

get the "returning of the unparsed response" feature status

API Tags:

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

Information Tags:

Since:

1.0

[ Top ]

hasAclSupport [line 1882]

true hasAclSupport(
)

tell if the server has Quota support

API Tags:

Return:	or false
Access:	public

Information Tags:

Since:

1.0

[ Top ]

hasAnnotateMoreSupport [line 1899]

true hasAnnotateMoreSupport(
)

tell if the server has support for the ANNOTATEMORE extension

API Tags:

Return:	or false
Access:	public

Information Tags:

Since:

1.0

[ Top ]

hasCapability [line 1842]

true hasCapability(

$capability 
)

tell if the server has capability $capability

Parameters:

$capability:

API Tags:

Return:	or false
Access:	public

Information Tags:

Since:

1.0

[ Top ]

hasQuotaSupport [line 1865]

true hasQuotaSupport(
)

tell if the server has Quota support

API Tags:

Return:	or false
Access:	public

Information Tags:

Since:

1.0

[ Top ]

setDebug [line 224]

nothing setDebug(
[boolean
$debug = true] 
)

Sets the debuging information on or off

Parameters:

boolean

$debug:

True or false

API Tags:

Access:

public

Information Tags:

Since:

1.0

[ Top ]

setUnparsedResponse [line 380]

nothing setUnparsedResponse(

$status, boolean
$status: 
)

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

Parameters:

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

API Tags:

Access:

public

Information Tags:

Since:

1.0

[ Top ]

utf_7_decode [line 3090]

void utf_7_decode(

$str 
)

Parameters:

$str:

[ Top ]

utf_7_encode [line 3043]

void utf_7_encode(

$str 
)

Parameters:

$str:

[ Top ]

_authCRAM_MD5 [line 534]

void _authCRAM_MD5(

$uid, 
$pwd, 
$cmdid 
)

Parameters:

	$uid:
	$pwd:
	$cmdid:

[ Top ]

_authDigest_MD5 [line 477]

void _authDigest_MD5(

$uid, 
$pwd, 
$cmdid 
)

Parameters:

	$uid:
	$pwd:
	$cmdid:

[ Top ]

_authLOGIN [line 584]

void _authLOGIN(

$uid, 
$pwd, 
$cmdid 
)

Parameters:

	$uid:
	$pwd:
	$cmdid:

[ Top ]

_createQuotedString [line 1906]

void _createQuotedString(

$mailbox 
)

Parameters:

$mailbox:

[ Top ]

_genericCommand [line 3030]

void _genericCommand(

$command, [
$params = ''] 
)

Parameters:

	$command:
	$params:

[ Top ]

_genericImapResponseParser [line 2923]

void _genericImapResponseParser(

&$str, [
$cmdid = null] 
)

Parameters:

	&$str:
	$cmdid:

[ Top ]

_getEXTarray [line 2478]

void _getEXTarray(

&$str, [
$startDelim = '('], [
$stopDelim = ')'] 
)

Parameters:

	&$str:
	$startDelim:
	$stopDelim:

[ Top ]

_getLineLength [line 3187]

void _getLineLength(

$string 
)

Parameters:

$string:

[ Top ]

_getSubstr [line 3196]

void _getSubstr(

$string, 
$start, [
$length = false] 
)

Parameters:

	$string:
	$start:
	$length:

[ Top ]

_parseSpace [line 2888]

void _parseSpace(

&$str, 
$line, 
$file, [
$printError = true] 
)

Parameters:

	&$str:
	$line:
	$file:
	$printError:

[ Top ]

_parseString [line 2906]

void _parseString(

&$str, 
$char, 
$line, 
$file 
)

Parameters:

	&$str:
	$char:
	$line:
	$file:

[ Top ]

_retrParsedResponse [line 2513]

void _retrParsedResponse(

&$str, 
$token, [
$previousToken = null] 
)

Parameters:

	&$str:
	$token:
	$previousToken:

[ Top ]

	Net_IMAP-Protocol

[ class tree: Net_IMAP-Protocol ] [ index: Net_IMAP-Protocol ] [ all elements ]

Class: Net_IMAPProtocol

Class Net_IMAPProtocol