Class Swift_Mime_SimpleMessage

InheritanceSwift_Mime_SimpleMessage » Swift_Mime_MimePart » Swift_Mime_SimpleMimeEntity
ImplementsSwift_Mime_Message, Swift_Mime_MimeEntity
SubclassesSwift_Message, Swift_SignedMessage

The default email message class.

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$_userCharset The charset last specified by the user Swift_Mime_MimePart
$_userContentType Swift_Mime_SimpleMimeEntity
$_userDelSp The delsp parameter last specified by the user Swift_Mime_MimePart
$_userFormat The format parameter last specified by the user Swift_Mime_MimePart

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__clone() Make a deep copy of object. Swift_Mime_SimpleMimeEntity
__construct() Create a new SimpleMessage with $headers, $encoder and $cache. Swift_Mime_SimpleMessage
__destruct() Empties it's own contents from the cache. Swift_Mime_SimpleMimeEntity
__toString() Returns a string representation of this object. 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 {@link Swift_Mime_MimeEntity} such as an Attachment or MimePart. Swift_Mime_SimpleMessage
charsetChanged() Receive notification that the charset has changed on this document, or a parent document. Swift_Mime_MimePart
detach() Remove an already attached entity. Swift_Mime_SimpleMessage
embed() Attach a {@link Swift_Mime_MimeEntity} and return it's CID source. Swift_Mime_SimpleMessage
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
getBcc() Get the Bcc addresses of this message. Swift_Mime_SimpleMessage
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
getCc() Get the Cc address of this message. Swift_Mime_SimpleMessage
getCharset() Get the character set of this entity. Swift_Mime_MimePart
getChildren() Get all children added to this entity. Swift_Mime_SimpleMimeEntity
getContentType() Get the Content-type of this entity. Swift_Mime_SimpleMimeEntity
getDate() Get the date at which this message was created. Swift_Mime_SimpleMessage
getDelSp() Test if delsp is being used for this entity. Swift_Mime_MimePart
getDescription() Get the description of this entity. Swift_Mime_SimpleMimeEntity
getEncoder() Get the encoder used for the body of this entity. Swift_Mime_SimpleMimeEntity
getFormat() Get the format of this entity (i.e. flowed or fixed). Swift_Mime_MimePart
getFrom() Get the from address of this message. Swift_Mime_SimpleMessage
getHeaders() Get the {@link 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() Always returns {@link 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
setBody() Set the body of this entity, either as a string, or as an instance of {@link Swift_OutputByteStream}. Swift_Mime_MimePart
setBoundary() Set the boundary used to separate children in this entity. Swift_Mime_SimpleMimeEntity
setCc() Set the Cc addresses of this message. Swift_Mime_SimpleMessage
setCharset() Set the character set of this entity. Swift_Mime_MimePart
setChildren() Set all children of this entity. Swift_Mime_SimpleMimeEntity
setContentType() Set the Content-type of this entity. Swift_Mime_SimpleMimeEntity
setDate() Set the date at which this message was created. Swift_Mime_SimpleMessage
setDelSp() Turn delsp on or off for this entity. Swift_Mime_MimePart
setDescription() Set the description of this entity. Swift_Mime_SimpleMimeEntity
setEncoder() Set the encoder used for the body of this entity. Swift_Mime_SimpleMimeEntity
setFormat() Set the format of this entity (flowed or fixed). Swift_Mime_MimePart
setFrom() Set the from address of this message. Swift_Mime_SimpleMessage
setId() Set the CID of this entity. Swift_Mime_SimpleMimeEntity
setMaxLineLength() Set the maximum line length of lines in this body. Swift_Mime_SimpleMimeEntity
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 {@link Swift_InputByteStream}. Swift_Mime_SimpleMessage
toString() Get this message as a complete string. Swift_Mime_SimpleMessage

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
_becomeMimePart() Turn the body of this message into a child of itself if needed Swift_Mime_SimpleMessage
_bodyToByteStream() Write this entire entity to a {@link Swift_InputByteStream}. Swift_Mime_SimpleMimeEntity
_bodyToString() Get this entire entity as a string. Swift_Mime_SimpleMimeEntity
_clearCache() Empty the KeyCache for this entity. Swift_Mime_SimpleMimeEntity
_convertString() Encode charset when charset is not utf-8 Swift_Mime_MimePart
_fixHeaders() Fix the content-type and encoding of this entity Swift_Mime_MimePart
_getCache() Get the KeyCache used in this entity. Swift_Mime_SimpleMimeEntity
_getGrammar() Get the grammar used for validation. 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() Swift_Mime_SimpleMessage
_setHeaderFieldModel() Set the model data for $field. Swift_Mime_SimpleMimeEntity
_setHeaderParameter() Set the parameter value of $parameter on $field header. Swift_Mime_SimpleMimeEntity
_setNestingLevel() Set the nesting level of this entity Swift_Mime_MimePart
getRandomId() Returns a random Content-ID or Message-ID. Swift_Mime_SimpleMimeEntity

Method Details

__construct() public method

Create a new SimpleMessage with $headers, $encoder and $cache.

public void __construct ( Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar, $charset null )
$headers Swift_Mime_HeaderSet
$encoder Swift_Mime_ContentEncoder
$cache Swift_KeyCache
$grammar Swift_Mime_Grammar
$charset string
__toString() public method

Returns a string representation of this object.

See also toString().

public string __toString ( )
_becomeMimePart() protected method

Turn the body of this message into a child of itself if needed

protected void _becomeMimePart ( )
_getIdField() protected method
protected void _getIdField ( )
addBcc() public method

Add a Bcc: address to this message.

If $name is passed this name will be associated with the address.

public Swift_Mime_SimpleMessage addBcc ( $address, $name null )
$address string
$name string

Optional

addCc() public method

Add a Cc: address to this message.

If $name is passed this name will be associated with the address.

public Swift_Mime_SimpleMessage addCc ( $address, $name null )
$address string
$name string

Optional

addFrom() public method

Add a From: address to this message.

If $name is passed this name will be associated with the address.

public Swift_Mime_SimpleMessage addFrom ( $address, $name null )
$address string
$name string

Optional

addReplyTo() public method

Add a Reply-To: address to this message.

If $name is passed this name will be associated with the address.

public Swift_Mime_SimpleMessage addReplyTo ( $address, $name null )
$address string
$name string

Optional

addTo() public method

Add a To: address to this message.

If $name is passed this name will be associated with the address.

public Swift_Mime_SimpleMessage addTo ( $address, $name null )
$address string
$name string

Optional

attach() public method

Attach a {@link Swift_Mime_MimeEntity} such as an Attachment or MimePart.

public Swift_Mime_SimpleMessage attach ( Swift_Mime_MimeEntity $entity )
$entity Swift_Mime_MimeEntity
detach() public method

Remove an already attached entity.

public Swift_Mime_SimpleMessage detach ( Swift_Mime_MimeEntity $entity )
$entity Swift_Mime_MimeEntity
embed() public method

Attach a {@link Swift_Mime_MimeEntity} and return it's CID source.

This method should be used when embedding images or other data in a message.

public string embed ( Swift_Mime_MimeEntity $entity )
$entity Swift_Mime_MimeEntity
getBcc() public method

Get the Bcc addresses of this message.

public array getBcc ( )
getCc() public method

Get the Cc address of this message.

public array getCc ( )
getDate() public method

Get the date at which this message was created.

public int getDate ( )
getFrom() public method

Get the from address of this message.

public mixed getFrom ( )
getNestingLevel() public method

Always returns {@link LEVEL_TOP} for a message instance.

public int getNestingLevel ( )
getPriority() public method

Get the priority of this message.

The returned value is an integer where 1 is the highest priority and 5 is the lowest.

public int getPriority ( )
getReadReceiptTo() public method

Get the addresses to which a read-receipt will be sent.

public string getReadReceiptTo ( )
getReplyTo() public method

Get the reply-to address of this message.

public string getReplyTo ( )
getReturnPath() public method

Get the return-path (bounce address) of this message.

public string getReturnPath ( )
getSender() public method

Get the sender of this message.

public string getSender ( )
getSubject() public method

Get the subject of this message.

public string getSubject ( )
getTo() public method

Get the To addresses of this message.

public array getTo ( )
setBcc() public method

Set the Bcc addresses of this message.

If $name is passed and the first parameter is a string, this name will be associated with the address.

public Swift_Mime_SimpleMessage setBcc ( $addresses, $name null )
$addresses mixed
$name string

Optional

setCc() public method

Set the Cc addresses of this message.

If $name is passed and the first parameter is a string, this name will be associated with the address.

public Swift_Mime_SimpleMessage setCc ( $addresses, $name null )
$addresses mixed
$name string

Optional

setDate() public method

Set the date at which this message was created.

public Swift_Mime_SimpleMessage setDate ( $date )
$date int
setFrom() public method

Set the from address of this message.

You may pass an array of addresses if this message is from multiple people.

If $name is passed and the first parameter is a string, this name will be associated with the address.

public Swift_Mime_SimpleMessage setFrom ( $addresses, $name null )
$addresses string|array
$name string

Optional

setPriority() public method

Set the priority of this message.

The value is an integer where 1 is the highest priority and 5 is the lowest.

public Swift_Mime_SimpleMessage setPriority ( $priority )
$priority int
setReadReceiptTo() public method

Ask for a delivery receipt from the recipient to be sent to $addresses.

public Swift_Mime_SimpleMessage setReadReceiptTo ( $addresses )
$addresses array
setReplyTo() public method

Set the reply-to address of this message.

You may pass an array of addresses if replies will go to multiple people.

If $name is passed and the first parameter is a string, this name will be associated with the address.

public Swift_Mime_SimpleMessage setReplyTo ( $addresses, $name null )
$addresses mixed
$name string

Optional

setReturnPath() public method

Set the return-path (the bounce address) of this message.

public Swift_Mime_SimpleMessage setReturnPath ( $address )
$address string
setSender() public method

Set the sender of this message.

This does not override the From field, but it has a higher significance.

public Swift_Mime_SimpleMessage setSender ( $address, $name null )
$address string
$name string

Optional

setSubject() public method

Set the subject of this message.

public Swift_Mime_SimpleMessage setSubject ( $subject )
$subject string
setTo() public method

Set the to addresses of this message.

If multiple recipients will receive the message an array should be used. Example: array('receiver@domain.org', 'other@domain.org' => 'A name')

If $name is passed and the first parameter is a string, this name will be associated with the address.

public Swift_Mime_SimpleMessage setTo ( $addresses, $name null )
$addresses mixed
$name string

Optional

toByteStream() public method

Write this message to a {@link Swift_InputByteStream}.

public void toByteStream ( Swift_InputByteStream $is )
$is Swift_InputByteStream
toString() public method

Get this message as a complete string.

public string toString ( )