[ ] [ ] [ ]

Packages:
Mail_IMAPv2

Classes:

Mail_IMAPv2
Mail_IMAPv2_Debug
Mail_IMAPv2_ManageMB

Files:

Debug.php
IMAPv2.php
ManageMB.php

Class: Mail_IMAPv2_Debug

Source Location: /Mail_IMAPv2-0.2.1/Mail/IMAPv2/Debug/Debug.php

Class Overview

Mail_IMAPv2
   |
   --Mail_IMAPv2_Debug

This class provides an extension to Mail_IMAPv2 that adds debugging utilities for the base IMAP.php class. The debugging functionality provided by this class is currently accessed by supplying various $_GET method arguments.

Author(s):

Richard York <rich_y at php.net>

Version:

0.1.0 Beta

Copyright:

(c) Copyright 2004-2005, Richard York, All Rights Reserved.

Methods

Inherited Variables

Class: Mail_IMAPv2

Mail_IMAPv2::$error
Mail_IMAPv2::$fields
Mail_IMAPv2::$header
Mail_IMAPv2::$mailbox
Mail_IMAPv2::$mailboxInfo
Mail_IMAPv2::$msg
Mail_IMAPv2::$option
Mail_IMAPv2::$structure

Inherited Methods

Class: Mail_IMAPv2

Mail_IMAPv2::Mail_IMAPv2(): Constructor. Optionally set the IMAP resource stream.
Mail_IMAPv2::alerts(): Wrapper function for imap_alerts. Implodes the array returned by imap_alerts, (if any) and returns the text.
Mail_IMAPv2::close(): Wrapper method for imap_close. Close the IMAP resource stream.
Mail_IMAPv2::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.
Mail_IMAPv2::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.
Mail_IMAPv2::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.
Mail_IMAPv2::errors(): Wrapper function for imap_errors. Implodes the array returned by imap_errors, (if any) and returns the error text.
Mail_IMAPv2::errorTemplate()
Mail_IMAPv2::expunge(): Wrapper function for imap_expunge. Expunges messages marked for deletion.
Mail_IMAPv2::extractMIME(): Searches all message parts for the specified MIME type. Use getBody with $action option Mail_IMAPv2_LITERAL_DECODE to view MIME type parts retrieved.
Mail_IMAPv2::getBody(): Searches parts array set in $this->_declareParts() for a displayable message.
Mail_IMAPv2::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.
Mail_IMAPv2::getMailboxes(): Wrapper method for imap_list. Calling on this function will return a list of mailboxes.
Mail_IMAPv2::getMailboxInfo()
Mail_IMAPv2::getParts(): sets up member variables containing inline parts and attachments for a specific
Mail_IMAPv2::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.
Mail_IMAPv2::getRawHeaders(): Set member variable $rawHeaders to contain Raw Header information for a part. Returns default header part id on success, returns false on failure.
Mail_IMAPv2::getRawMessage(): Returns entire unparsed message body. See imap_body for options.
Mail_IMAPv2::getRelatedParts(): Looks to see if this part has any inline parts associated with it.
Mail_IMAPv2::messageCount(): Wrapper method for imap_num_msg.
Mail_IMAPv2::setFlags(): Wrapper function for imap_setflag_full. Sets various message flags.
Mail_IMAPv2::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).
Mail_IMAPv2::unsetHeaders(): Destroys variables set by getHeaders.
Mail_IMAPv2::unsetParts(): Destroys variables set by getParts and _declareParts.
Mail_IMAPv2::_checkIfParsed(): Checks if the part has been parsed, if not calls on _declareParts to parse the message.
Mail_IMAPv2::_declareParts(): Gather message information returned by imap_fetchstructure and recursively iterate

Class Details

[line 52]
This class provides an extension to Mail_IMAPv2 that adds debugging utilities for the base IMAP.php class. The debugging functionality provided by this class is currently accessed by supplying various $_GET method arguments.

Tutorial: http://www.smilingsouls.net/Mail_IMAP
Author: Richard York <rich_y@php.net>
Version: 0.1.0 Beta
Copyright: (c) Copyright 2004-2005, Richard York, All Rights Reserved.
Since: C-Client 2001
Since: PHP 4.2.0
License: BSD

[ Top ]

Method Detail

Mail_IMAPv2_Debug (Constructor) [line 54]

Mail_IMAPv2_Debug Mail_IMAPv2_Debug(
[
$connection = NULL], [
$get_info = TRUE])

Parameters:

	`$connection`	—
	`$get_info`	—

[ Top ]

debug [line 77]

void debug(
[int
$mid = 0])

Dumps various information about a message for debugging. Specify $_GET variables to view information.

Calling on the debugger exits script execution after debugging operations have been completed.

Tutorial: http://www.smilingsouls.net/Mail_IMAP?content=Mail_IMAP_Debug/debug
Access: public

Parameters:

int $mid — $mid to debug

[ Top ]

dump [line 125]

void dump(

&$thing, mixed
$thing)

Calls on var_dump and outputs with HTML

Tutorial: http://www.smilingsouls.net/Mail_IMAP?content=Mail_IMAP_Debug/dump
Access: public

Parameters:

mixed	`$thing`	—	$thing to dump.
	`&$thing`	—

[ Top ]

Documentation generated on Mon, 11 Mar 2019 15:40:08 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.