Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Mime_SimpleMessage

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mime/SimpleMessage.php

Class Overview

Swift_Mime_SimpleMimeEntity
   |
   --Swift_Mime_MimePart
      |
      --Swift_Mime_SimpleMessage

The default email message class.


Author(s):

  • Chris Corbyn

Implements interfaces:

Methods


Child classes:

Swift_Message
The Message class for building emails.

Inherited Variables

Inherited Methods

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::_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::_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 {@see Swift_InputByteStream}.
Swift_Mime_SimpleMimeEntity::toString()
Get this entire entity as a string.
Swift_Mime_SimpleMimeEntity::_bodyToByteStream()
Write this entire entity to a 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::_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::_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()
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::__clone()
Make a deep copy of object.
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 16]
The default email message class.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 27]

Swift_Mime_SimpleMessage __construct( Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar, [string $charset = null])

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



Tags:

access:  public


Overridden in child classes as:

Swift_Message::__construct()
Create a new Message.

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

Parameters:

Swift_Mime_HeaderSet   $headers  
Swift_Mime_ContentEncoder   $encoder  
Swift_KeyCache   $cache  
Swift_Mime_Grammar   $grammar  
string   $charset  

[ Top ]

method addBcc [line 401]

Swift_Mime_SimpleMessage addBcc( string $address, [string $name = null])

Add a Bcc: address to this message.

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




Tags:

access:  public


Parameters:

string   $address  
string   $name   optional

[ Top ]

method addCc [line 349]

Swift_Mime_SimpleMessage addCc( string $address, [string $name = null])

Add a Cc: address to this message.

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




Tags:

access:  public


Parameters:

string   $address  
string   $name   optional

[ Top ]

method addFrom [line 186]

Swift_Mime_SimpleMessage addFrom( string $address, [string $name = null])

Add a From: address to this message.

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




Tags:

access:  public


Parameters:

string   $address  
string   $name   optional

[ Top ]

method addReplyTo [line 240]

Swift_Mime_SimpleMessage addReplyTo( string $address, [string $name = null])

Add a Reply-To: address to this message.

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




Tags:

access:  public


Parameters:

string   $address  
string   $name   optional

[ Top ]

method addTo [line 294]

Swift_Mime_SimpleMessage addTo( string $address, [string $name = null])

Add a To: address to this message.

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




Tags:

access:  public


Parameters:

string   $address  
string   $name   optional

[ Top ]

method attach [line 527]

Swift_Mime_SimpleMessage attach( Swift_Mime_MimeEntity $entity)

Attach a Swift_Mime_MimeEntity such as an Attachment or MimePart.



Tags:

access:  public


Parameters:

Swift_Mime_MimeEntity   $entity  

[ Top ]

method detach [line 541]

Swift_Mime_SimpleMessage detach( Swift_Mime_MimeEntity $entity)

Remove an already attached entity.



Tags:

access:  public


Parameters:

Swift_Mime_MimeEntity   $entity  

[ Top ]

method embed [line 562]

string embed( Swift_Mime_MimeEntity $entity)

Attach a Swift_Mime_MimeEntity and return it's CID source.

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




Tags:

access:  public


Parameters:

Swift_Mime_MimeEntity   $entity  

[ Top ]

method getBcc [line 438]

array getBcc( )

Get the Bcc addresses of this message.



Tags:

access:  public



Implementation of:
Swift_Mime_Message::getBcc()
Get the Bcc addresses for this message.
[ Top ]

method getCc [line 386]

array getCc( )

Get the Cc address of this message.



Tags:

access:  public



Implementation of:
Swift_Mime_Message::getCc()
Get the Cc addresses for this message.
[ Top ]

method getDate [line 112]

int getDate( )

Get the date at which this message was created.



Tags:

access:  public



Implementation of:
Swift_Mime_Message::getDate()
Get the origination date of the message as a UNIX timestamp.
[ Top ]

method getFrom [line 225]

mixed getFrom( )

Get the from address of this message.



Tags:

access:  public



Implementation of:
Swift_Mime_Message::getFrom()
Get the From address(es) of this message.
[ Top ]

method getNestingLevel [line 60]

int getNestingLevel( )

Always returns LEVEL_TOP for a message instance.



Tags:

access:  public



Implementation of:
Swift_Mime_MimeEntity::getNestingLevel()
Get the level at which this entity shall be nested in final document.
Overrides Swift_Mime_MimePart::getNestingLevel() (Get the nesting level of this entity.)

[ Top ]

method getPriority [line 484]

int getPriority( )

Get the priority of this message.

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




Tags:

access:  public


[ Top ]

method getReadReceiptTo [line 515]

string getReadReceiptTo( )

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



Tags:

access:  public


[ Top ]

method getReplyTo [line 279]

string getReplyTo( )

Get the reply-to address of this message.



Tags:

access:  public



Implementation of:
Swift_Mime_Message::getReplyTo()
Get the Reply-To addresses for this message.
[ Top ]

method getReturnPath [line 138]

string getReturnPath( )

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



Tags:

access:  public



Implementation of:
Swift_Mime_Message::getReturnPath()
Get the return-path (bounce-detect) address.
[ Top ]

method getSender [line 171]

string getSender( )

Get the sender of this message.



Tags:

access:  public



Implementation of:
Swift_Mime_Message::getSender()
Get the sender address for this message.
[ Top ]

