W3cubDocs

/Laravel 5.1

Message

class Message (View source)

Methods

void __construct( Swift_Message $swift)

Create a new message instance.
$this from( string $address, string|null $name = null)

Add a "from" address to the message.
$this sender( string $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 $address, string|null $name = null)

Add a carbon copy to the message.
$this bcc( string $address, string|null $name = null)

Add a blind carbon copy to the message.
$this replyTo( string $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

void __construct( Swift_Message $swift)

Create a new message instance.

Parameters

Swift_Message $swift

Return Value

void

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

Add a "from" address to the message.

Parameters

string $address
string|null $name

Return Value

$this

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

Set the "sender" of the message.

Parameters

string $address
string|null $name

Return Value

$this

$this returnPath( string $address)

Set the "return path" of the message.

Parameters

string $address

Return Value

$this

$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

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

Add a carbon copy to the message.

Parameters

string $address
string|null $name

Return Value

$this

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

Add a blind carbon copy to the message.

Parameters

string $address
string|null $name

Return Value

$this

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

Add a reply to address to the message.

Parameters

string $address
string|null $name

Return Value

$this

$this subject( string $subject)

Set the subject of the message.

Parameters

string $subject

Return Value

$this

$this priority( int $level)

Set the message priority level.

Parameters

int $level

Return Value

$this

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

Attach a file to the message.

Parameters

string $file
array $options

Return Value

$this

$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

string embed( string $file)

Embed a file in the message and get the CID.

Parameters

string $file

Return Value

string

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

Swift_Message getSwiftMessage()

Get the underlying Swift Message instance.

Return Value

Swift_Message

mixed __call( string $method, array $parameters)

Dynamically pass missing methods to the Swift instance.

Parameters

string $method
array $parameters

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Mail/Message.html