Docs For Class Zend_Mime

Description

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Direct descendents

Class	Description
Zend_Mail	Class for sending an email.

Variable Summary

mixed $_mime

mixed $_parts

Method Summary

static Zend_Mime_Message createFromMessage (string $message, string $boundary, [string $EOL = Zend_Mime::LINEEND])

static array _disassembleMime (string $body, string $boundary)

void addPart (Zend_Mime_Part $part)

string generateMessage ([string $EOL = Zend_Mime::LINEEND])

Zend_Mime getMime ()

string getPartContent (int $partnum, [ $EOL = Zend_Mime::LINEEND])

string getPartHeaders (int $partnum, [ $EOL = Zend_Mime::LINEEND])

array getPartHeadersArray (int $partnum)

array getParts ()

boolean isMultiPart ()

void setMime (Zend_Mime $mime)

void setParts (array $parts)

Variables

mixed $_mime = null (line 44)

access: protected

mixed $_parts = array() (line 43)

access: protected

Methods

static createFromMessage (line 243)

Decodes a MIME encoded string and returns a Zend_Mime_Message object with all the MIME parts set according to the given string

access: public

static Zend_Mime_Message createFromMessage (string $message, string $boundary, [string $EOL = Zend_Mime::LINEEND])

string $message
string $boundary
string $EOL: EOL string; defaults to Zend_Mime::LINEEND

static _disassembleMime (line 202)

Explode MIME multipart string into seperate parts

Parts consist of the header and the body of each MIME part.

access: protected

static array _disassembleMime (string $body, string $boundary)

string $body
string $boundary

addPart (line 71)

Append a new Zend_Mime_Part to the current message

access: public

void addPart (Zend_Mime_Part $part)

Zend_Mime_Part $part

generateMessage (line 135)

Generate MIME-compliant message from the current configuration

This can be a multipart message if more than one MIME part was added. If only one part is present, the content of this part is returned. If no part had been added, an empty string is returned.

Parts are seperated by the mime boundary as defined in Zend_Mime. If setMime() has been called before this method, the Zend_Mime object set by this call will be used. Otherwise, a new Zend_Mime object is generated and used.

access: public

string generateMessage ([string $EOL = Zend_Mime::LINEEND])

string $EOL: EOL string; defaults to Zend_Mime::LINEEND

getMime (line 111)

Returns the Zend_Mime object in use by the message

If the object was not present, it is created and returned. Can be used to determine the boundary used in this message.

access: public

Zend_Mime getMime ()

getPartContent (line 188)

Get the (encoded) content of a given part as a string

access: public

string getPartContent (int $partnum, [ $EOL = Zend_Mime::LINEEND])

int $partnum
$EOL

getPartHeaders (line 177)

Get the headers of a given part as a string

access: public

string getPartHeaders (int $partnum, [ $EOL = Zend_Mime::LINEEND])

int $partnum
$EOL

getPartHeadersArray (line 166)

Get the headers of a given part as an array

access: public

array getPartHeadersArray (int $partnum)

int $partnum

getParts (line 51)

Returns the list of all Zend_Mime_Parts in the message

return: of Zend_Mime_Part
access: public

array getParts ()

isMultiPart (line 85)

Check if message needs to be sent as multipart MIME message or if it has only one part.

access: public

boolean isMultiPart ()

setMime (line 98)

Set Zend_Mime object for the message

This can be used to set the boundary specifically or to use a subclass of Zend_Mime for generating the boundary.

access: public

void setMime (Zend_Mime $mime)

Zend_Mime $mime

setParts (line 61)

Sets the given array of Zend_Mime_Parts as the array for the message

access: public

void setParts (array $parts)

array $parts