phpDocumentor Net_IMAP
[ class tree: Net_IMAP ] [ index: Net_IMAP ] [ all elements ]
Net_IMAP
Packages:
epesi-base
Auth_SASL
crm-mailclient
epesi-applets
epesi-apps
epesi-base-extra
epesi-crm
epesi-CRM
epesi-custom
epesi-data
epesi-develop
epesi-firstrun
epesi-libs
epesi-tests
epesi-tools
epesi-translations
epesi-Utils
epesi-utils
HTML_QuickForm
Mail_Mime
Net_IMAP
Net_IMAP-Protocol
PEAR
PHPMailer
Smarty

Files:
IMAP.php

Classes:
Net_IMAP

Class: Net_IMAP

Source Location: /modules/Apps/MailClient/PEAR/Net/IMAP.php

Class Net_IMAP

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail

Provides an implementation of the IMAP protocol using PEAR's Net_Socket:: class.

Located in /modules/Apps/MailClient/PEAR/Net/IMAP.php [line 30] 

Net_IMAPProtocol
   |
   --Net_IMAP
Author(s): Information Tags:

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From Net_IMAPProtocol

Net_IMAPProtocol::$currentMailbox
Net_IMAPProtocol::$dbgDialog
Net_IMAPProtocol::$supportedAuthMethods
Net_IMAPProtocol::$supportedSASLAuthMethods
Net_IMAPProtocol::$_cmd_counter
Net_IMAPProtocol::$_connected
Net_IMAPProtocol::$_debug
Net_IMAPProtocol::$_lastCmdID
Net_IMAPProtocol::$_serverAuthMethods
Net_IMAPProtocol::$_serverSupportedCapabilities
Net_IMAPProtocol::$_socket
Net_IMAPProtocol::$_unParsedReturn
Net_IMAPProtocol::$_useUTF_7

Inherited From Net_IMAPProtocol

Net_IMAPProtocol::Net_IMAPProtocol()
Constructor
Net_IMAPProtocol::cmdAppend()
Send the APPEND Command
Net_IMAPProtocol::cmdAuthenticate()
Attempt to authenticate to the iMAP server.
Net_IMAPProtocol::cmdCapability()
Send the CAPABILITY Command
Net_IMAPProtocol::cmdCheck()
Send the CHECK command.
Net_IMAPProtocol::cmdClose()
Send the CLOSE command.
Net_IMAPProtocol::cmdConnect()
Attempt to connect to the IMAP server.
Net_IMAPProtocol::cmdCopy()
Send the COPY command.
Net_IMAPProtocol::cmdCreate()
Send the CREATE Mailbox Command
Net_IMAPProtocol::cmdDelete()
Send the DELETE Mailbox Command
Net_IMAPProtocol::cmdDeleteACL()
Net_IMAPProtocol::cmdDeleteAnnotation()
Net_IMAPProtocol::cmdExamine()
Send the EXAMINE Mailbox Command
Net_IMAPProtocol::cmdExpunge()
Send the EXPUNGE command.
Net_IMAPProtocol::cmdFetch()
Send the FETCH Command
Net_IMAPProtocol::cmdGetACL()
Net_IMAPProtocol::cmdGetAnnotation()
Net_IMAPProtocol::cmdGetQuota()
Send the GETQUOTA command.
Net_IMAPProtocol::cmdGetQuotaRoot()
Send the GETQUOTAROOT command.
Net_IMAPProtocol::cmdList()
Send the LIST Command
Net_IMAPProtocol::cmdListRights()
Net_IMAPProtocol::cmdLogin()
Attempt to login to the iMAP server.
Net_IMAPProtocol::cmdLogout()
Attempt to disconnect from the iMAP server.
Net_IMAPProtocol::cmdLsub()
Send the LSUB Command
Net_IMAPProtocol::cmdMyRights()
Net_IMAPProtocol::cmdNamespace()
Send the CAPABILITY Command
Net_IMAPProtocol::cmdNoop()
Send the NOOP command.
Net_IMAPProtocol::cmdRename()
Send the RENAME Mailbox Command
Net_IMAPProtocol::cmdSearch()
Send the SEARCH command.
Net_IMAPProtocol::cmdSelect()
Send the Select Mailbox Command
Net_IMAPProtocol::cmdSetACL()
******************************************************************
Net_IMAPProtocol::cmdSetAnnotation()
*****************************************************************************
Net_IMAPProtocol::cmdSetQuota()
Send the SETQUOTA command.
Net_IMAPProtocol::cmdSetQuotaRoot()
Send the SETQUOTAROOT command.
Net_IMAPProtocol::cmdStartTLS()
Return true if the TLS negotiation was successful
Net_IMAPProtocol::cmdStatus()
Send the STATUS Mailbox Command
Net_IMAPProtocol::cmdStore()
Send the STORE command.
Net_IMAPProtocol::cmdSubscribe()
Send the SUSCRIBE Mailbox Command
Net_IMAPProtocol::cmdUidCopy()
Net_IMAPProtocol::cmdUidFetch()
Net_IMAPProtocol::cmdUidSearch()
Send the SEARCH command.
Net_IMAPProtocol::cmdUidStore()
Send the UID STORE command.
Net_IMAPProtocol::cmdUnsubscribe()
Send the UNSUSCRIBE Mailbox Command
Net_IMAPProtocol::cmdX()
Send the X command.
Net_IMAPProtocol::getCurrentMailbox()
get current mailbox name
Net_IMAPProtocol::getDebugDialog()
Net_IMAPProtocol::getLastCmdId()
get the last cmd ID
Net_IMAPProtocol::getServerAuthMethods()
tell if the server has capability $capability
Net_IMAPProtocol::getUnparsedResponse()
get the "returning of the unparsed response" feature status
Net_IMAPProtocol::hasAclSupport()
tell if the server has Quota support
Net_IMAPProtocol::hasAnnotateMoreSupport()
tell if the server has support for the ANNOTATEMORE extension
Net_IMAPProtocol::hasCapability()
tell if the server has capability $capability
Net_IMAPProtocol::hasQuotaSupport()
tell if the server has Quota support
Net_IMAPProtocol::setDebug()
Sets the debuging information on or off
Net_IMAPProtocol::setUnparsedResponse()
set the "returning of the unparsed response" feature on or off
Net_IMAPProtocol::utf_7_decode()
Net_IMAPProtocol::utf_7_encode()
Net_IMAPProtocol::_authCRAM_MD5()
Net_IMAPProtocol::_authDigest_MD5()
Net_IMAPProtocol::_authLOGIN()
Net_IMAPProtocol::_createQuotedString()
Net_IMAPProtocol::_genericCommand()
Net_IMAPProtocol::_genericImapResponseParser()
Net_IMAPProtocol::_getEXTarray()
Net_IMAPProtocol::_getLineLength()
Net_IMAPProtocol::_getSubstr()
Net_IMAPProtocol::_parseSpace()
Net_IMAPProtocol::_parseString()
Net_IMAPProtocol::_retrParsedResponse()

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Properties | Method Summary | Methods Detail
Net_IMAP   Net_IMAP()   Constructor
mixed   addAnswered()   adds the Answered flag (\Answered) to the selected messages
mixed   addDeleted()   adds the Deleted flag (\Deleted) to the selected messages
mixed   addDraft()   adds the Draft flag (\Draft) to the selected messages
mixed   addFlagged()   adds the Flagged flag (\Flagged) to the selected messages
mixed   addFlags()   adds flags to the selected messages
mixed   addSeen()   adds the Seen flag (\Seen) to the selected messages
mixed   appendMessage()   Appends a mail to a mailbox
true   connect()   Attempt to connect to the IMAP server located at $host $port
mixed   copyMessages()   Copies mail from one folder to another
mixed   createMailbox()   Creates the mailbox $mailbox
mixed   deleteACL()   deletes the ACL on a mailbox
void   deleteAnnotation()  
mixed   deleteMailbox()   Deletes the mailbox $mailbox
void   deleteMessages()  
void   deleteMsg()  
void   disconnect()  
void   examineMailbox()  
void   expunge()   ****************************************************************
string   getACL()   get the Access Control List details
mixed   getACLRights()   returns an array containing the rights that a user logged on has on the mailbox this method can be used by any user, not only the administrator
void   getAnnotation()  
void   getBody()  
void   getBodyPart()  
void   getEnvelope()  
mixed   getFlags()   Lists the flags of the selected messages
string   getHierarchyDelimiter()   Gets the HierachyDelimiter character used to create subfolders cyrus users "." and wu-imapd uses "/"
void   getListing()  
mixed   getMailboxes()   Returns an array containing the names of the selected mailboxes
void   getMailboxSize()  
void   getMessages()  
void   getMessagesList()  
assoc   getMessagesQuota()   Returns MESSAGES quota details
void   getMsg()  
mixed   getMyRights()   returns the rights that the user logged on has on the mailbox this method can be used by any user, not only the administrator
mixed   getNamespace()   Appends a mail to a mailbox
void   getNumberOfMessages()  
void   getNumberOfRecentMessages()  
void   getNumberOfUnSeenMessages()  
void   getParsedHeaders()  
void   getRawHeaders()  
void   getSize()   ***************************************************
void   getStatus()  
assoc   getStorageQuota()   Returns STORAGE quota details
assoc   getStorageQuotaRoot()   Returns STORAGE quota details
void   getStructure()  
void   getSummary()  
void   hasFlag()  
mixed   isAnswered()   check the Answered flag
mixed   isDeleted()   check the Deleted flag
mixed   isDraft()   check the Draft flag
mixed   isFlagged()   check the flagged flag
mixed   isSeen()   check the Seen flag
mixed   listsubscribedMailboxes()   Lists the subscription to mailboxes
true   login()   Attempt to authenticate to the IMAP server.
boolean   mailboxExist()   check if the mailbox name exists
void   numMsg()  
mixed   removeAnswered()   remove the Answered flag (\Answered) from the selected messages
mixed   removeDeleted()   remove the Deleted flag (\Deleted) from the selected messages
mixed   removeDraft()   remove the Draft flag (\Draft) from the selected messages
mixed   removeFlagged()   remove the Flagged flag (\Flagged) from the selected messages
mixed   removeFlags()   remove flags from the selected messages
mixed   removeSeen()   remove the Seen flag (\Seen) from the selected messages
mixed   renameMailbox()   Renames the mailbox $mailbox
void   search()  
void   selectMailbox()  
mixed   setACL()   Set ACL on a mailbox
void   setAnnotation()   ****************************************************************
mixed   setFlags()   Sets the flags of the selected messages
true   setMessagesQuota()   sets MESSAGES quota details
true   setStorageQuota()   sets STORAGE quota details
mixed   subscribeMailbox()   Subscribes to the selected mailbox
mixed   unsubscribeMailbox()   Removes the subscription to a mailbox
void   _getSearchListFromArray()  
void   _parseStructureApplicationArray()  
void   _parseStructureArray()  
void   _parseStructureCommonFields()  
void   _parseStructureImageArray()  
void   _parseStructureMessageArray()  
void   _parseStructureMultipartArray()  
void   _parseStructureTextArray()  

