Docs For Class Message

Message

Description

The object that contains a message.

message is the object that contains messages. It is a recursive object in that through the $entities variable, it can contain more objects of type message. See documentation in mime.txt for a better description of how this works.

Located in /nasmail/class/mime/Message.class.php (line 31)

Variable Summary

string $att_local_name

string $body_part

string $decoded_body

array $entities

mixed $entity

string $entity_id

mixed $flags

object MessageHeader $header

boolean $is_answered

boolean $is_deleted

boolean $is_flagged

boolean $is_mdnsent

boolean $is_seen

integer $length

object MessageHeader $mime_header

integer $offset

object Message $parent

string $parent_ent

object Rfc822Header $rfc822_header

string $type0

string $type1

Method Summary

void addEntity (object Message $msg)

void addRFC822Header (mixed $read)

void clean_up ()

array findAlternativeEntity (array $alt_order)

array findDisplayEntity ([array $entity = array()], [array $alt_order = array('text/plain', 'text/html')], [boolean $strict = false])

array findRelatedEntity ()

array getAttachments ([array $exclude_id = array()], [array $result = array()])

object Message getEntity (string $ent)

string getFilename ()

string getMailbox ()

void initAttachment (string $type, string $name, string $location)

object AddressStructure parseAddress (string $read, integer &$i)

object Message parseBodyStructure (string $read, integer &$i, [mixed $sub_msg = ''])

void parseDisposition (string $read, integer &$i, object Disposition 2)

object Rfc822Header parseEnvelope (string $read, integer &$i, object Rfc822Header $hdr)

object Language parseLanguage (string $read, integer &$i)

string parseLiteral (string $read, integer &$i)

string parseMessage (string $read, string $type0, string $type1)

integer parseParenthesis (string $read, integer $i)

array parseProperties (string $read, &$i, integer $i)

string parseQuote (string $read, integer &$i)

object Message parseStructure (string $read, integer &$i, [mixed $sub_msg = ''])

void purgeAttachments ()

void setBody (string $s)

void setEnt (string $ent)

void setEntIds (object &$msg, [mixed $init = false], [integer $i = 0])

Variables

string $att_local_name = '' (line 132)

Local attachment filename location where the tempory attachment is stored. For use in delivery class.

string $body_part = '' (line 114)

Message text body

string $decoded_body = '' (line 84)

array $entities = array() (line 60)

Nested mime parts

mixed $entity (line 74)

string $entity_id = '' (line 65)

Message part id

mixed $flags = '' (line 45)

object MessageHeader $header (line 137)

Message information from IMAP BODYSTRUCTURE

boolean $is_answered = 0 (line 94)

Message \answered status

boolean $is_deleted = 0 (line 99)

Message \deleted status

boolean $is_flagged = 0 (line 104)

Message \flagged status

boolean $is_mdnsent = 0 (line 109)

Message mdn status

boolean $is_seen = 0 (line 89)

Message \seen status

integer $length = 0 (line 126)

Message part length

for fetching body parts out of raw messages

object MessageHeader $mime_header = '' (line 41)

MessageHeader object

integer $offset = 0 (line 120)

Message part offset

for fetching body parts out of raw messages

object Message $parent = '' (line 80)

Parent message object

FIXME: recursive object

string $parent_ent (line 70)

Parent message part id

object Rfc822Header $rfc822_header = '' (line 36)

rfc822header object

string $type0 = '' (line 50)

Media type

string $type1 = '' (line 55)

Media subtype

Methods

addEntity (line 150)

Add nested message part

void addEntity (object Message $msg)

object Message $msg

addRFC822Header (line 202)

Add header object to message object.

WARNING: Unfinished code. Don't expect it to work in older sm versions.

todo: FIXME: rfc822header->parseHeader() does not return rfc822header object

void addRFC822Header (mixed $read)

mixed $read: array or string with message headers

clean_up (line 264)

