Docs For Class Swift

Class: Swift_Message

Class: Swift_Mime_SimpleMessage

Swift_Mime_SimpleMessage::__construct(): Create a new SimpleMessage with $headers, $encoder and $cache.
Swift_Mime_SimpleMessage::addBcc(): Add a Bcc: address to this message.
Swift_Mime_SimpleMessage::addCc(): Add a Cc: address to this message.
Swift_Mime_SimpleMessage::addFrom(): Add a From: address to this message.
Swift_Mime_SimpleMessage::addReplyTo(): Add a Reply-To: address to this message.
Swift_Mime_SimpleMessage::addTo(): Add a To: address to this message.
Swift_Mime_SimpleMessage::attach(): Attach a Swift_Mime_MimeEntity such as an Attachment or MimePart.
Swift_Mime_SimpleMessage::detach(): Remove an already attached entity.
Swift_Mime_SimpleMessage::embed(): Attach a Swift_Mime_MimeEntity and return it's CID source.
Swift_Mime_SimpleMessage::getBcc(): Get the Bcc addresses of this message.
Swift_Mime_SimpleMessage::getCc(): Get the Cc address of this message.
Swift_Mime_SimpleMessage::getDate(): Get the date at which this message was created.
Swift_Mime_SimpleMessage::getFrom(): Get the from address of this message.
Swift_Mime_SimpleMessage::getNestingLevel(): Always returns LEVEL_TOP for a message instance.
Swift_Mime_SimpleMessage::getPriority(): Get the priority of this message.
Swift_Mime_SimpleMessage::getReadReceiptTo(): Get the addresses to which a read-receipt will be sent.
Swift_Mime_SimpleMessage::getReplyTo(): Get the reply-to address of this message.
Swift_Mime_SimpleMessage::getReturnPath(): Get the return-path (bounce address) of this message.
Swift_Mime_SimpleMessage::getSender(): Get the sender of this message.
Swift_Mime_SimpleMessage::getSubject(): Get the subject of this message.
Swift_Mime_SimpleMessage::getTo(): Get the To addresses of this message.
Swift_Mime_SimpleMessage::setBcc(): Set the Bcc addresses of this message.
Swift_Mime_SimpleMessage::setCc(): Set the Cc addresses of this message.
Swift_Mime_SimpleMessage::setDate(): Set the date at which this message was created.
Swift_Mime_SimpleMessage::setFrom(): Set the from address of this message.
Swift_Mime_SimpleMessage::setPriority(): Set the priority of this message.
Swift_Mime_SimpleMessage::setReadReceiptTo(): Ask for a delivery receipt from the recipient to be sent to $addresses
Swift_Mime_SimpleMessage::setReplyTo(): Set the reply-to address of this message.
Swift_Mime_SimpleMessage::setReturnPath(): Set the return-path (the bounce address) of this message.
Swift_Mime_SimpleMessage::setSender(): Set the sender of this message.
Swift_Mime_SimpleMessage::setSubject(): Set the subject of this message.
Swift_Mime_SimpleMessage::setTo(): Set the to addresses of this message.
Swift_Mime_SimpleMessage::toByteStream(): Write this message to a Swift_InputByteStream.
Swift_Mime_SimpleMessage::toString(): Get this message as a complete string.
Swift_Mime_SimpleMessage::_getIdField()
Swift_Mime_SimpleMessage::__toString(): Returns a string representation of this object.

Class: Swift_Mime_MimePart

Swift_Mime_MimePart::__construct(): Create a new MimePart with $headers, $encoder and $cache.
Swift_Mime_MimePart::charsetChanged(): Receive notification that the charset has changed on this document, or a parent document.
Swift_Mime_MimePart::getCharset(): Get the character set of this entity.
Swift_Mime_MimePart::getDelSp(): Test if delsp is being used for this entity.
Swift_Mime_MimePart::getFormat(): Get the format of this entity (i.e. flowed or fixed).
Swift_Mime_MimePart::getNestingLevel(): Get the nesting level of this entity.
Swift_Mime_MimePart::setBody(): Set the body of this entity, either as a string, or as an instance of Swift_OutputByteStream.
Swift_Mime_MimePart::setCharset(): Set the character set of this entity.
Swift_Mime_MimePart::setDelSp(): Turn delsp on or off for this entity.
Swift_Mime_MimePart::setFormat(): Set the format of this entity (flowed or fixed).
Swift_Mime_MimePart::_fixHeaders(): Fix the content-type and encoding of this entity
Swift_Mime_MimePart::_setNestingLevel(): Set the nesting level of this entity

Class: Swift_Mime_SimpleMimeEntity

