Mime/Message.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Mime  
Version
$Id$  

\Zend_Mime_Message

Package: Zend_Mime
Children
\Zend_Mail
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_mime = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_parts = array()
Default valuearray()Details
Type
n/a

Methods

methodprotected_disassembleMime(string $body, string $boundary) : array
static

Explode MIME multipart string into seperate parts

Parts consist of the header and the body of each MIME part.
Parameters
NameTypeDescription
$bodystring
$boundarystring
Returns
TypeDescription
array
methodpublicaddPart(\Zend_Mime_Part $part) : void

Append a new Zend_Mime_Part to the current message

Parameters
NameTypeDescription
$part\Zend_Mime_Part
methodpubliccreateFromMessage(string $message, string $boundary, string $EOL = \Zend_Mime::LINEEND) : \Zend_Mime_Message
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
NameTypeDescription
$messagestring
$boundarystring
$EOLstring

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

Returns
TypeDescription
\Zend_Mime_Message
methodpublicgenerateMessage(string $EOL = \Zend_Mime::LINEEND) : 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.
Parameters
NameTypeDescription
$EOLstring

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

Returns
TypeDescription
string
methodpublicgetMime() : \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.
Returns
TypeDescription
\Zend_Mime
methodpublicgetPartContent(int $partnum,  $EOL = \Zend_Mime::LINEEND) : string

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

Parameters
NameTypeDescription
$partnumint
$EOL
Returns
TypeDescription
string
methodpublicgetPartHeaders(int $partnum,  $EOL = \Zend_Mime::LINEEND) : string

Get the headers of a given part as a string

Parameters
NameTypeDescription
$partnumint
$EOL
Returns
TypeDescription
string
methodpublicgetPartHeadersArray(int $partnum) : array

Get the headers of a given part as an array

Parameters
NameTypeDescription
$partnumint
Returns
TypeDescription
array
methodpublicgetParts() : array

Returns the list of all Zend_Mime_Parts in the message

Returns
TypeDescription
arrayof Zend_Mime_Part
methodpublicisMultiPart() : boolean

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

Returns
TypeDescription
boolean
methodpublicsetMime(\Zend_Mime $mime) : void

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
NameTypeDescription
$mime\Zend_Mime
methodpublicsetParts(array $parts) : void

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

Parameters
NameTypeDescription
$partsarray
Documentation was generated by phpDocumentor 2.2.0 .