[ Top ]
Properties
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Methods
Class Overview | Inherited Properties and Methods | Properties | Method Summary | Methods Detail
Constructor Net_IMAP  [line 43]

  Net_IMAP Net_IMAP( string 0, int 1, string 2  )

Constructor

Instantiates a new Net_SMTP object, overriding any defaults with parameters that are passed in.

 Parameters:
string   0:  The server to connect to.
int   1:  The port to connect to.
string   2:  The value to give when sending EHLO or HELO.


[ Top ]
addAnswered  [line 1625]

  mixed addAnswered( mixed $msg_id  )

adds the Answered flag (\Answered) to the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
addDeleted  [line 1638]

  mixed addDeleted( mixed $msg_id  )

adds the Deleted flag (\Deleted) to the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
addDraft  [line 1664]

  mixed addDraft( mixed $msg_id  )

adds the Draft flag (\Draft) to the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
addFlagged  [line 1651]

  mixed addFlagged( mixed $msg_id  )

adds the Flagged flag (\Flagged) to the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
addFlags  [line 1599]

  mixed addFlags( mixed $msg_id, mixed $flags  )

adds flags to the selected messages

Parameters:
mixed   $flags:  flags to set (space separated String or array)
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
addSeen  [line 1612]

  mixed addSeen( mixed $msg_id  )