Swift_Mime_SimpleMimeEntity::__construct(): Create a new SimpleMimeEntity with $headers, $encoder and $cache.
Swift_Mime_SimpleMimeEntity::charsetChanged(): Receive notification that the charset of this entity, or a parent entity has changed.
Swift_Mime_SimpleMimeEntity::encoderChanged(): Receive notification that the encoder of this entity or a parent entity has changed.
Swift_Mime_SimpleMimeEntity::generateId(): Generate a new Content-ID or Message-ID for this MIME entity.
Swift_Mime_SimpleMimeEntity::getBody(): Get the body of this entity as a string.
Swift_Mime_SimpleMimeEntity::getBoundary(): Get the boundary used to separate children in this entity.
Swift_Mime_SimpleMimeEntity::getChildren(): Get all children added to this entity.
Swift_Mime_SimpleMimeEntity::getContentType(): Get the Content-type of this entity.
Swift_Mime_SimpleMimeEntity::getDescription(): Get the description of this entity.
Swift_Mime_SimpleMimeEntity::getEncoder(): Get the encoder used for the body of this entity.
Swift_Mime_SimpleMimeEntity::getHeaders(): Get the Swift_Mime_HeaderSet for this entity.
Swift_Mime_SimpleMimeEntity::getId(): Get the CID of this entity.
Swift_Mime_SimpleMimeEntity::getMaxLineLength(): Get the maximum line length of the body of this entity.
Swift_Mime_SimpleMimeEntity::getNestingLevel(): Get the nesting level of this entity.
Swift_Mime_SimpleMimeEntity::getRandomId(): Returns a random Content-ID or Message-ID.
Swift_Mime_SimpleMimeEntity::setBody(): Set the body of this entity, either as a string, or as an instance of Swift_OutputByteStream.
Swift_Mime_SimpleMimeEntity::setBoundary(): Set the boundary used to separate children in this entity.
Swift_Mime_SimpleMimeEntity::setChildren(): Set all children of this entity.
Swift_Mime_SimpleMimeEntity::setContentType(): Set the Content-type of this entity.
Swift_Mime_SimpleMimeEntity::setDescription(): Set the description of this entity.
Swift_Mime_SimpleMimeEntity::setEncoder(): Set the encoder used for the body of this entity.
Swift_Mime_SimpleMimeEntity::setId(): Set the CID of this entity.
Swift_Mime_SimpleMimeEntity::setMaxLineLength(): Set the maximum line length of lines in this body.
Swift_Mime_SimpleMimeEntity::toByteStream(): Write this entire entity to a Swift_InputByteStream.
Swift_Mime_SimpleMimeEntity::toString(): Get this entire entity as a string.
Swift_Mime_SimpleMimeEntity::_clearCache(): Empty the KeyCache for this entity.
Swift_Mime_SimpleMimeEntity::_fixHeaders(): Re-evaluate what content type and encoding should be used on this entity.
Swift_Mime_SimpleMimeEntity::_getCache(): Get the KeyCache used in this entity.
Swift_Mime_SimpleMimeEntity::_getHeaderFieldModel(): Get the model data (usually an array or a string) for $field.
Swift_Mime_SimpleMimeEntity::_getHeaderParameter(): Get the parameter value of $parameter on $field header.
Swift_Mime_SimpleMimeEntity::_getIdField(): Get the name of the header that provides the ID of this entity
Swift_Mime_SimpleMimeEntity::_setHeaderFieldModel(): Set the model data for $field.
Swift_Mime_SimpleMimeEntity::_setHeaderParameter(): Set the parameter value of $parameter on $field header.
Swift_Mime_SimpleMimeEntity::__destruct(): Empties it's own contents from the cache.
Swift_Mime_SimpleMimeEntity::__toString(): Returns a string representation of this object.

Class Details

[line 21]
The Message class for building emails.

Tags:

author:	Chris Corbyn
filesource:	Source Code for this file

Class Methods

static method newInstance [line 63]

static Swift_Mime_Message newInstance(
[string
$subject = null], [string
$body = null], [string
$contentType = null], [string
$charset = null])

Create a new Message.

Tags:

access:

public

Parameters:

string	$subject
string	$body
string	$contentType
string	$charset

[ Top ]

constructor __construct [line 32]

Swift_Message __construct(
[string
$subject = null], [string
$body = null], [string
$contentType = null], [string
$charset = null])

Create a new Message.

Details may be optionally passed into the constructor.

Tags:

access:

public

Overrides Swift_Mime_SimpleMessage::__construct() (Create a new SimpleMessage with $headers, $encoder and $cache.)

Parameters:

string	$subject
string	$body
string	$contentType
string	$charset

[ Top ]

method addPart [line 75]

void addPart(
string|Swift_OutputByteStream
$body, [string
$contentType = null], [string
$charset = null])

Add a MimePart to this Message.

Tags:

access:

public

Parameters:

string\|Swift_OutputByteStream	$body
string	$contentType
string	$charset

[ Top ]

Documentation generated on Mon, 05 Sep 2011 20:33:44 -0500 by phpDocumentor 1.4.3

Class: Swift_Message

Class Overview

Author(s):

Methods

Inherited Variables

Class: Swift_Mime_MimePart

Class: Swift_Mime_SimpleMimeEntity

Inherited Methods

Class: Swift_Mime_SimpleMessage

Class: Swift_Mime_MimePart

Class: Swift_Mime_SimpleMimeEntity

Class Details

Tags:

Class Methods

static method newInstance [line 63]

Tags:

Parameters:

constructor __construct [line 32]

Tags:

Parameters:

method addPart [line 75]

Tags:

Parameters: