Class Swift_Mime_SimpleMessage

The default email message class.

Swift_Mime_SimpleMimeEntity implements Swift_Mime_MimeEntity

Swift_Mime_SimpleMessage implements Swift_Mime_Message

Direct known subclasses

Package: Swift\Mime
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/Mime/SimpleMessage.php

Methods summary
`public`	# `__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. Create a new SimpleMessage with $headers, $encoder and $cache. Parameters `$headers` `$encoder` `$cache` `$grammar` `$charset` Overrides `Swift_Mime_MimePart::__construct()`
`public integer`	# `getNestingLevel( )` Always returns `Swift_Mime_MimeEntity::LEVEL_TOP` for a message instance. Always returns `Swift_Mime_MimeEntity::LEVEL_TOP` for a message instance. Returns integer Overrides `Swift_Mime_MimePart::getNestingLevel()` Implementation of `Swift_Mime_MimeEntity::getNestingLevel()`
`public Swift_Mime_SimpleMessage`	# `setSubject( string $subject )` Set the subject of this message. Set the subject of this message. Parameters `$subject` Returns `Swift_Mime_SimpleMessage` Implementation of `Swift_Mime_Message::setSubject()`
`public string`	# `getSubject( )` Get the subject of this message. Get the subject of this message. Returns string Implementation of `Swift_Mime_Message::getSubject()`
`public Swift_Mime_SimpleMessage`	# `setDate( integer $date )` Set the date at which this message was created. Set the date at which this message was created. Parameters `$date` Returns `Swift_Mime_SimpleMessage` Implementation of `Swift_Mime_Message::setDate()`
`public integer`	# `getDate( )` Get the date at which this message was created. Get the date at which this message was created. Returns integer Implementation of `Swift_Mime_Message::getDate()`
`public Swift_Mime_SimpleMessage`	# `setReturnPath( string $address )` Set the return-path (the bounce address) of this message. Set the return-path (the bounce address) of this message. Parameters `$address` Returns `Swift_Mime_SimpleMessage` Implementation of `Swift_Mime_Message::setReturnPath()`
`public string`	# `getReturnPath( )` Get the return-path (bounce address) of this message. Get the return-path (bounce address) of this message. Returns string Implementation of `Swift_Mime_Message::getReturnPath()`
`public 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. Set the sender of this message. This does not override the From field, but it has a higher significance. Parameters `$address` $sender `$name` optional Returns `Swift_Mime_SimpleMessage` Implementation of `Swift_Mime_Message::setSender()`
`public string`	# `getSender( )` Get the sender of this message. Get the sender of this message. Returns string Implementation of `Swift_Mime_Message::getSender()`
`public`	# `addFrom( string $address, string $name = null )` Add a From: address to this message. Add a From: address to this message. If $name is passed this name will be associated with the address. Parameters `$address` `$name` optional
`public Swift_Mime_SimpleMessage`	# `setFrom( string $addresses, string $name = null )` Set the from address of this message. 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. Parameters `$addresses` `$name` optional Returns `Swift_Mime_SimpleMessage` Implementation of `Swift_Mime_Message::setFrom()`
`public string`	# `getFrom( )` Get the from address of this message. Get the from address of this message. Returns string Implementation of `Swift_Mime_Message::getFrom()`
`public Swift_Mime_SimpleMessage`	# `addReplyTo( string $address, string $name = null )` Add a Reply-To: address to this message. Add a Reply-To: address to this message. If $name is passed this name will be associated with the address. Parameters `$address` `$name` optional Returns `Swift_Mime_SimpleMessage`
`public Swift_Mime_SimpleMessage`	# `setReplyTo( string $addresses, string $name = null )` Set the reply-to address of this message. 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. Parameters `$addresses` `$name` optional Returns `Swift_Mime_SimpleMessage` Implementation of `Swift_Mime_Message::setReplyTo()`
`public string`	# `getReplyTo( )` Get the reply-to address of this message. Get the reply-to address of this message. Returns string Implementation of `Swift_Mime_Message::getReplyTo()`
`public Swift_Mime_SimpleMessage`	# `addTo( string $address, string $name = null )` Add a To: address to this message. Add a To: address to this message. If $name is passed this name will be associated with the address. Parameters `$address` `$name` optional Returns `Swift_Mime_SimpleMessage`
`public Swift_Mime_SimpleMessage`	# `setTo( array $addresses, string $name = null )` Set the to addresses of this message. Set the to addresses of this message. If multiple recipients will receive the message and array should be used. If $name is passed and the first parameter is a string, this name will be associated with the address. Parameters `$addresses` `$name` optional Returns `Swift_Mime_SimpleMessage` Implementation of `Swift_Mime_Message::setTo()`
`public array`	# `getTo( )` Get the To addresses of this message. Get the To addresses of this message. Returns array Implementation of `Swift_Mime_Message::getTo()`
`public Swift_Mime_SimpleMessage`	# `addCc( string $address, string $name = null )` Add a Cc: address to this message. Add a Cc: address to this message. If $name is passed this name will be associated with the address. Parameters `$address` `$name` optional Returns `Swift_Mime_SimpleMessage`
`public Swift_Mime_SimpleMessage`	# `setCc( array $addresses, string $name = null )` Set the Cc addresses of this message. 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. Parameters `$addresses` `$name` optional Returns `Swift_Mime_SimpleMessage` Implementation of `Swift_Mime_Message::setCc()`
`public array`	# `getCc( )` Get the Cc address of this message. Get the Cc address of this message. Returns array Implementation of `Swift_Mime_Message::getCc()`
`public Swift_Mime_SimpleMessage`	# `addBcc( string $address, string $name = null )` Add a Bcc: address to this message. Add a Bcc: address to this message. If $name is passed this name will be associated with the address. Parameters `$address` `$name` optional Returns `Swift_Mime_SimpleMessage`
`public Swift_Mime_SimpleMessage`	# `setBcc( array $addresses, string $name = null )` Set the Bcc addresses of this message. 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. Parameters `$addresses` `$name` optional Returns `Swift_Mime_SimpleMessage` Implementation of `Swift_Mime_Message::setBcc()`
`public array`	# `getBcc( )` Get the Bcc addresses of this message. Get the Bcc addresses of this message. Returns array Implementation of `Swift_Mime_Message::getBcc()`
`public Swift_Mime_SimpleMessage`	# `setPriority( integer $priority )` Set the priority of this message. The value is an integer where 1 is the highest priority and 5 is the lowest. Set the priority of this message. The value is an integer where 1 is the highest priority and 5 is the lowest. Parameters `$priority` Returns `Swift_Mime_SimpleMessage`
`public integer`	# `getPriority( )` Get the priority of this message. The returned value is an integer where 1 is the highest priority and 5 is the lowest. Get the priority of this message. The returned value is an integer where 1 is the highest priority and 5 is the lowest. Returns integer
`public Swift_Mime_SimpleMessage`	# `setReadReceiptTo( array $addresses )` Ask for a delivery receipt from the recipient to be sent to $addresses Ask for a delivery receipt from the recipient to be sent to $addresses Parameters `$addresses` Returns `Swift_Mime_SimpleMessage`
`public string`	# `getReadReceiptTo( )` Get the addresses to which a read-receipt will be sent. Get the addresses to which a read-receipt will be sent. Returns string
`public Swift_Mime_SimpleMessage`	# `attach( Swift_Mime_MimeEntity $entity )` Attach a `Swift_Mime_MimeEntity` such as an Attachment or MimePart. Attach a `Swift_Mime_MimeEntity` such as an Attachment or MimePart. Parameters `$entity` Returns `Swift_Mime_SimpleMessage`
`public Swift_Mime_SimpleMessage`	# `detach( Swift_Mime_MimeEntity $entity )` Remove an already attached entity. Remove an already attached entity. Parameters `$entity` Returns `Swift_Mime_SimpleMessage`
`public 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. 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. Parameters `$entity` Returns string
`public string`	# `toString( )` Get this message as a complete string. Get this message as a complete string. Returns string Overrides `Swift_Mime_SimpleMimeEntity::toString()` Implementation of `Swift_Mime_MimeEntity::toString()`
`public string`	# `__toString( )` Returns a string representation of this object. Returns a string representation of this object. Returns string See `Swift_Mime_SimpleMessage::toString()` Overrides `Swift_Mime_SimpleMimeEntity::__toString()`
`public`	# `toByteStream( Swift_InputByteStream $is )` Write this message to a `Swift_InputByteStream`. Write this message to a `Swift_InputByteStream`. Parameters `$is` Overrides `Swift_Mime_SimpleMimeEntity::toByteStream()` Implementation of `Swift_Mime_MimeEntity::toByteStream()`
`protected`	# `_getIdField( )` See `Swift_Mime_SimpleMimeEntity::_getIdField()` Overrides `Swift_Mime_SimpleMimeEntity::_getIdField()`
`private`	# `_becomeMimePart( )` Turn the body of this message into a child of itself if needed Turn the body of this message into a child of itself if needed
`private`	# `_getTopNestingLevel( )` Get the highest nesting level nested inside this message Get the highest nesting level nested inside this message