adds the Seen flag (\Seen) to the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
appendMessage  [line 1060]

  mixed appendMessage( string $rfc_message, [string $mailbox = null], [ $flags_list = '']  )

Appends a mail to a mailbox

Parameters:
string   $rfc_message:  the message to append in RFC822 format
string   $mailbox:  mailbox name to append to
   $flags_list: 

API Tags:
Return:  true on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
connect  [line 65]

  true connect( string $host, string $port  )

Attempt to connect to the IMAP server located at $host $port

Parameters:
string   $host:  The IMAP server
string   $port: 

The IMAP port

It is only useful in a very few circunstances because the contructor already makes this job

API Tags:
Return:  on success or PEAR_Error
Access:  public

Information Tags:
Since:  1.0

[ Top ]
copyMessages  [line 1006]

  mixed copyMessages( string $dest_mailbox, [mixed $msg_id = null], [string $source_mailbox = null], [bool $uidCopy = false]  )

Copies mail from one folder to another

Parameters:
string   $dest_mailbox:  mailbox name to copy sessages to
mixed   $msg_id:  the messages that I want to copy (all by default) it also can be an array
string   $source_mailbox:  mailbox name from where the messages are copied
bool   $uidCopy:  msg_id contains UID's instead of Message Sequence Number if set to true

API Tags:
Return:  true on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
createMailbox  [line 1282]

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

Creates the mailbox $mailbox

Parameters:
string   $mailbox:  mailbox name to create
array   $options:  options to pass to create

API Tags:
Return:  true on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
deleteACL  [line 2158]

  mixed deleteACL( string $mailbox_name, string $user  )

deletes the ACL on a mailbox

Parameters:
string   $mailbox_name:  the mailbox
string   $user:  user to set the ACL

API Tags:
Return:  True on success, or PEAR_Error on false
Access:  public

Information Tags:
Since:  1.0

[ Top ]
deleteAnnotation  [line 2288]

  void deleteAnnotation( $entry, $values, [ $mailbox_name = null]  )

Parameters:
   $entry: 
   $values: 
   $mailbox_name: 


[ Top ]
deleteMailbox  [line 1301]

  mixed deleteMailbox( string $mailbox  )

Deletes the mailbox $mailbox

Parameters:
string   $mailbox:  mailbox name to delete

API Tags:
Return:  true on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
deleteMessages  [line 951]

  void deleteMessages( [ $msg_id = null], [ $uidStore = false]  )

Parameters:
   $msg_id: 
   $uidStore: 


[ Top ]
deleteMsg  [line 2424]

  void deleteMsg( $msg_id  )

Parameters:
   $msg_id: 


[ Top ]
disconnect  [line 179]

  void disconnect( [ $expungeOnExit = false]  )

Parameters:
   $expungeOnExit: 


[ Top ]
examineMailbox  [line 229]

  void examineMailbox( $mailbox  )

Parameters:
   $mailbox: 


