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

Class: Swift_Mime_Message

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

Interface Overview

Swift_Mime_CharsetObserver
   |
   --Swift_Mime_MimeEntity
      |
      --Swift_Mime_Message

A Message (RFC 2822) object.


Author(s):

  • Chris Corbyn

Methods


Inherited Constants

Inherited Methods

Class: Swift_Mime_MimeEntity

Swift_Mime_MimeEntity::getBody()
Get the body content of this entity as a string.
Swift_Mime_MimeEntity::getChildren()
Get all children nested inside this entity.
Swift_Mime_MimeEntity::getContentType()
Get the qualified content-type of this mime entity.
Swift_Mime_MimeEntity::getHeaders()
Get the collection of Headers in this Mime entity.
Swift_Mime_MimeEntity::getId()
Returns a unique ID for this entity.
Swift_Mime_MimeEntity::getNestingLevel()
Get the level at which this entity shall be nested in final document.
Swift_Mime_MimeEntity::setBody()
Set the body content of this entity as a string.
Swift_Mime_MimeEntity::setChildren()
Set all children nested inside this entity.
Swift_Mime_MimeEntity::toByteStream()
Get this entire entity as a ByteStream.
Swift_Mime_MimeEntity::toString()
Get this entire entity in its string form.

Class: Swift_Mime_CharsetObserver

Swift_Mime_CharsetObserver::charsetChanged()
Notify this observer that the entity's charset has changed.

Class Details

[line 16]
A Message (RFC 2822) object.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


method generateId [line 23]

string generateId( )

Generates a valid Message-ID and switches to it.



Tags:

access:  public


[ Top ]

method getBcc [line 222]

string[] getBcc( )

Get the Bcc addresses for this message.

This method always returns an associative array, whereby the keys provide the actual email addresses.




Tags:

access:  public


[ Top ]

method getCc [line 196]

string[] getCc( )

Get the Cc addresses for this message.

This method always returns an associative array, whereby the keys provide the actual email addresses.




Tags:

access:  public


[ Top ]

method getDate [line 51]

int getDate( )

Get the origination date of the message as a UNIX timestamp.



Tags:

access:  public


[ Top ]

method getFrom [line 122]

string[] getFrom( )

Get the From address(es) of this message.

This method always returns an associative array where the keys are the addresses.




Tags:

access:  public


[ Top ]

method getReplyTo [line 149]

string[] getReplyTo( )

Get the Reply-To addresses for this message.

This method always returns an associative array where the keys provide the email addresses.




Tags:

access:  public


[ Top ]

method getReturnPath [line 65]

string getReturnPath( )

Get the return-path (bounce-detect) address.



Tags:

access:  public


[ Top ]

method getSender [line 93]

string getSender( )

Get the sender address for this message.

This has a higher significance than the From address.




Tags:

access:  public


[ Top ]

method getSubject [line 37]

string getSubject( )

Get the subject of the message.



Tags:

access:  public


[ Top ]

method getTo [line 174]

string[] getTo( )

Get the To addresses for this message.

This method always returns an associative array, whereby the keys provide the actual email addresses.




Tags:

access:  public


[ Top ]

method setBcc [line 212]

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

Set the Bcc address(es).

Recipients set in this field will receive a 'blind-carbon-copy' of this message.

In other words, they will get the message, but any other recipients of the message will have no such knowledge of their receipt of it.

This method has the same synopsis as setFrom() and setTo().




Tags:

access:  public


Parameters:

mixed   $addresses  
string   $name   optional

[ Top ]

method setCc [line 186]

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

Set the Cc address(es).

Recipients set in this field will receive a 'carbon-copy' of this message.

This method has the same synopsis as setFrom() and setTo().




Tags:

access:  public


Parameters:

mixed   $addresses  
string   $name   optional

[ Top ]

method setDate [line 44]

void setDate( int $date)

Set the origination date of the message as a UNIX timestamp.



Tags:

access:  public


Parameters:

int   $date  

[ Top ]

method setFrom [line 112]

void setFrom( mixed $addresses, [string $name = null])

Set the From address of this message.

It is permissible for multiple From addresses to be set using an array.

If multiple From addresses are used, you SHOULD set the Sender address and according to RFC 2822, MUST set the sender address.

An array can be used if display names are to be provided: i.e. array('email@address.com' => 'Real Name').

If the second parameter is provided and the first is a string, then $name is associated with the address.




Tags:

access:  public


Parameters:

mixed   $addresses  
string   $name   optional

[ Top ]

method setReplyTo [line 139]

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

Set the Reply-To address(es).

Any replies from the receiver will be sent to this address.

It is permissible for multiple reply-to addresses to be set using an array.

This method has the same synopsis as setFrom() and setTo().

If the second parameter is provided and the first is a string, then $name is associated with the address.




Tags:

access:  public


Parameters:

mixed   $addresses  
string   $name   optional

[ Top ]

method setReturnPath [line 58]

void setReturnPath( string $address)

Set the return-path (bounce-detect) address.



Tags:

access:  public


Parameters:

string   $address  

[ Top ]

method setSender [line 84]

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

Set the sender of this message.

If multiple addresses are present in the From field, this SHOULD be set.

According to RFC 2822 it is a requirement when there are multiple From addresses, but Swift itself does not require it directly.

An associative array (with one element!) can be used to provide a display- name: i.e. array('email@address' => 'Real Name').

If the second parameter is provided and the first is a string, then $name is associated with the address.




Tags:

access:  public


Parameters:

mixed   $address  
string   $name   optional

[ Top ]

method setSubject [line 30]

void setSubject( string $subject)

Set the subject of the message.



Tags:

access:  public


Parameters:

string   $subject  

[ Top ]

method setTo [line 164]

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

Set the To address(es).

Recipients set in this field will receive a copy of this message.

This method has the same synopsis as setFrom() and setCc().

If the second parameter is provided and the first is a string, then $name is associated with the address.




Tags:

access:  public


Parameters:

mixed   $addresses  
string   $name   optional

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:52:15 +0000 by phpDocumentor 1.4.3