TYPO3  7.6
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
Swift_Message Class Reference
Inheritance diagram for Swift_Message:
Swift_Mime_SimpleMessage Swift_Mime_MimePart Swift_Mime_Message Swift_Mime_SimpleMimeEntity Swift_Mime_MimeEntity Swift_Mime_MimeEntity Swift_Mime_CharsetObserver Swift_Mime_EncodingObserver Swift_Mime_CharsetObserver Swift_Mime_EncodingObserver Swift_SignedMessage MailMessage

Public Member Functions

 __construct ($subject=null, $body=null, $contentType=null, $charset=null)
 
 addPart ($body, $contentType=null, $charset=null)
 
 attachSigner (Swift_Signer $signer)
 
 detachSigner (Swift_Signer $signer)
 
 toString ()
 
 toByteStream (Swift_InputByteStream $is)
 
 __wakeup ()
 
 __clone ()
 
- Public Member Functions inherited from Swift_Mime_SimpleMessage
 __construct (Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar, $charset=null)
 
 getNestingLevel ()
 
 setSubject ($subject)
 
 getSubject ()
 
 setDate ($date)
 
 getDate ()
 
 setReturnPath ($address)
 
 getReturnPath ()
 
 setSender ($address, $name=null)
 
 getSender ()
 
 addFrom ($address, $name=null)
 
 setFrom ($addresses, $name=null)
 
 getFrom ()
 
 addReplyTo ($address, $name=null)
 
 setReplyTo ($addresses, $name=null)
 
 getReplyTo ()
 
 addTo ($address, $name=null)
 
 setTo ($addresses, $name=null)
 
 getTo ()
 
 addCc ($address, $name=null)
 
 setCc ($addresses, $name=null)
 
 getCc ()
 
 addBcc ($address, $name=null)
 
 setBcc ($addresses, $name=null)
 
 getBcc ()
 
 setPriority ($priority)
 
 getPriority ()
 
 setReadReceiptTo ($addresses)
 
 getReadReceiptTo ()
 
 attach (Swift_Mime_MimeEntity $entity)
 
 detach (Swift_Mime_MimeEntity $entity)
 
 embed (Swift_Mime_MimeEntity $entity)
 
 toString ()
 
 __toString ()
 
 toByteStream (Swift_InputByteStream $is)
 
- Public Member Functions inherited from Swift_Mime_MimePart
 __construct (Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar, $charset=null)
 
 setBody ($body, $contentType=null, $charset=null)
 
 getCharset ()
 
 setCharset ($charset)
 
 getFormat ()
 
 setFormat ($format)
 
 getDelSp ()
 
 setDelSp ($delsp=true)
 
 getNestingLevel ()
 
 charsetChanged ($charset)
 
- Public Member Functions inherited from Swift_Mime_SimpleMimeEntity
 __construct (Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar)
 
 generateId ()
 
 getHeaders ()
 
 getNestingLevel ()
 
 getContentType ()
 
 setContentType ($type)
 
 getId ()
 
 setId ($id)
 
 getDescription ()
 
 setDescription ($description)
 
 getMaxLineLength ()
 
 setMaxLineLength ($length)
 
 getChildren ()
 
 setChildren (array $children, $compoundLevel=null)
 
 getBody ()
 
 setBody ($body, $contentType=null)
 
 getEncoder ()
 
 setEncoder (Swift_Mime_ContentEncoder $encoder)
 
 getBoundary ()
 
 setBoundary ($boundary)
 
 charsetChanged ($charset)
 
 encoderChanged (Swift_Mime_ContentEncoder $encoder)
 
 toString ()
 
 __toString ()
 
 toByteStream (Swift_InputByteStream $is)
 
 __destruct ()
 
 __clone ()
 
- Public Member Functions inherited from Swift_Mime_MimeEntity
 setChildren (array $children)
 
- Public Member Functions inherited from Swift_Mime_Message
 generateId ()
 

Static Public Member Functions

static newInstance ($subject=null, $body=null, $contentType=null, $charset=null)
 

Protected Member Functions

 doSign ()
 
 saveMessage ()
 
 saveHeaders (array $altered)
 
 restoreHeaders ()
 
 restoreMessage ()
 
