[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Mime/ -> Message.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 286 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Mime_Message:: (12 methods):
  getParts()
  setParts()
  addPart()
  isMultiPart()
  setMime()
  getMime()
  generateMessage()
  getPartHeadersArray()
  getPartHeaders()
  getPartContent()
  _disassembleMime()
  createFromMessage()


Class: Zend_Mime_Message  - X-Ref


getParts()   X-Ref
Returns the list of all Zend_Mime_Parts in the message

return: array of Zend_Mime_Part

setParts($parts)   X-Ref
Sets the given array of Zend_Mime_Parts as the array for the message

param: array $parts

addPart(Zend_Mime_Part $part)   X-Ref
Append a new Zend_Mime_Part to the current message

param: Zend_Mime_Part $part

isMultiPart()   X-Ref
Check if message needs to be sent as multipart
MIME message or if it has only one part.

return: boolean

setMime(Zend_Mime $mime)   X-Ref
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.

param: Zend_Mime $mime

getMime()   X-Ref
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.

return: Zend_Mime

generateMessage($EOL = Zend_Mime::LINEEND)   X-Ref
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.

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

getPartHeadersArray($partnum)   X-Ref
Get the headers of a given part as an array

param: int $partnum
return: array

getPartHeaders($partnum, $EOL = Zend_Mime::LINEEND)   X-Ref
Get the headers of a given part as a string

param: int $partnum
return: string

getPartContent($partnum, $EOL = Zend_Mime::LINEEND)   X-Ref
Get the (encoded) content of a given part as a string

param: int $partnum
return: string

_disassembleMime($body, $boundary)   X-Ref
Explode MIME multipart string into seperate parts

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

param: string $body
param: string $boundary
return: array

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

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



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1