Mail_IMAP
[ class tree: Mail_IMAP ] [ index: Mail_IMAP ] [ all elements ]

Element index for package Mail_IMAP

[ a ] [ c ] [ d ] [ e ] [ g ] [ h ] [ i ] [ m ] [ o ] [ r ] [ s ] [ u ]

a

$attachFname
in file IMAP.php, variable Mail_IMAP::$attachFname
    (str) Attachment original file name (if any, if not file name is empty string).
$attachFsize
in file IMAP.php, variable Mail_IMAP::$attachFsize
    (int) Attachment file size in bytes.
$attachFtype
in file IMAP.php, variable Mail_IMAP::$attachFtype
    (str) Attachment MIME type.
$attachHasAttach
in file IMAP.php, variable Mail_IMAP::$attachHasAttach
    (bool) Attachment has attachments?
$attachPid
in file IMAP.php, variable Mail_IMAP::$attachPid
    (str) Attachment part id.
alerts
in file IMAP.php, method Mail_IMAP::alerts()
    Wrapper function for imap_alerts. Implodes the array returned by imap_alerts, (if any) and returns the text.
top

c

close
in file IMAP.php, method Mail_IMAP::close()
    Wrapper method for imap_close. Close the IMAP resource stream.
connect
in file IMAP.php, method Mail_IMAP::connect()
    Wrapper method for imap_open. Accepts a URI abstraction in the following format: imap://user:pass@mail.example.com:143/INBOX#notls instead of the standard connection arguments used in imap_open.
convertBytes
in file IMAP.php, method Mail_IMAP::convertBytes()
    Converts an integer containing the number of bytes in a file to one of Bytes, Kilobytes, Megabytes, or Gigabytes, appending the unit of measurement.
top

d

$defaultPid
in file IMAP.php, variable Mail_IMAP::$defaultPid
    (str) contains the default PID.
debug
in file IMAP.php, method Mail_IMAP::debug()
    Dumps various information about a message for debugging. Mail_IMAP::debug is called automatically from Mail_IMAP::connect if $_GET['dump_mid'] isset and MAIL_IMAP_ERROR_REPORTING == E_ALL || MAIL_IMAP_E_DEBUG.
delete
in file IMAP.php, method Mail_IMAP::delete()
    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.
dump
in file IMAP.php, method Mail_IMAP::dump()
    Calls on var_dump and outputs with HTML
top

e

errors
in file IMAP.php, method Mail_IMAP::errors()
    Wrapper function for imap_errors. Implodes the array returned by imap_errors, (if any) and returns the error text.
expunge
in file IMAP.php, method Mail_IMAP::expunge()
    Wrapper function for imap_expunge. Expunges messages marked for deletion.
extractMIME
in file IMAP.php, method Mail_IMAP::extractMIME()
    Searches all message parts for the specified MIME type. Use getBody with $action option MAIL_IMAP_LITERAL_DECODE to view MIME type parts retrieved.
top

g

getBody
in file IMAP.php, method Mail_IMAP::getBody()
    Searches parts array set in Mail_IMAP::_declareParts() for a displayable message.
getDefaultPid
in file IMAP.php, method Mail_IMAP::getDefaultPid()
    Searches structure defined in Mail_IMAP::_declareParts for the top-level default message.
getHeaders
in file IMAP.php, method Mail_IMAP::getHeaders()
    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.
getMailboxes
in file IMAP.php, method Mail_IMAP::getMailboxes()
    Wrapper method for imap_list. Calling on this function will return a list of mailboxes.
getMailboxInfo
in file IMAP.php, method Mail_IMAP::getMailboxInfo()
    Adds to the $mailboxInfo member variable information about the current mailbox from imap_mailboxmsginfo.
getParts
in file IMAP.php, method Mail_IMAP::getParts()
    sets up member variables containing inline parts and attachments for a specific part in member variable arrays beginning with 'in' and 'attach'.
getQuota
in file IMAP.php, method Mail_IMAP::getQuota()
    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
in file IMAP.php, method Mail_IMAP::getRawHeaders()
    Set member variable $rawHeaders to contain Raw Header information for a part. Returns default header part id on success, returns FALSE on failure.
