Mime/Message.php
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$
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
$_mime = nullDefault valuenullDetails- Type
- n/a
$_parts = array()Default valuearray()Details- Type
- n/a
Methods
_disassembleMime(string $body, string $boundary) : arraystaticExplode MIME multipart string into seperate parts
Parts consist of the header and the body of each MIME part.
Parameters| Name | Type | Description |
|---|
| $body | string | |
|---|
| $boundary | string | |
|---|
Returns
createFromMessage(string $message, string $boundary, string $EOL = \Zend_Mime::LINEEND) : \Zend_Mime_MessagestaticDecodes a MIME encoded string and returns a Zend_Mime_Message object with
all the MIME parts set according to the given string
Parameters| Name | Type | Description |
|---|
| $message | string | |
|---|
| $boundary | string | |
|---|
| $EOL | string | EOL string; defaults to {@link Zend_Mime::LINEEND} |
|---|
Returns generateMessage(string $EOL = \Zend_Mime::LINEEND) : stringGenerate 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| Name | Type | Description |
|---|
| $EOL | string | EOL string; defaults to {@link Zend_Mime::LINEEND} |
|---|
ReturnsgetMime() : \Zend_MimeReturns 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.
ReturnsgetPartContent(int $partnum, $EOL = \Zend_Mime::LINEEND) : stringGet the (encoded) content of a given part as a string
Parameters| Name | Type | Description |
|---|
| $partnum | int | |
|---|
| $EOL | | |
|---|
Returns getPartHeaders(int $partnum, $EOL = \Zend_Mime::LINEEND) : stringGet the headers of a given part as a string
Parameters| Name | Type | Description |
|---|
| $partnum | int | |
|---|
| $EOL | | |
|---|
Returns getPartHeadersArray(int $partnum) : arrayGet the headers of a given part as an array
Parameters| Name | Type | Description |
|---|
| $partnum | int | |
|---|
Returns getParts() : arrayReturns the list of all Zend_Mime_Parts in the message
Returns| Type | Description |
|---|
| array | of Zend_Mime_Part |
setMime(\Zend_Mime $mime) : voidSet 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.
ParameterssetParts(array $parts) : voidSets the given array of Zend_Mime_Parts as the array for the message
Parameters| Name | Type | Description |
|---|
| $parts | array | |
|---|
inherited
Classes