/**
* Message.class.php
*
- * Copyright (c) 2003-2005 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
- * This contains functions needed to handle mime messages.
+ * This file contains functions needed to handle mime messages.
*
+ * @copyright © 2003-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
+ * @subpackage mime
+ * @since 1.3.2
*/
/**
- * The object that contains a message
+ * 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.
+ * 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.
* @package squirrelmail
+ * @subpackage mime
+ * @since 1.3.0
*/
class Message {
- var $rfc822_header = '',
- $mime_header = '',
- $flags = '',
- $type0='',
- $type1='',
- $entities = array(),
- $entity_id = '',
- $parent_ent, $entity,
- $parent = '', $decoded_body='',
- $is_seen = 0, $is_answered = 0, $is_deleted = 0, $is_flagged = 0,
- $is_mdnsent = 0,
- $body_part = '',
- $offset = 0, /* for fetching body parts out of raw messages */
- $length = 0, /* for fetching body parts out of raw messages */
- $att_local_name = ''; /* location where the tempory attachment
- is stored. For future usage in smtp.php */
+ /**
+ * rfc822header object
+ * @var object
+ */
+ var $rfc822_header = '';
+ /**
+ * MessageHeader object
+ * @var object
+ */
+ var $mime_header = '';
+ /**
+ * @var mixed
+ */
+ var $flags = '';
+ /**
+ * Media type
+ * @var string
+ */
+ var $type0='';
+ /**
+ * Media subtype
+ * @var string
+ */
+ var $type1='';
+ /**
+ * Nested mime parts
+ * @var array
+ */
+ var $entities = array();
+ /**
+ * Message part id
+ * @var string
+ */
+ var $entity_id = '';
+ /**
+ * Parent message part id
+ * @var string
+ */
+ var $parent_ent;
+ /**
+ * @var mixed
+ */
+ var $entity;
+ /**
+ * @var mixed
+ */
+ var $parent = '';
+ /**
+ * @var string
+ */
+ var $decoded_body='';
+ /**
+ * Message \seen status
+ * @var boolean
+ */
+ var $is_seen = 0;
+ /**
+ * Message \answered status
+ * @var boolean
+ */
+ var $is_answered = 0;
+ /**
+ * Message \deleted status
+ * @var boolean
+ */
+ var $is_deleted = 0;
+ /**
+ * Message \flagged status
+ * @var boolean
+ */
+ var $is_flagged = 0;
+ /**
+ * Message mdn status
+ * @var boolean
+ */
+ var $is_mdnsent = 0;
+ /**
+ * Message text body
+ * @var string
+ */
+ var $body_part = '';
+ /**
+ * Message part offset
+ * for fetching body parts out of raw messages
+ * @var integer
+ */
+ var $offset = 0;
+ /**
+ * Message part length
+ * for fetching body parts out of raw messages
+ * @var integer
+ */
+ var $length = 0;
+ /**
+ * Local attachment filename location where the tempory attachment is
+ * stored. For use in delivery class.
+ * @var string
+ */
+ var $att_local_name = '';
+ /**
+ * @param string $ent entity id
+ */
function setEnt($ent) {
$this->entity_id= $ent;
}
+ /**
+ * Add nested message part
+ * @param object $msg
+ */
function addEntity ($msg) {
$this->entities[] = $msg;
}
+ /**
+ * Get file name used for mime part
+ * @return string file name
+ * @since 1.3.2
+ */
function getFilename() {
$filename = '';
$header = $this->header;
return $filename;
}
-
+ /**
+ * Add header object to message object.
+ * WARNING: Unfinished code. Don't expect it to work in older sm versions.
+ * @param mixed $read array or string with message headers
+ * @todo FIXME: rfc822header->parseHeader() does not return rfc822header object
+ */
function addRFC822Header($read) {
$header = new Rfc822Header();
$this->rfc822_header = $header->parseHeader($read);
}
+ /**
+ * @param string $ent
+ * @return mixed (object or string?)
+ */
function getEntity($ent) {
$cur_ent = $this->entity_id;
$msg = $this;
return $msg;
}
+ /**
+ * Set message body
+ * @param string $s message body
+ */
function setBody($s) {
$this->body_part = $s;
}
+ /**
+ * Clean message object
+ */
function clean_up() {
$msg = $this;
$msg->body_part = '';
}
}
+ /**
+ * @return string
+ */
function getMailbox() {
$msg = $this;
while (is_object($msg->parent)) {
* Question/Bugs:
*
* Ask for me (Marc Groot Koerkamp, stekkel@users.sourceforge.net)
- *
+ * @param string $read
+ * @param integer $i
+ * @param mixed $sub_msg
+ * @return object Message object
+ * @todo define argument and return types
*/
function parseStructure($read, &$i, $sub_msg = '') {
$msg = Message::parseBodyStructure($read, $i, $sub_msg);
return $msg;
}
+ /**
+ * @param object $msg
+ * @param mixed $init
+ * @param integer $i
+ * @todo document me
+ * @since 1.4.0
+ */
function setEntIds(&$msg,$init=false,$i=0) {
$iCnt = count($msg->entities);
if ($init !==false) {
}
}
+ /**
+ * @param string $read
+ * @param integer $i
+ * @param mixed $sub_msg
+ * @return object Message object
+ * @todo document me
+ * @since 1.4.0 (code was part of parseStructure() in 1.3.x)
+ */
function parseBodyStructure($read, &$i, $sub_msg = '') {
$arg_no = 0;
$arg_a = array();
} /* for */
} /* parsestructure */
+ /**
+ * @param string $read
+ * @param integer $i
+ * @return array
+ */
function parseProperties($read, &$i) {
$properties = array();
$prop_name = '';
return $properties;
}
+ /**
+ * @param string $read
+ * @param integer $i
+ * @param object $hdr MessageHeader object
+ * @return object MessageHeader object
+ */
function parseEnvelope($read, &$i, $hdr) {
$arg_no = 0;
$arg_a = array();
return $hdr;
}
+ /**
+ * @param string $read
+ * @param integer $i
+ * @return string
+ * @todo document me
+ */
function parseLiteral($read, &$i) {
$lit_cnt = '';
++$i;
return $s;
}
+ /**
+ * @param string $read
+ * @param integer $i
+ * @return string
+ * @todo document me
+ */
function parseQuote($read, &$i) {
$s = '';
$iPos = ++$i;
return $s;
}
+ /**
+ * @param string $read
+ * @param integer $i
+ * @return object AddressStructure object
+ */
function parseAddress($read, &$i) {
$arg_a = array();
for (; $read{$i} != ')'; ++$i) {
return $adr;
}
+ /**
+ * @param string $read
+ * @param integer $i
+ * @param object Disposition object or empty string
+ */
function parseDisposition($read, &$i) {
$arg_a = array();
for (; $read{$i} != ')'; ++$i) {
$disp->properties = $arg_a[1];
}
}
-
return (is_object($disp) ? $disp : '');
}
+ /**
+ * @param string $read
+ * @param integer $i
+ * @return object Language object or empty string
+ */
function parseLanguage($read, &$i) {
/* no idea how to process this one without examples */
$arg_a = array();
$lang->properties = $arg_a[1];
}
}
-
return (is_object($lang) ? $lang : '');
}
+ /**
+ * Parse message text enclosed in parenthesis
+ * @param string $read
+ * @param integer $i
+ * @return integer
+ */
function parseParenthesis($read, $i) {
for (; $read{$i} != ')'; ++$i) {
switch ($read{$i}) {
return $i;
}
- /* Function to fill the message structure in case the */
- /* bodystructure is not available NOT FINISHED YET */
+ /**
+ * Function to fill the message structure in case the
+ * bodystructure is not available
+ * NOT FINISHED YET
+ * @param string $read
+ * @param string $type0 message part type
+ * @param string $type1 message part subtype
+ * @return string (only when type0 is not message or multipart)
+ */
function parseMessage($read, $type0, $type1) {
switch ($type0) {
case 'message':
}
}
+ /**
+ * @param array $entity
+ * @param array $alt_order
+ * @param boolean $strict
+ * @return array
+ */
function findDisplayEntity($entity = array(), $alt_order = array('text/plain', 'text/html'), $strict=false) {
$found = false;
if ($this->type0 == 'multipart') {
}
} else { /* Treat as multipart/mixed */
foreach ($this->entities as $ent) {
- if((strtolower($ent->header->disposition->name) != 'attachment') &&
- (!isset($ent->header->parameters['filename'])) &&
- (!isset($ent->header->parameters['name'])) &&
- (($ent->type0 != 'message') && ($ent->type1 != 'rfc822'))) {
+ if(!(is_object($ent->header->disposition) && strtolower($ent->header->disposition->name) == 'attachment') &&
+ (!isset($ent->header->parameters['filename'])) &&
+ (!isset($ent->header->parameters['name'])) &&
+ (($ent->type0 != 'message') && ($ent->type1 != 'rfc822'))) {
$entity = $ent->findDisplayEntity($entity, $alt_order, $strict);
$found = true;
}
foreach ($alt_order as $alt) {
if( ($alt == $type) && isset($this->entity_id) ) {
if ((count($this->entities) == 0) &&
- (!isset($ent->header->parameters['filename'])) &&
- (!isset($ent->header->parameters['name'])) &&
- (strtolower($this->header->disposition->name) != 'attachment')) {
+ (!isset($this->header->parameters['filename'])) &&
+ (!isset($this->header->parameters['name'])) &&
+ isset($this->header->disposition) && is_object($this->header->disposition) &&
+ !(is_object($this->header->disposition) && strtolower($this->header->disposition->name) == 'attachment')) {
$entity[] = $this->entity_id;
$found = true;
}
}
if(!$found) {
foreach ($this->entities as $ent) {
- if((strtolower($ent->header->disposition->name) != 'attachment') &&
+ if(!(is_object($ent->header->disposition) && strtolower($ent->header->disposition->name) == 'attachment') &&
(($ent->type0 != 'message') && ($ent->type1 != 'rfc822'))) {
$entity = $ent->findDisplayEntity($entity, $alt_order, $strict);
$found = true;
in_array($this->type1, array('plain', 'html', 'message')) &&
isset($this->entity_id)) {
if (count($this->entities) == 0) {
- if (strtolower($this->header->disposition->name) != 'attachment') {
+ if (!is_object($this->header->disposition) || strtolower($this->header->disposition->name) != 'attachment') {
$entity[] = $this->entity_id;
}
}
return $entity;
}
+ /**
+ * @param array $alt_order
+ * @return array
+ */
function findAlternativeEntity($alt_order) {
/* If we are dealing with alternative parts then we */
/* choose the best viewable message supported by SM. */
}
}
}
-
return $entity;
}
+ /**
+ * @return array
+ */
function findRelatedEntity() {
$msgs = array();
$related_type = $this->header->getParameter('type');
return $msgs;
}
+ /**
+ * @param array $exclude_id
+ * @param array $result
+ * @return array
+ */
function getAttachments($exclude_id=array(), $result = array()) {
/*
if (($this->type0 == 'message') &&
return $result;
}
+ /**
+ * Add attachment to message object
+ * @param string $type attachment type
+ * @param string $name attachment name
+ * @param string $location path to attachment
+ */
function initAttachment($type, $name, $location) {
$attachment = new Message();
$mime_header = new MessageHeader();
$mime_header->setParameter('name', $name);
+ // FIXME: duplicate code. see ContentType class
$pos = strpos($type, '/');
if ($pos > 0) {
$mime_header->type0 = substr($type, 0, $pos);
$attachment->mime_header = $mime_header;
$this->entities[]=$attachment;
}
-}
-?>
\ No newline at end of file
+ /**
+ * Delete all attachments from this object from disk.
+ * @since 1.5.1
+ */
+ function purgeAttachments() {
+ if ($this->att_local_name && file_exists($this->att_local_name)) {
+ unlink($this->att_local_name);
+ }
+ // recursively delete attachments from entities contained in this object
+ for ($i=0, $entCount=count($this->entities);$i< $entCount; ++$i) {
+ $this->entities[$i]->purgeAttachments();
+ }
+ }
+}