getRawMessage
in file IMAP.php, method Mail_IMAP::getRawMessage()
    Returns entire unparsed message body. See imap_body for options.
top

h

$header
in file IMAP.php, variable Mail_IMAP::$header
    (array)(mixed) Associative array containing information gathered by imap_headerinfo or imap_rfc822_parse_headers.
top

i

$inFname
in file IMAP.php, variable Mail_IMAP::$inFname
    (int) Inline file name of the part, if any.
$inFsize
in file IMAP.php, variable Mail_IMAP::$inFsize
    (int) Inline file size of the part in bytes.
$inFtype
in file IMAP.php, variable Mail_IMAP::$inFtype
    (str) Inline part MIME type.
$inHasAttach
in file IMAP.php, variable Mail_IMAP::$inHasAttach
    (bool) Inline part has attachments?
$inInlineId
in file IMAP.php, variable Mail_IMAP::$inInlineId
    (str) Inline CID for multipart/related.
$inPid
in file IMAP.php, variable Mail_IMAP::$inPid
    (str) Inline part id.
IMAP.connection_wizard_example.php
procedural page IMAP.connection_wizard_example.php
IMAP.connection_wizard.php
procedural page IMAP.connection_wizard.php
IMAP.inbox.php
procedural page IMAP.inbox.php
IMAP.message.php
procedural page IMAP.message.php
IMAP.php
procedural page IMAP.php
top

m

$mailbox
in file IMAP.php, variable Mail_IMAP::$mailbox
    Contains the imap resource stream.
$mailboxInfo
in file IMAP.php, variable Mail_IMAP::$mailboxInfo
    Contains information about the current mailbox.
Mail_IMAP
in file IMAP.php, method Mail_IMAP::Mail_IMAP()
    Constructor. Optionally set the IMAP resource stream.
Mail_IMAP
in file IMAP.php, class Mail_IMAP
    <p>Mail_IMAP provides a simplified backend for working with the c-client (IMAP) extension.
MAIL_IMAP_BODY
in file IMAP.php, constant MAIL_IMAP_BODY
MAIL_IMAP_CLEAR_FLAGS
in file IMAP.php, constant MAIL_IMAP_CLEAR_FLAGS
Mail_IMAP_connection_wizard
in file IMAP.connection_wizard.php, function Mail_IMAP_connection_wizard()
    Attempts to find the appropriate URI for the user based on common configurations and port settings. This function is meant to serve as a utility helper to find the correct URI syntax to pass to connect.
MAIL_IMAP_E_DEBUG
in file IMAP.php, constant MAIL_IMAP_E_DEBUG
MAIL_IMAP_GET_INFO
in file IMAP.php, constant MAIL_IMAP_GET_INFO
MAIL_IMAP_LITERAL
in file IMAP.php, constant MAIL_IMAP_LITERAL
MAIL_IMAP_LITERAL_DECODE
in file IMAP.php, constant MAIL_IMAP_LITERAL_DECODE
MAIL_IMAP_NO_INFO
in file IMAP.php, constant MAIL_IMAP_NO_INFO
MAIL_IMAP_SET_FLAGS
in file IMAP.php, constant MAIL_IMAP_SET_FLAGS
messageCount
in file IMAP.php, method Mail_IMAP::messageCount()
    Wrapper method for imap_num_msg.
top

o

$option
in file IMAP.php, variable Mail_IMAP::$option
    Set flags for various imap_* functions.
top

r

$rawHeaders
in file IMAP.php, variable Mail_IMAP::$rawHeaders
    (str) Contains raw message headers fetched from imap_fetchbody or imap_fetchheader depending on which message part is being retrieved.
top

s

setFlags
in file IMAP.php, method Mail_IMAP::setFlags()
    Wrapper function for imap_setflag_full. Sets various message flags.
setOptions
in file IMAP.php, method Mail_IMAP::setOptions()
    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).
top

u

unsetHeaders
in file IMAP.php, method Mail_IMAP::unsetHeaders()
    Destroys variables set by getHeaders.
unsetParts
in file IMAP.php, method Mail_IMAP::unsetParts()
    Destroys variables set by getParts and _declareParts.
top

Documentation generated on Tue, 29 Jun 2004 02:10:06 -0400 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.