- Protected Member Functions inherited from Swift_Mime_SimpleMessage
 _getIdField ()
 
 _becomeMimePart ()
 
- Protected Member Functions inherited from Swift_Mime_MimePart
 _fixHeaders ()
 
 _setNestingLevel ($level)
 
 _convertString ($string)
 
- Protected Member Functions inherited from Swift_Mime_SimpleMimeEntity
 _bodyToString ()
 
 _bodyToByteStream (Swift_InputByteStream $is)
 
 _getIdField ()
 
 _getHeaderFieldModel ($field)
 
 _setHeaderFieldModel ($field, $model)
 
 _getHeaderParameter ($field, $parameter)
 
 _setHeaderParameter ($field, $parameter, $value)
 
 _fixHeaders ()
 
 _getCache ()
 
 _getGrammar ()
 
 _clearCache ()
 
 getRandomId ()
 

Private Attributes

 $headerSigners = array()
 
 $bodySigners = array()
 
 $savedMessage = array()
 

Additional Inherited Members

- Public Attributes inherited from Swift_Mime_MimeEntity
const LEVEL_TOP = 16
 
const LEVEL_MIXED = 256
 
const LEVEL_ALTERNATIVE = 4096
 
const LEVEL_RELATED = 65536
 
- Protected Attributes inherited from Swift_Mime_MimePart
 $_userFormat
 
 $_userCharset
 
 $_userDelSp
 

Detailed Description

The Message class for building emails.

Author
Chris Corbyn

Definition at line 16 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Message.php.

Constructor & Destructor Documentation

__construct (   $subject = null,
  $body = null,
  $contentType = null,
  $charset = null 
)

Create a new Message.

Details may be optionally passed into the constructor.

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

Definition at line 43 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Message.php.

References Swift_DependencyContainer\getInstance(), Swift_Mime_MimePart\setBody(), Swift_Mime_MimePart\setCharset(), Swift_Mime_SimpleMimeEntity\setContentType(), and Swift_Mime_SimpleMessage\setSubject().

Member Function Documentation

__clone ( )
__wakeup ( )
addPart (   $body,
  $contentType = null,
  $charset = null 
)

Add a MimePart to this Message.

Parameters
string | Swift_OutputByteStream$body
string$contentType
string$charset
Returns
Swift_Mime_SimpleMessage

Definition at line 87 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Message.php.

References Swift_Mime_SimpleMessage\attach(), and Swift_MimePart\newInstance().

attachSigner ( Swift_Signer  $signer)

Attach a new signature handler to the message.

Parameters
Swift_Signer$signer
Returns
Swift_Message

Definition at line 101 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Message.php.

References elseif.

detachSigner ( Swift_Signer  $signer)

Attach a new signature handler to the message.

Parameters
Swift_Signer$signer
Returns
Swift_Message

Definition at line 119 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Message.php.

References elseif.

doSign ( )
protected

loops through signers and apply the signatures.

Definition at line 194 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Message.php.

References Swift_Mime_SimpleMimeEntity\_bodyToByteStream(), Swift_Mime_MimeEntity\getHeaders(), and saveHeaders().

Referenced by toByteStream(), and toString().

static newInstance (   $subject = null,
  $body = null,
  $contentType = null,
  $charset = null 
)
static

Create a new Message.

Parameters
string$subject
string$body
string$contentType
string$charset
Returns
Swift_Message

Definition at line 73 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Message.php.

restoreHeaders ( )
protected

Remove or restore altered headers.

Definition at line 250 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Message.php.

References Swift_Mime_MimeEntity\getHeaders().

Referenced by restoreMessage().

restoreMessage ( )
protected
saveHeaders ( array  $altered)
protected

save the original headers.

Parameters
array$altered

Definition at line 236 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Message.php.

References Swift_Mime_MimeEntity\getHeaders().

Referenced by doSign().

saveMessage ( )
protected
toByteStream ( Swift_InputByteStream  $is)
toString ( )

Get this message as a complete string.

Returns
string

Implements Swift_Mime_MimeEntity.

Definition at line 147 of file vendor/swiftmailer/swiftmailer/lib/classes/Swift/Message.php.

References doSign(), restoreMessage(), and saveMessage().

Member Data Documentation

$bodySigners = array()
private
$headerSigners = array()
private
$savedMessage = array()
private