[ Top ]
expunge  [line 1871]

  void expunge( )

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

* ** * MISC METHODS ** * ** ****************************************************************

[ Top ]
getACL  [line 2098]

  string getACL( [string $mailbox_name = null]  )

get the Access Control List details

Parameters:
string   $mailbox_name:  Mailbox to get ACL info.

API Tags:
Return:  on success or PEAR_Error
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getACLRights  [line 2222]

  mixed getACLRights( $user, [string $mailbox_name = null]  )

returns an array containing the rights that a user logged on has on the mailbox this method can be used by any user, not only the administrator

Parameters:
string   $mailbox_name:  the mailbox to query rights
   $user: 

API Tags:
Return:  string contailing the list of rights on success, or PEAR_Error on failure
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getAnnotation  [line 2308]

  void getAnnotation( $entries, $values, [ $mailbox_name = null]  )

Parameters:
   $entries: 
   $values: 
   $mailbox_name: 


[ Top ]
getBody  [line 412]

  void getBody( $msg_id, [ $uidFetch = false]  )

Parameters:
   $msg_id: 
   $uidFetch: 


[ Top ]
getBodyPart  [line 436]

  void getBodyPart( $msg_id, $partId, [ $uidFetch = false]  )

Parameters:
   $msg_id: 
   $partId: 
   $uidFetch: 


[ Top ]
getEnvelope  [line 828]

  void getEnvelope( [ $mailbox = ''], [ $msg_id = null], [ $uidFetch = false]  )

Parameters:
   $mailbox: 
   $msg_id: 
   $uidFetch: 


[ Top ]
getFlags  [line 1499]

  mixed getFlags( [mixes $msg_id = null]  )

Lists the flags of the selected messages

Parameters:
mixes   $msg_id:  the message list

API Tags:
Return:  array on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
getHierarchyDelimiter  [line 1137]

  string getHierarchyDelimiter( [ $mailbox = '']  )

Gets the HierachyDelimiter character used to create subfolders cyrus users "." and wu-imapd uses "/"

$param string the mailbox to get the hierarchy from

 Parameters:
   $mailbox: 

API Tags:
Return:  the hierarchy delimiter
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getListing  [line 2418]

  void getListing( [ $msg_id = null]  )

Parameters:
   $msg_id: 


[ Top ]
getMailboxes  [line 1181]

  mixed getMailboxes( [ $reference = ''], [string $restriction_search = 0], [string $returnAttributes = false], string $mailbox_base  )

Returns an array containing the names of the selected mailboxes

Parameters:
string   $mailbox_base:  base mailbox to start the search $mailbox_base if $mailbox_base == '' then $mailbox_base is the curent selected mailbox
string   $restriction_search:  false or 0 means return all mailboxes true or 1 return only the mailbox that contains that exact name
string   $returnAttributes:  true means return an assoc array containing mailbox names and mailbox attributes
   $reference: 

API Tags:
Return:  true on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
getMailboxSize  [line 883]

  void getMailboxSize( [ $mailbox = '']  )

Parameters:
   $mailbox: 


[ Top ]
getMessages  [line 669]

  void getMessages( [ $msg_id = null], [ $indexIsMessageNumber = true]  )

Parameters:
   $msg_id: 
   $indexIsMessageNumber: 


[ Top ]
getMessagesList  [line 329]

  void getMessagesList( [ $msg_id = null]  )

Parameters:
   $msg_id: 


[ Top ]
getMessagesQuota  [line 2002]

  assoc getMessagesQuota( [string $mailbox_name = null]  )

Returns MESSAGES quota details

Parameters:
string   $mailbox_name:  Mailbox to get quota info.

API Tags:
Return:  array contaning the quota info on success or PEAR_Error
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getMsg  [line 2405]

  void getMsg( $msg_id  )

Parameters:
   $msg_id: 


[ Top ]
getMyRights  [line 2181]

  mixed getMyRights( [string $mailbox_name = null]  )