method getSubject [line 86]

string getSubject( )

Get the subject of this message.



Tags:

access:  public



Implementation of:
Swift_Mime_Message::getSubject()
Get the subject of the message.
[ Top ]

method getTo [line 334]

array getTo( )

Get the To addresses of this message.



Tags:

access:  public



Implementation of:
Swift_Mime_Message::getTo()
Get the To addresses for this message.
[ Top ]

method setBcc [line 420]

Swift_Mime_SimpleMessage setBcc( mixed $addresses, [string $name = null])

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.




Tags:

access:  public



Implementation of:
Swift_Mime_Message::setBcc()
Set the Bcc address(es).

Parameters:

mixed   $addresses  
string   $name   optional

[ Top ]

method setCc [line 368]

Swift_Mime_SimpleMessage setCc( mixed $addresses, [string $name = null])

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.




Tags:

access:  public



Implementation of:
Swift_Mime_Message::setCc()
Set the Cc address(es).

Parameters:

mixed   $addresses  
string   $name   optional

[ Top ]

method setDate [line 98]

Swift_Mime_SimpleMessage setDate( int $date)

Set the date at which this message was created.



Tags:

access:  public



Implementation of:
Swift_Mime_Message::setDate()
Set the origination date of the message as a UNIX timestamp.

Parameters:

int   $date  

[ Top ]

method setFrom [line 207]

Swift_Mime_SimpleMessage setFrom( string|array $addresses, [string $name = null])

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.




Tags:

access:  public



Implementation of:
Swift_Mime_Message::setFrom()
Set the From address of this message.

Parameters:

string|array   $addresses  
string   $name   optional

[ Top ]

method setPriority [line 452]

Swift_Mime_SimpleMessage setPriority( int $priority)

Set the priority of this message.

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




Tags:

access:  public


Parameters:

int   $priority  

[ Top ]

method setReadReceiptTo [line 500]

Swift_Mime_SimpleMessage setReadReceiptTo( array $addresses)

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



Tags:

access:  public


Parameters:

array   $addresses  

[ Top ]

method setReplyTo [line 261]

Swift_Mime_SimpleMessage setReplyTo( mixed $addresses, [string $name = null])

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.




Tags:

access:  public



Implementation of:
Swift_Mime_Message::setReplyTo()
Set the Reply-To address(es).

Parameters:

mixed   $addresses  
string   $name   optional

[ Top ]

method setReturnPath [line 124]

Swift_Mime_SimpleMessage setReturnPath( string $address)

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



Tags:

access:  public



Implementation of:
Swift_Mime_Message::setReturnPath()
Set the return-path (bounce-detect) address.

Parameters:

string   $address  

[ Top ]

method setSender [line 153]

Swift_Mime_SimpleMessage setSender( string $address, [string $name = null])

Set the sender of this message.

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




Tags:

access:  public



Implementation of:
Swift_Mime_Message::setSender()
Set the sender of this message.

Parameters:

string   $address  
string   $name   optional

[ Top ]

method setSubject [line 72]

Swift_Mime_SimpleMessage setSubject( string $subject)

Set the subject of this message.



Tags:

access:  public



Implementation of:
Swift_Mime_Message::setSubject()
Set the subject of the message.

Parameters:

string   $subject  

[ Top ]

method setTo [line 316]

Swift_Mime_SimpleMessage setTo( mixed $addresses, [string $name = null])

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.




Tags:

access:  public



Implementation of:
Swift_Mime_Message::setTo()
Set the To address(es).

Parameters:

mixed   $addresses  
string   $name   optional

[ Top ]

method toByteStream [line 604]

void toByteStream( Swift_InputByteStream $is)

Write this message to a Swift_InputByteStream.



Tags:

access:  public


Overridden in child classes as:

Swift_Message::toByteStream()
Write this message to a Swift_InputByteStream.


Implementation of:
Swift_Mime_MimeEntity::toByteStream()
Get this entire entity as a ByteStream.
Overrides Swift_Mime_SimpleMimeEntity::toByteStream() (Write this entire entity to a {@see Swift_InputByteStream}.)

Parameters:

Swift_InputByteStream   $is  

[ Top ]

method toString [line 574]

string toString( )

Get this message as a complete string.



Tags:

access:  public


Overridden in child classes as:

Swift_Message::toString()
Get this message as a complete string.


Implementation of:
Swift_Mime_MimeEntity::toString()
Get this entire entity in its string form.
Overrides Swift_Mime_SimpleMimeEntity::toString() (Get this entire entity as a string.)

[ Top ]

method _becomeMimePart [line 622]

void _becomeMimePart( )

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



Tags:

access:  protected


[ Top ]

method _getIdField [line 616]

void _getIdField( )



Tags:

see:  Swift_Mime_SimpleMimeEntity::_getIdField()
access:  protected


Overrides Swift_Mime_SimpleMimeEntity::_getIdField() (Get the name of the header that provides the ID of this entity.)

[ Top ]

method __toString [line 594]

string __toString( )

Returns a string representation of this object.



Tags:

see:  Swift_Mime_SimpleMessage::toString()
access:  public


Overrides Swift_Mime_SimpleMimeEntity::__toString() (Returns a string representation of this object.)

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:54:39 +0000 by phpDocumentor 1.4.3