Mime/Message.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Mime
version: $Id: Message.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Mime_Message

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Mime_Message
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Mime
Properties: $_parts; $_mime
Methods: getParts; setParts; addPart; isMultiPart; setMime; getMime; generateMessage; getPartHeadersArray; getPartHeaders; getPartContent; _disassembleMime; createFromMessage

Description

Properties

$_mime
jump to class

$_mime = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_parts
jump to class

$_parts = 'array'

Details

visibility: protected
default: array
final: false
static: false

Methods

_disassembleMime
jump to class

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

Explode MIME multipart string into seperate parts

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

Arguments

$body: string
$boundary: string

Output

array

Details

visibility: protected
final: false
static: true

addPart
jump to class

addPart(
          Zend_Mime_Part $part
          )
        
        :

Append a new Zend_Mime_Part to the current message

Arguments

$part: Zend_Mime_Part

Details

visibility: public
final: false
static: false

createFromMessage
jump to class

createFromMessage(
          string $message, string $boundary, string $EOL
              =
              Zend_Mime
          )
        
        :
        Zend_Mime_Message

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

Arguments

$message: string
$boundary: string
$EOL: string
EOL string; defaults to {@link Zend_Mime::LINEEND}

Output

Zend_Mime_Message

Details

visibility: public
final: false
static: true

generateMessage
jump to class

generateMessage(
          string $EOL
              =
              Zend_Mime
          )
        
        :
        string

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 {@link 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.

Arguments

$EOL: string
EOL string; defaults to {@link Zend_Mime::LINEEND}

Output

string

Details

visibility: public
final: false
static: false

getMime
jump to class

getMime(
          
          )
        
        :
        Zend_Mime

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.

Output

Zend_Mime

Details

visibility: public
final: false
static: false

getPartContent
jump to class

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

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

Arguments

$partnum: int
$EOL

Output

string

Details

visibility: public
final: false
static: false

getPartHeaders
jump to class

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

Get the headers of a given part as a string

Arguments

$partnum: int
$EOL

Output

string

Details

visibility: public
final: false
static: false

getPartHeadersArray
jump to class

getPartHeadersArray(
          int $partnum
          )
        
        :
        array

Get the headers of a given part as an array

Arguments

$partnum: int

Output

array

Details

visibility: public
final: false
static: false

getParts
jump to class

getParts(
          
          )
        
        :
        array

Returns the list of all Zend_Mime_Parts in the message

Output

array: of Zend_Mime_Part

Details

visibility: public
final: false
static: false

isMultiPart
jump to class

isMultiPart(
          
          )
        
        :
        boolean

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

Output

boolean

Details

visibility: public
final: false
static: false

setMime
jump to class

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.

Arguments

$mime: Zend_Mime

Details

visibility: public
final: false
static: false

setParts
jump to class

setParts(
          array $parts
          )
        
        :

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

Arguments

$parts: array

Details

visibility: public
final: false
static: false

API Documentation

Mime/Message.php

Description

Zend_Mime_Messagejump to top

Description

Properties

$_mimejump to class

Details

$_partsjump to class

Details

Methods

_disassembleMimejump to class

Arguments

Output

Details

addPartjump to class

Arguments

Details

createFromMessagejump to class

Arguments

Output

Details

generateMessagejump to class

Arguments

Output

Details

getMimejump to class

Output

Details

getPartContentjump to class

Arguments

Output

Details

getPartHeadersjump to class

Arguments

Output

Details

getPartHeadersArrayjump to class

Arguments

Output

Details

getPartsjump to class

Output

Details

isMultiPartjump to class

Output

Details

setMimejump to class

Arguments

Details

setPartsjump to class

Arguments

Details

Zend_Mime_Message
jump to top

$_mime
jump to class

$_parts
jump to class

_disassembleMime
jump to class

addPart
jump to class

createFromMessage
jump to class

generateMessage
jump to class

getMime
jump to class

getPartContent
jump to class

getPartHeaders
jump to class

getPartHeadersArray
jump to class

getParts
jump to class

isMultiPart
jump to class

setMime
jump to class

setParts
jump to class