Zend Framework  3.0
Public Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Message Class Reference

Public Member Functions

 getParts ()
 Returns the list of all Zend in the message.
 
 setParts ($parts)
 Sets the given array of Zend as the array for the message.
 
 addPart (Part $part)
 Append a new Zend to the current message.
 
 isMultiPart ()
 Check if message needs to be sent as multipart MIME message or if it has only one part.
 
 setMime (Mime $mime)
 Set Zend object for the message.
 
 getMime ()
 Returns the Zend object in use by the message.
 
 generateMessage ($EOL=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=Mime::LINEEND)
 Get the headers of a given part as a string.
 
 getPartContent ($partnum, $EOL=Mime::LINEEND)
 Get the (encoded) content of a given part as a string.
 

Static Protected Member Functions

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

Protected Attributes

 $parts = []
 
 $mime = null
 

Member Function Documentation

static _disassembleMime (   $body,
  $boundary 
)
staticprotected

Explode MIME multipart string into separate parts.

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

Parameters
string$body
string$boundary
Exceptions
Exception\RuntimeException
Returns
array
addPart ( Part  $part)

Append a new Zend to the current message.

Parameters
\Zend\Mime\Part$part
Todo:
check for duplicate object handle
generateMessage (   $EOL = 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 separated by the mime boundary as defined in Zend. If setMime() has been called before this method, the Zend object set by this call will be used. Otherwise, a new Zend object is generated and used.

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

Returns the Zend 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
getPartContent (   $partnum,
  $EOL = Mime::LINEEND 
)

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

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

Get the headers of a given part as a string.

Parameters
int$partnum
string$EOL
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 in the message.

Returns
array of
isMultiPart ( )

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

Returns
bool
setMime ( Mime  $mime)

Set Zend object for the message.

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

Parameters
\Zend\Mime\Mime$mime
setParts (   $parts)

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

Parameters
array$parts

Member Data Documentation

$mime = null
protected
$parts = []
protected
Generated by   doxygen 1.8.3