returns the rights that the user logged on has on the mailbox this method can be used by any user, not only the administrator

Parameters:
string   $mailbox_name:  the mailbox to query rights

API Tags:
Return:  string contailing the list of rights on success, or PEAR_Error on failure
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getNamespace  [line 1082]

  mixed getNamespace( string $rfc_message, string $mailbox  )

Appends a mail to a mailbox

Parameters:
string   $rfc_message:  the message to append in RFC822 format
string   $mailbox:  mailbox name to append to

API Tags:
Return:  true on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
getNumberOfMessages  [line 717]

  void getNumberOfMessages( [ $mailbox = '']  )

Parameters:
   $mailbox: 


[ Top ]
getNumberOfRecentMessages  [line 772]

  void getNumberOfRecentMessages( [ $mailbox = '']  )

Parameters:
   $mailbox: 


[ Top ]
getNumberOfUnSeenMessages  [line 745]

  void getNumberOfUnSeenMessages( [ $mailbox = '']  )

Parameters:
   $mailbox: 


[ Top ]
getParsedHeaders  [line 292]

  void getParsedHeaders( $msg_id, [ $keysToUpper = false], [ $part_id = ''], [ $uidFetch = false]  )

Parameters:
   $msg_id: 
   $keysToUpper: 
   $part_id: 
   $uidFetch: 


[ Top ]
getRawHeaders  [line 256]

  void getRawHeaders( $msg_id, [ $part_id = ''], [ $uidFetch = false]  )

Parameters:
   $msg_id: 
   $part_id: 
   $uidFetch: 


[ Top ]
getSize  [line 2388]

  void getSize( )

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

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

[ Top ]
getStatus  [line 799]

  void getStatus( [ $mailbox = '']  )

Parameters:
   $mailbox: 


[ Top ]
getStorageQuota  [line 1966]

  assoc getStorageQuota( [string $mailbox_name = null]  )

Returns STORAGE quota details

Parameters:
string   $mailbox_name:  Mailbox to get quota info.

API Tags:
Return:  array contaning the quota info on success or PEAR_Error
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getStorageQuotaRoot  [line 1932]

  assoc getStorageQuotaRoot( [string $mailbox_name = null]  )

Returns STORAGE quota details

Parameters:
string   $mailbox_name:  Mailbox to get quota info.

API Tags:
Return:  array contaning the quota info on success or PEAR_Error
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getStructure  [line 459]

  void getStructure( $msg_id, [ $uidFetch = false]  )

Parameters:
   $msg_id: 
   $uidFetch: 


[ Top ]
getSummary  [line 356]

  void getSummary( [ $msg_id = null], [ $uidFetch = false]  )

Parameters:
   $msg_id: 
   $uidFetch: 


[ Top ]
hasFlag  [line 1836]

  void hasFlag( $message_nro, $flag  )

Parameters:
   $message_nro: 
   $flag: 


[ Top ]
isAnswered  [line 1772]

  mixed isAnswered( mixes $message_nro  )

check the Answered flag

Parameters:
mixes   $message_nro:  the message to check

API Tags:
Return:  true or false if the flag is sert PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
isDeleted  [line 1826]

  mixed isDeleted( mixes $message_nro  )

check the Deleted flag

Parameters:
mixes   $message_nro:  the message to check

API Tags:
Return:  true or false if the flag is sert PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
isDraft  [line 1807]

  mixed isDraft( mixes $message_nro  )

check the Draft flag

Parameters:
mixes   $message_nro:  the message to check

API Tags:
Return:  true or false if the flag is sert PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
isFlagged  [line 1789]

  mixed isFlagged( mixes $message_nro  )

check the flagged flag

Parameters:
mixes   $message_nro:  the message to check

API Tags:
Return:  true or false if the flag is sert PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
isSeen  [line 1756]

  mixed isSeen( mixes $message_nro  )

check the Seen flag

