Class MIME_Message

Description

The MIME_Message:: class provides methods for creating and manipulating MIME email messages.

$Horde: framework/MIME/MIME/Message.php,v 1.76.10.19 2009/01/06 15:23:20 jan Exp $

Copyright 1999-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /MIME/MIME/Message.php (line 20)

MIME_Part
   |
   --MIME_Message
Variable Summary
 boolean $_build
Method Summary
 MIME_Message MIME_Message ([string $defaultServer = null])
 void buildMessage ()
 MIME_Message &convertMIMEPart (MIME_Part &$mime_part, [string $server = null])
 array encode (array $headers, string $charset)
 MIME_Part &getPart (string $id)
 array getParts ()
 array header ([array $headers = array()])
 mixed send (string $email, mixed &$headers, [string $driver = null], [array $params = array()])
 string toString ()
Variables
Methods
Constructor MIME_Message (line 42)

Constructor - creates a new MIME email message.

MIME_Message MIME_Message ([string $defaultServer = null])
  • string $defaultServer: The server to default unqualified addresses to.
buildMessage (line 266)

Build message from current contents.

void buildMessage ()
convertMIMEPart (line 62)

Create a MIME_Message object from a MIME_Part object.

This function can be called statically via: MIME_Message::convertMIMEPart();

  • return: The new MIME_Message object.
MIME_Message &convertMIMEPart (MIME_Part &$mime_part, [string $server = null])
  • MIME_Part &$mime_part: The MIME_Part object.
  • string $server: The server to default unqualified addresses to.
encode (line 201)

Take a set of headers and make sure they are encoded properly.

  • return: The array of encoded headers.
array encode (array $headers, string $charset)
  • array $headers: The headers to encode.
  • string $charset: The character set to use.
getBasePart (line 312)

Return the base part of the message. This function does NOT return a reference to make sure that the whole MIME_Message object isn't accidentally modified.

  • return: The base MIME_Part of the message.
MIME_Message getBasePart ()
getPart (line 326)

Retrieve a specific MIME part.

  • return: The MIME_Part requested, or false if the part doesn't exist.
MIME_Part &getPart (string $id)
  • string $id: The MIME_Part ID string.

Redefinition of:
MIME_Part::getPart()
Retrieve a specific MIME part.
getParts (line 295)

Get a list of all MIME subparts.

  • return: An array of the MIME_Part subparts.
array getParts ()

Redefinition of:
MIME_Part::getParts()
Get a list of all MIME subparts.
header (line 235)

Add the proper set of MIME headers for this message to an array.

  • return: The full set of headers including MIME headers.
array header ([array $headers = array()])
  • array $headers: The headers to add the MIME headers to.

Redefinition of:
MIME_Part::header()
Add the appropriate MIME headers for this part to an existing array.
send (line 87)

Sends this message.

  • return: True on success, PEAR_Error on error.
mixed send (string $email, mixed &$headers, [string $driver = null], [array $params = array()])
  • string $email: The address list to send to.
  • mixed &$headers: The MIME_Headers object holding this message's headers, or a hash with header->value mappings.
  • string $driver: The Mail driver to use (since Horde 3.0.4).
  • array $params: Any parameters necessary for the Mail driver (since Horde 3.0.4).
toString (line 253)

Return the entire message contents, including headers, as a string.

  • return: The encoded, generated message.
string toString ()

Redefinition of:
MIME_Part::toString()
Return the entire part in MIME format. Includes headers on request.

Inherited Methods

Inherited From MIME_Part

 MIME_Part::MIME_Part()
 MIME_Part::addCID()
 MIME_Part::addPart()
 MIME_Part::alterPart()
 MIME_Part::appendContents()
 MIME_Part::clearContents()
 MIME_Part::clearContentTypeParameter()
 MIME_Part::contentTypeMap()
 MIME_Part::getAllContentTypeParameters()
 MIME_Part::getAllDispositionParameters()
 MIME_Part::getBytes()
 MIME_Part::getCanonicalContents()
 MIME_Part::getCharset()
 MIME_Part::getCIDList()
 MIME_Part::getContentID()
 MIME_Part::getContents()
 MIME_Part::getContentTypeParameter()
 MIME_Part::getCurrentEncoding()
 MIME_Part::getDefaultType()
 MIME_Part::getDescription()
 MIME_Part::getDisposition()
 MIME_Part::getDispositionParameter()
 MIME_Part::getEOL()
 MIME_Part::getInformation()
 MIME_Part::getMIMEId()
 MIME_Part::getName()
 MIME_Part::getPart()
 MIME_Part::getParts()
 MIME_Part::getPrimaryType()
 MIME_Part::getRelativeMIMEId()
 MIME_Part::getSize()
 MIME_Part::getSubType()
 MIME_Part::getTransferEncoding()
 MIME_Part::getType()
 MIME_Part::getUniqueID()
 MIME_Part::header()
 MIME_Part::removePart()
 MIME_Part::replaceEOL()
 MIME_Part::setBytes()
 MIME_Part::setCharset()
 MIME_Part::setContentID()
 MIME_Part::setContents()
 MIME_Part::setContentTypeParameter()
 MIME_Part::setDescription()
 MIME_Part::setDisposition()
 MIME_Part::setDispositionParameter()
 MIME_Part::setEOL()
 MIME_Part::setInformation()
 MIME_Part::setMIMEId()
 MIME_Part::setName()
 MIME_Part::setTransferEncoding()
 MIME_Part::setType()
 MIME_Part::splitContents()
 MIME_Part::strict7bit()
 MIME_Part::toCanonicalString()
 MIME_Part::toString()
 MIME_Part::transferDecode()
 MIME_Part::transferDecodeContents()
 MIME_Part::transferEncode()
 MIME_Part::transferEncodeContents()

Documentation generated on Sun, 30 Jan 2011 05:19:36 +0000 by phpDocumentor 1.4.3