Methods inherited from Swift_Mime_MimePart
`_convertString(), _fixHeaders(), _setNestingLevel(), charsetChanged(), getCharset(), getDelSp(), getFormat(), setBody(), setCharset(), setDelSp(), setFormat()`

Methods inherited from Swift_Mime_SimpleMimeEntity
`__destruct(), _clearCache(), _getCache(), _getGrammar(), _getHeaderFieldModel(), _getHeaderParameter(), _setHeaderFieldModel(), _setHeaderParameter(), encoderChanged(), generateId(), getBody(), getBoundary(), getChildren(), getContentType(), getDescription(), getEncoder(), getHeaders(), getId(), getMaxLineLength(), getRandomId(), setBoundary(), setChildren(), setContentType(), setDescription(), setEncoder(), setId(), setMaxLineLength()`

Constants inherited from Swift_Mime_MimeEntity
`LEVEL_ALTERNATIVE, LEVEL_MIXED, LEVEL_RELATED, LEVEL_TOP`

Properties inherited from Swift_Mime_MimePart
`$_userCharset, $_userDelSp, $_userFormat`

Properties inherited from Swift_Mime_SimpleMimeEntity
`$_userContentType`

Packages

Classes

Interfaces

Class Swift_Mime_SimpleMessage

Direct known subclasses

Parameters

Overrides

Returns

Overrides

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Overrides

Implementation of

Returns