12.3. Zend_Mime_Part

12.3.1. Introduction

This class represents a single part of a MIME message. It contains the actual content of the message part plus information about its encoding, content type and original filename. It provides a method for generating a string from the stored data. Zend_Mime_Part objects can be added to Zend_Mime_Message to assemble a complete multipart message.

12.3.2. Instantiation

Zend_Mime_Part is instantiated with a string that represents the content of the new part. The type is assumed to be OCTET-STREAM, encoding is 8Bit. After instantiating a Zend_Mime_Part, meta information can be set by accessing its attributes directly:

public $type = ZMime::TYPE_OCTETSTREAM;
public $encoding = ZMime::ENCODING_8BIT;
public $id;
public $disposition;
public $filename;
public $description;
public $charset;

12.3.3. Methods for rendering the message part to a string

->getContent() returns the encoded content of the MimePart as a string using the encoding specified in the attribute $encoding. Valid values are ZMime::ENCODING_* Characterset conversions are not performed.

->getHeaders() returns the Mime-Headers for the MimePart as generated from the information in the publicly accessable attributes. The attributes of the object need to be set correctly before this method is called.

  • $charset has to be set to the actual charset of the content if it is a text type (Text or HTML).
  • $id may be set to identify a content-id for inline images in a HTML mail.
  • $filename contains the name the file will get when downloading it.
  • $disposition defines if the file should be treated as an attachment or if it is used inside the (HTML-) mail (inline).
  • $description is only used for informational purposes.