| [ Index ] |
|
Code source de IMP H3 (4.1.5) |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 713 lignes (24 kb) |
| Inclus ou requis: | 11 fois |
| Référencé: | 0 fois |
| Nécessite: | 3 fichiers lib/MIME/Headers.php lib/IMAP.php lib/Search.php |
IMP_Contents:: (25 méthodes):
singleton()
IMP_Contents()
getBody()
getBodyPart()
setStripLink()
partSummary()
urlView()
linkView()
fullMessageText()
getHeaderOb()
getMessageIndex()
rebuildMessage()
_rebuildMessage()
renderMIMEPart()
_addCacheShutdown()
getFromAddress()
getDownloadAllList()
getDownloadAllLink()
formatStatusMsg()
findBody()
_findBody()
_createCacheID()
_setContents()
getRawMIMEPart()
toString()
Classe: IMP_Contents - X-Ref
The IMP_Contents:: class extends the MIME_Contents:: class and contains| singleton($index) X-Ref |
| Attempts to return a reference to a concrete IMP_Contents instance. If an IMP_Contents object is currently stored in the local cache, recreate that object. Else, create a new instance. Ensures that only one IMP_Contents instance for any given message is available at any one time. This method must be invoked as: $imp_contents = &IMP_Contents::singleton($index); param: string $index The IMAP message mailbox/index. The index should return: IMP_Contents The IMP_Contents object or null. |
| IMP_Contents($in) X-Ref |
| Constructor param: mixed $in Either an index string (see IMP_Contents::singleton() |
| getBody() X-Ref |
| Returns the entire body of the message. return: string The text of the body of the message. |
| getBodyPart($id) X-Ref |
| Gets the raw text for one section of the message. param: integer $id The ID of the MIME_Part. return: string The text of the part. |
| setStripLink($strip = false) X-Ref |
| Allow attachments to be stripped by providing a link in summary view? param: boolean $strip Should the strip links be generated? |
| partSummary(&$mime_part, $guess = false) X-Ref |
| Returns an array summarizing a part of a MIME message. param: MIME_Part &$mime_part See MIME_Contents::partSummary(). param: boolean $guess See MIME_Contents::partSummary(). return: array See MIME_Contents::partSummary(). |
| urlView(&$mime_part, $actionID, $params = array() X-Ref |
| Return the URL to the view.php page. param: MIME_Part &$mime_part See MIME_Contents::urlView(). param: integer $actionID See MIME_Contents::urlView(). param: array $params See MIME_Contents::urlView(). param: boolean $dload See MIME_Contents::urlView(). return: string The URL to view.php. |
| linkView(&$mime_part, $actionID, $text, $params = array() X-Ref |
| Generate a link to the view.php page. param: MIME_Part &$mime_part See MIME_Contents::linkView(). param: integer $actionID See MIME_Contents::linkView(). param: string $text See MIME_Contents::linkView(). param: array $params See MIME_Contents::linkView(). return: string See MIME_Contents::linkView(). |
| fullMessageText() X-Ref |
| Returns the full message text. return: string The full message text. |
| getHeaderOb() X-Ref |
| Returns the header object. return: IMP_Headers The IMP_Headers object. |
| getMessageIndex() X-Ref |
| Returns the IMAP index for the current message. return: integer The message index. |
| rebuildMessage() X-Ref |
| Rebuild the MIME_Part structure of a message from IMAP data. This will store IMAP data in all parts of the message - for example, all data for a multipart/mixed part will be stored in the base part, and each part will contain its own data. Note that if you want to build a message string from the MIME_Part data after calling rebuildMessage(), you should use IMP_Contents::toString() instead of MIME_Part::toString(). return: MIME_Message A MIME_Message object with all of the body text |
| _rebuildMessage($part) X-Ref |
| Recursive function used to rebuild the MIME_Part structure of a message. param: MIME_Part $part A MIME_Part object. |
| renderMIMEPart(&$mime_part) X-Ref |
| Render a MIME Part. param: MIME_Part &$mime_part A MIME_Part object. return: string The rendered data. |
| _addCacheShutdown() X-Ref |
| Saves a copy of the MIME_Contents object at the end of a request. |
| getFromAddress() X-Ref |
| Get the from address of the message. return: string The from address of the message. |
| getDownloadAllList($forward = false) X-Ref |
| Generate the list of MIME IDs to use for download all. param: boolean $forward Generate a list of items that can be forwarded, return: array The list of MIME IDs that should be downloaded when |
| getDownloadAllLink() X-Ref |
| Generate a download all link, if possible. return: string The download link. |
| formatStatusMsg($msg, $img = null, $printable = true) X-Ref |
| Prints out the status message for a given MIME Part. param: mixed $msg See MIME_Contents::formatStatusMsg(). param: string $img See MIME_Contents::formatStatusMsg(). param: boolean $print Output this message when in a print view? return: string The formatted status message. |
| findBody() X-Ref |
| Finds the main "body" text part (if any) in a message. "Body" data is the first text part in the base MIME part. return: string The MIME ID of the main "body" part. |
| _findBody($mime_part) X-Ref |
| Processes a MIME Part and looks for "body" data. return: string The MIME ID of the main "body" part. |
| _createCacheID($index = null) X-Ref |
| Creates a unique cache ID for this object. param: integer $index The IMAP index of the current message. return: string A unique cache ID. |
| _setContents(&$mime_part, $all = false) X-Ref |
| Make sure the contents of the current part are set from IMAP server data. param: MIME_Part &$mime_part The MIME_Part object to work with. param: boolean $all Download the entire parts contents? |
| getRawMIMEPart($id, $all = false) X-Ref |
| Fetch part of a MIME message. param: integer $id The MIME ID of the part requested. param: boolean $all If this is a header part, should we return all text return: MIME_Part The MIME_Part. |
| toString($message, $canonical = false) X-Ref |
| Create a message string from a MIME message that has used rebuildMessage() to build the data from the IMAP server. param: MIME_Message $message A MIME_Message object. param: boolean $canonical Return a canonical string? return: string The contents of the MIME_Message object. |
| Généré le : Thu Nov 29 12:30:07 2007 | par Balluche grâce à PHPXref 0.7 |
|
|