How to use the MIME API

Creating MIME messages

Scenario: We have a text block (such as text/calendar data) which needs to be added as a MIME part to an email message. We then need to add a couple of additional headers to this message and finally read it back as a string.

For Message Body:

<php>

require_once 'Horde/MIME/Message.php';

$message = &new MIME_Message();

$part = $new MIME_Part('text/plain', $message_text);

$message->addPart($part);

</php>

For text/calendar attachment:

<php>

$part = &new MIME_Part('text/calendar', $text_calendar_data);

$message->addPart($part);

</php>

For Headers:

<php>

require_once 'Horde/MIME/Headers.php';

$headers = &new MIME_Headers();

$headers->addHeader('Header 1', $Header_1_Value);

$headers->addHeader('Header 2', $Header_2_Value);

$headers->addMIMEHeaders($message);

</php>

To return the message as a string:

<php>

$string = $headers->toString() . "\n\n" . $message->toString();

</php>

Parsing a MIME message

Scenario: We have an existing text string which contains a valid MIME email message. We need to parse this string in order to read back the body of a specific MIME part with a certain content type.

<php>

require_once 'Horde/MIME/Structure.php';

$message = &MIME_Structure::parseTextMIMEMessage($message_text);

$part = $message->getPart($mime_id);

</php>

To determine the structure of the MIME message, e.g. to find out the MIME ID we are looking for:

<php>

$map = $message->contentTypeMap();

</php>

$map is an array with key being the MIME IDs and values being the Content Types of that IDs.

Using MIME Viewers

Scenario: Continuing the previous example we want to render the text/calendar part to HTML. This code currently only works inside of a Horde application because it relies on the registry and Horde's configuration files.

<php>

require HORDE_BASE . '/config/mime_drivers.php';

require_once 'Horde/MIME/Viewer.php';

$viewer = &MIME_Viewer::factory($part);

$html = $viewer->render();

</php>