Parameters:
mixes   $message_nro:  the message to check

API Tags:
Return:  true or false if the flag is sert PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
listsubscribedMailboxes  [line 1414]

  mixed listsubscribedMailboxes( [ $reference = ''], [ $restriction_search = 0], [ $returnAttributes = false], string $mailbox_base, string $mailbox_name  )

Lists the subscription to mailboxes

Parameters:
string   $mailbox_base:  mailbox name start the search (see to getMailboxes() )
string   $mailbox_name:  mailbox name filter the search (see to getMailboxes() )
   $reference: 
   $restriction_search: 
   $returnAttributes: 

API Tags:
Return:  true on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
login  [line 120]

  true login( string $user, string $pass, [string $useauthenticate = true], [boolean $selectMailbox = true]  )

Attempt to authenticate to the IMAP server.

Parameters:
string   $user:  The userid to authenticate as.
string   $pass:  The password to authenticate with.
string   $useauthenticate:  true: authenticate using the IMAP AUTHENTICATE command. false: authenticate using the IMAP AUTHENTICATE command. 'string': authenticate using the IMAP AUTHENTICATE command but using the authMethod in 'string'
boolean   $selectMailbox:  automaticaly select inbox on login (false does not)

API Tags:
Return:  on success or PEAR_Error
Access:  public

Information Tags:
Since:  1.0

[ Top ]
mailboxExist  [line 1251]

  boolean mailboxExist( string $mailbox  )

check if the mailbox name exists

Parameters:
string   $mailbox:  mailbox name to check existance

API Tags:
Return:  true on Success/false on Failure

Information Tags:
Since:  1.0

[ Top ]
numMsg  [line 2393]

  void numMsg( [ $mailbox = null]  )

Parameters:
   $mailbox: 


[ Top ]
removeAnswered  [line 1704]

  mixed removeAnswered( mixed $msg_id  )

remove the Answered flag (\Answered) from the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
removeDeleted  [line 1717]

  mixed removeDeleted( mixed $msg_id  )

remove the Deleted flag (\Deleted) from the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
removeDraft  [line 1743]

  mixed removeDraft( mixed $msg_id  )

remove the Draft flag (\Draft) from the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
removeFlagged  [line 1730]

  mixed removeFlagged( mixed $msg_id  )

remove the Flagged flag (\Flagged) from the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
removeFlags  [line 1678]

  mixed removeFlags( mixed $msg_id, mixed $flags  )

remove flags from the selected messages

Parameters:
mixed   $flags:  flags to remove (space separated string or array)
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
removeSeen  [line 1691]

  mixed removeSeen( mixed $msg_id  )

remove the Seen flag (\Seen) from the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all

API Tags:
Return:  true on success/PearError on failure


[ Top ]
renameMailbox  [line 1331]

  mixed renameMailbox( $oldmailbox, $newmailbox, [array $options = null], string $mailbox  )

Renames the mailbox $mailbox

Parameters:
string   $mailbox:  mailbox name to rename
array   $options:  options to pass to rename
   $oldmailbox: 
   $newmailbox: 

API Tags:
Return:  true on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
search  [line 1892]

  void search( $search_list, [ $uidSearch = false]  )

Parameters:
   $search_list: 
   $uidSearch: 


[ Top ]
selectMailbox  [line 208]

  void selectMailbox( $mailbox  )

Parameters:
   $mailbox: 


[ Top ]
setACL  [line 2136]

  mixed setACL( string $mailbox_name, string $user, string $acl  )

Set ACL on a mailbox

Parameters:
string   $mailbox_name:  the mailbox
string   $user:  user to set the ACL
string   $acl:  ACL list

API Tags:
Return:  True on success, or PEAR_Error on false
Access:  public

Information Tags:
Since:  1.0

[ Top ]
setAnnotation  [line 2268]

  void setAnnotation( $entry, $values, [ $mailbox_name = null]  )

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

