|[ class tree: Mail_IMAPv2 ] [ index: Mail_IMAPv2 ] [ all elements ]|
$header = array()
[line 189](array)(mixed) Associative array containing information gathered by imap_headerinfo or imap_rfc822_parse_headers.
[line 132]Contains the imap resource stream.
$mailboxInfo = array()
[line 142]Contains information about the current mailbox.
$msg = array()
[line 177]Contains various information about a message, separates inline parts from attachments and contains the default part id for each message.
$option = array()
[line 156]Set flags for various imap_* functions.
Use associative indices to indicate the imap_* function to set flags for, create the indice omitting the 'imap_' portion of the function name. see: setOptions for more information.
$structure = array()
[line 167]Contains various information returned by imap_fetchstructure.
The object returned by imap_fetchstructure stored in $this->structure[$mid]['obj'].
Mail_IMAPv2 (Constructor) [line 263]
Constructor. Optionally set the IMAP resource stream.
If IMAP connection arguments are not supplied, returns null. Accepts a URI abstraction of the standard imap_open connection argument (see connect) or the imap resource indicator.
Since Mail_IMAPv2 0.1.0 creates an instance of PEAR_ErrorStack. $options argument became $get_info argument see connect.
alerts [line 1840]
Wrapper function for imap_alerts. Implodes the array returned by imap_alerts, (if any) and returns the text.
close [line 465]
Wrapper method for imap_close. Close the IMAP resource stream.
connect [line 321]
Wrapper method for imap_open. Accepts a URI abstraction in the following format: imap://user:email@example.com:143/INBOX#notls instead of the standard connection arguments used in imap_open.
Replace the protocol with one of pop3|pop3s imap|imaps nntp|nntps. Place intial folder in the file path portion, and optionally append tls|notls|novalidate-cert in the anchor portion of the URL. A port number is optional, however, leaving it off could lead to a serious degradation in preformance.
Since Mail_IMAPv2 0.1.0 the $options argument became the $get_info argument. constants for action were removed and the argument is now a BOOL toggle.
convertBytes [line 1697]
Converts an integer containing the number of bytes in a file to one of Bytes, Kilobytes, Megabytes, or Gigabytes, appending the unit of measurement.
This method may be called statically.
delete [line 1731]
Wrapper function for imap_delete. Sets the marked for deletion flag. Note: POP3 mailboxes do not remember flag settings between connections, for POP3 mailboxes this function should be used in addtion to expunge.
errors [line 1803]
Wrapper function for imap_errors. Implodes the array returned by imap_errors, (if any) and returns the error text.
errorTemplate [line 286]
expunge [line 1776]
Wrapper function for imap_expunge. Expunges messages marked for deletion.
extractMIME [line 1346]
Searches all message parts for the specified MIME type. Use getBody with $action option Mail_IMAPv2_LITERAL_DECODE to view MIME type parts retrieved.
If you need to access the MIME type with filename use normal getBody with no action specified.
Returns an array of part ids on success. Returns false if MIME couldn't be found, or on failure.
getBody [line 1081]
Searches parts array set in $this->_declareParts() for a displayable message.
If the part id passed is message/rfc822 looks in subparts for a displayable body. Attempts to return a text/html inline message part by default. And will automatically attempt to find a text/plain part if a text/html part could not be found.
Returns an array containing three associative indices; 'ftype', 'fname' and 'message'. 'ftype' contains the MIME type of the message, 'fname', the original file name, if any, empty string otherwise. And 'message', which contains the message body itself which is returned decoded from base64 or quoted-printable if either of those encoding types are specified, returns untouched otherwise. Returns false on failure.
getHeaders [line 1472]
Set member variable containing header information. Creates an array containing associative indices referring to various header information. Use http://www.php.net/var_dump or http://www.php.net/print_r on the $header member variable to view information gathered by this function.
If $ret is true, returns array containing header information on success and false on failure.
If $ret is false, adds the header information to the $header member variable and returns BOOL.
getMailboxes [line 2007]
Wrapper method for imap_list. Calling on this function will return a list of mailboxes.
This method receives the host argument automatically via $this->connect in the $this->mailboxInfo['host'] variable if a connection URI is used.
getMailboxInfo [line 395]
getParts [line 689]
sets up member variables containing inline parts and attachments for a specific
part in member variable arrays beginning with 'in' and 'attach'. If inline parts are present, sets $inPid, $inFtype, $inFsize, $inHasAttach, $inInlineId (if an inline CID is specified). If attachments are present, sets, $attachPid, $attachFsize, $attachHasAttach, $attachFname (if a filename is present, empty string otherwise).
getQuota [line 1876]
Retreives information about the current mailbox's quota. Rounds up quota sizes and appends the unit of measurment. Returns information in a multi-dimensional associative array.
getRawHeaders [line 1397]
Set member variable $rawHeaders to contain Raw Header information for a part. Returns default header part id on success, returns false on failure.
getRawMessage [line 1033]
Returns entire unparsed message body. See imap_body for options.
getRelatedParts [line 908]
Looks to see if this part has any inline parts associated with it.
It looks up the message tree for parts with CID entries and indexes those entries, whereas an algorithm may be ran to replace inline CIDs with a part viewer.
messageCount [line 479]
Wrapper method for imap_num_msg.
setFlags [line 1938]
Wrapper function for imap_setflag_full. Sets various message flags.
Accepts an array of message ids and an array of flags to be set.
The flags which you can set are "\\Seen", "\\Answered", "\\Flagged", "\\Deleted", and "\\Draft" (as defined by RFC2060).
Warning: POP3 mailboxes do not remember flag settings from connection to connection.
setOptions [line 433]
Set the $option member variable, which is used to specify optional imap_* function arguments (labeled in the manual as flags or options e.g. FT_UID, OP_READONLY, etc).
This results in imap_body, imap_fetchbody and imap_fetchheader being passed the FT_UID option in the flags/options argument where ever these are called on by Mail_IMAPv2.
Note: this method only sets optional imap_* arguments labeled as flags/options.
unsetHeaders [line 1679]
Destroys variables set by getHeaders.
unsetParts [line 995]
Destroys variables set by getParts and _declareParts.
_checkIfParsed [line 638]
Checks if the part has been parsed, if not calls on _declareParts to parse the message.
_declareParts [line 503]
Gather message information returned by imap_fetchstructure and recursively iterate
through each parts array. Concatenate part numbers in the following format `1.1` each part id is separated by a period, each referring to a part or subpart of a multipart message. Create part numbers as such that they are compatible with imap_fetchbody.
Documentation generated on Tue, 12 Oct 2010 13:30:05 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.