Zend Framework  1.12
Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Zend_Mime_Message Class Reference

Public Member Functions

 getParts ()
 Returns the list of all Zend_Mime_Parts in the message.
 
 setParts ($parts)
 Sets the given array of Zend_Mime_Parts as the array for the message.
 
 addPart (Zend_Mime_Part $part)
 Append a new Zend_Mime_Part to the current message.
 
 isMultiPart ()
 Check if message needs to be sent as multipart MIME message or if it has only one part.
 
 setMime (Zend_Mime $mime)
 Set Zend_Mime object for the message.
 
 getMime ()
 Returns the Zend_Mime object in use by the message.
 
 generateMessage ($EOL=Zend_Mime::LINEEND)
 Generate MIME-compliant message from the current configuration.
 
 getPartHeadersArray ($partnum)
 Get the headers of a given part as an array.
 
 getPartHeaders ($partnum, $EOL=Zend_Mime::LINEEND)
 Get the headers of a given part as a string.
 
 getPartContent ($partnum, $EOL=Zend_Mime::LINEEND)
 Get the (encoded) content of a given part as a string.
 

Static Public Member Functions

static createFromMessage ($message, $boundary, $EOL=Zend_Mime::LINEEND)
 Decodes a MIME encoded string and returns a Zend_Mime_Message object with all the MIME parts set according to the given string.
 

Static Protected Member Functions

static _disassembleMime ($body, $boundary)
 Explode MIME multipart string into seperate parts.
 

Protected Attributes

 $_parts = array()
 
 $_mime = null
 

Member Function Documentation

static _disassembleMime (   $body,
  $boundary 
)
staticprotected

Explode MIME multipart string into seperate parts.

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

Parameters
string$body
string$boundary
Returns
array
addPart ( Zend_Mime_Part  $part)

Append a new Zend_Mime_Part to the current message.

Parameters
Zend_Mime_Part$part
Todo:
check for duplicate object handle
static createFromMessage (   $message,
  $boundary,
  $EOL = Zend_Mime::LINEEND 
)
static

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

Parameters
string$message
string$boundary
string$EOLEOL string; defaults to Zend_Mime::LINEEND
Returns
Zend_Mime_Message
Todo:
check for characterset and filename
generateMessage (   $EOL = Zend_Mime::LINEEND)

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.

Parameters
string$EOLEOL string; defaults to Zend_Mime::LINEEND
Returns
string
getMime ( )

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.

Returns
Zend_Mime
getPartContent (   $partnum,
  $EOL = Zend_Mime::LINEEND 
)

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

Parameters
int$partnum
Returns
string
getPartHeaders (   $partnum,
  $EOL = Zend_Mime::LINEEND 
)

Get the headers of a given part as a string.

Parameters
int$partnum
Returns
string
getPartHeadersArray (   $partnum)

Get the headers of a given part as an array.

Parameters
int$partnum
Returns
array
getParts ( )

Returns the list of all Zend_Mime_Parts in the message.

Returns
array of Zend_Mime_Part
isMultiPart ( )

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

Returns
boolean
setMime ( Zend_Mime  $mime)

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.

Parameters
Zend_Mime$mime
setParts (   $parts)

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

Parameters
array$parts

Member Data Documentation

$_mime = null
protected
$_parts = array()
protected