* ** * ANNOTATEMORE METHODS ** * ** ****************************************************************

 Parameters:
   $entry: 
   $values: 
   $mailbox_name: 


[ Top ]
setFlags  [line 1541]

  mixed setFlags( mixed $msg_id, mixed $flags, [string $mod = 'set'], [$uidStore $uidStore = false]  )

Sets the flags of the selected messages

Parameters:
mixed   $msg_id:  the message list or string "all" for all
mixed   $flags:  flags to set (space separated String or array)
string   $mod:  "set" to set flags (default) "add" to add flags "remove" to remove flags
$uidStore   $uidStore:  bool msg_id contains UID's instead of Message Sequence Number if set to true

API Tags:
Return:  true on success/PearError on failure


[ Top ]
setMessagesQuota  [line 2060]

  true setMessagesQuota( string $mailbox_name, $quota  )

sets MESSAGES quota details

Parameters:
string   $mailbox_name:  Mailbox to get quota info.
   $quota: 

API Tags:
Return:  on success or PEAR_Error
Access:  public

Information Tags:
Since:  1.0

[ Top ]
setStorageQuota  [line 2038]

  true setStorageQuota( string $mailbox_name, $quota  )

sets STORAGE quota details

Parameters:
string   $mailbox_name:  Mailbox to get quota info.
   $quota: 

API Tags:
Return:  on success or PEAR_Error
Access:  public

Information Tags:
Since:  1.0

[ Top ]
subscribeMailbox  [line 1366]

  mixed subscribeMailbox( [string $mailbox = null]  )

Subscribes to the selected mailbox

Parameters:
string   $mailbox:  mailbox name to subscribe

API Tags:
Return:  true on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
unsubscribeMailbox  [line 1390]

  mixed unsubscribeMailbox( [string $mailbox = null]  )

Removes the subscription to a mailbox

Parameters:
string   $mailbox:  mailbox name to unsubscribe

API Tags:
Return:  true on Success/PearError on Failure

Information Tags:
Since:  1.0

[ Top ]
_getSearchListFromArray  [line 2364]

  void _getSearchListFromArray( $arr  )

Parameters:
   $arr: 


[ Top ]
_parseStructureApplicationArray  [line 582]

  void _parseStructureApplicationArray( $_structure, &$_mimeParts, $_partID  )

Parameters:
   $_structure: 
   &$_mimeParts: 
   $_partID: 


[ Top ]
_parseStructureArray  [line 482]

  void _parseStructureArray( $_structure, &$_mimeParts, [ $_partID = '']  )

Parameters:
   $_structure: 
   &$_mimeParts: 
   $_partID: 


[ Top ]
_parseStructureCommonFields  [line 644]

  void _parseStructureCommonFields( &$_structure  )

Parameters:
   &$_structure: 


[ Top ]
_parseStructureImageArray  [line 572]

  void _parseStructureImageArray( $_structure, &$_mimeParts, $_partID  )

Parameters:
   $_structure: 
   &$_mimeParts: 
   $_partID: 


[ Top ]
_parseStructureMessageArray  [line 603]

  void _parseStructureMessageArray( $_structure, &$_mimeParts, $_partID  )

Parameters:
   $_structure: 
   &$_mimeParts: 
   $_partID: 


[ Top ]
_parseStructureMultipartArray  [line 511]

  void _parseStructureMultipartArray( $_structure, &$_mimeParts, $_partID, [ $_parentIsMessage = false]  )

Parameters:
   $_structure: 
   &$_mimeParts: 
   $_partID: 
   $_parentIsMessage: 


[ Top ]
_parseStructureTextArray  [line 622]

  void _parseStructureTextArray( $_structure, &$_mimeParts, $_partID  )

Parameters:
   $_structure: 
   &$_mimeParts: 
   $_partID: 


[ Top ]
Documentation generated on Fri, 26 Dec 2008 21:42:38 -0500 by phpDocumentor 1.4.2