Clean message object

void clean_up ()

findAlternativeEntity (line 1004)

array findAlternativeEntity (array $alt_order)

array $alt_order

findDisplayEntity (line 927)

array findDisplayEntity ([array $entity = array()], [array $alt_order = array('text/plain', 'text/html')], [boolean $strict = false])

array $entity
array $alt_order
boolean $strict

findRelatedEntity (line 1030)

array findRelatedEntity ()

getAttachments (line 1050)

array getAttachments ([array $exclude_id = array()], [array $result = array()])

array $exclude_id
array $result

getEntity (line 211)

object Message getEntity (string $ent)

string $ent

getFilename (line 158)

Get file name used for mime part

return: file name

string getFilename ()

getMailbox (line 276)

string getMailbox ()

initAttachment (line 1095)

Add attachment to message object

void initAttachment (string $type, string $name, string $location)

string $type: attachment type
string $name: attachment name
string $location: path to attachment

parseAddress (line 741)

return: object

object AddressStructure parseAddress (string $read, integer &$i)

string $read
integer &$i

parseBodyStructure (line 347)

return: object
todo: document me

object Message parseBodyStructure (string $read, integer &$i, [mixed $sub_msg = ''])

string $read
integer &$i
mixed $sub_msg

parseDisposition (line 780)

void parseDisposition (string $read, integer &$i, object Disposition 2)

string $read
integer &$i
object Disposition 2: object or empty string

parseEnvelope (line 558)

return: message header data

object Rfc822Header parseEnvelope (string $read, integer &$i, object Rfc822Header $hdr)

string $read
integer &$i
object Rfc822Header $hdr

parseLanguage (line 805)

return: object or empty string

object Language parseLanguage (string $read, integer &$i)

string $read
integer &$i

parseLiteral (line 648)

todo: document me

string parseLiteral (string $read, integer &$i)

string $read
integer &$i

parseMessage (line 854)

Function to fill the message structure in case the

bodystructure is not available NOT FINISHED YET

return: (only when type0 is not message or multipart)

string parseMessage (string $read, string $type0, string $type1)

string $read
string $type0: message part type
string $type1: message part subtype

parseParenthesis (line 833)

Parse message text enclosed in parenthesis

integer parseParenthesis (string $read, integer $i)

string $read
integer $i

parseProperties (line 527)

array parseProperties (string $read, &$i, integer $i)

string $read
integer $i
&$i

parseQuote (line 684)

function parseQuote

This extract the string value from a quoted string. After the end-quote character is found it returns the string. The offset $i when calling this function points to the first double quote. At the end it points to The ending quote. This function takes care of escaped double quotes. "some \"string\"" ^ ^ initial $i end position $i

return: string inbetween the double quotes
author: Marc Groot Koerkamp

string parseQuote (string $read, integer &$i)

string $read
integer &$i: offset in $read

parseStructure (line 299)

Bodystructure parser, a recursive function for generating the entity-tree with all the mime-parts.

It follows RFC2060 and stores all the described fields in the message object.

Question/Bugs:

Ask for me (Marc Groot Koerkamp, stekkel@users.sourceforge.net)

return: object

object Message parseStructure (string $read, integer &$i, [mixed $sub_msg = ''])

string $read: IMAP BODYSTRUCTURE response
integer &$i: current possition in parsed structure
mixed $sub_msg

purgeAttachments (line 1117)

Delete all attachments from this object from disk.

void purgeAttachments ()

setBody (line 257)

Set message body

void setBody (string $s)

string $s: message body

setEnt (line 142)

void setEnt (string $ent)

string $ent: entity id

setEntIds (line 311)

todo: document me

void setEntIds (object &$msg, [mixed $init = false], [integer $i = 0])

object &$msg
mixed $init
integer $i

Documentation generated on Sun, 22 Nov 2009 17:36:42 +0200 by phpDocumentor 1.4.3