1. class
  2. Illuminate
  3. Mail
  4. Message

Message

class Message (View source)

Methods

void
__construct( Swift_Message $swift)

Create a new message instance.

$this
from( string|array $address, string|null $name = null)

Add a "from" address to the message.

$this
sender( string|array $address, string|null $name = null)

Set the "sender" of the message.

$this
returnPath( string $address)

Set the "return path" of the message.

$this
to( string|array $address, string|null $name = null, bool $override = false)

Add a recipient to the message.

$this
cc( string|array $address, string|null $name = null)

Add a carbon copy to the message.

$this
bcc( string|array $address, string|null $name = null)

Add a blind carbon copy to the message.

$this
replyTo( string|array $address, string|null $name = null)

Add a reply to address to the message.

$this
subject( string $subject)

Set the subject of the message.

$this
priority( int $level)

Set the message priority level.

$this
attach( string $file, array $options = array())

Attach a file to the message.

$this
attachData( string $data, string $name, array $options = array())

Attach in-memory data as an attachment.

string
embed( string $file)

Embed a file in the message and get the CID.

string
embedData( string $data, string $name, string|null $contentType = null)

Embed in-memory data in the message and get the CID.

Swift_Message
getSwiftMessage()

Get the underlying Swift Message instance.

mixed
__call( string $method, array $parameters)

Dynamically pass missing methods to the Swift instance.

Details

at line line 23
void __construct( Swift_Message $swift)

Create a new message instance.

Parameters

Swift_Message $swift

Return Value

void

at line line 35
$this from( string|array $address, string|null $name = null)

Add a "from" address to the message.

Parameters

string|array $address
string|null $name

Return Value

$this

at line line 49
$this sender( string|array $address, string|null $name = null)

Set the "sender" of the message.

Parameters

string|array $address
string|null $name

Return Value

$this

at line line 62
$this returnPath( string $address)

Set the "return path" of the message.

Parameters

string $address

Return Value

$this

at line line 77
$this to( string|array $address, string|null $name = null, bool $override = false)

Add a recipient to the message.

Parameters

string|array $address
string|null $name
bool $override

Return Value

$this

at line line 95
$this cc( string|array $address, string|null $name = null)

Add a carbon copy to the message.

Parameters

string|array $address
string|null $name

Return Value

$this

at line line 107
$this bcc( string|array $address, string|null $name = null)

Add a blind carbon copy to the message.

Parameters

string|array $address
string|null $name

Return Value

$this

at line line 119
$this replyTo( string|array $address, string|null $name = null)

Add a reply to address to the message.

Parameters

string|array $address
string|null $name

Return Value

$this

at line line 149
$this subject( string $subject)

Set the subject of the message.

Parameters

string $subject

Return Value

$this

at line line 162
$this priority( int $level)

Set the message priority level.

Parameters

int $level

Return Value

$this

at line line 176
$this attach( string $file, array $options = array())

Attach a file to the message.

Parameters

string $file
array $options

Return Value

$this

at line line 202
$this attachData( string $data, string $name, array $options = array())

Attach in-memory data as an attachment.

Parameters

string $data
string $name
array $options

Return Value

$this

at line line 227
string embed( string $file)

Embed a file in the message and get the CID.

Parameters

string $file

Return Value

string

at line line 240
string embedData( string $data, string $name, string|null $contentType = null)

Embed in-memory data in the message and get the CID.

Parameters

string $data
string $name
string|null $contentType

Return Value

string

at line line 280
Swift_Message getSwiftMessage()

Get the underlying Swift Message instance.

Return Value

Swift_Message

at line line 292
mixed __call( string $method, array $parameters)

Dynamically pass missing methods to the Swift instance.

Parameters

string $method
array $parameters

Return Value

mixed