Symfony\Component\Mime\Email Class Reference

Inheritance diagram for Symfony\Component\Mime\Email:

Public Member Functions
	__serialize ()
	__unserialize (array $data)
	addBcc (... $addresses)
	addCc (... $addresses)
	addFrom (... $addresses)
	addReplyTo (... $addresses)
	addTo (... $addresses)
	attach ($body, string $name=null, string $contentType=null)
	attachFromPath (string $path, string $name=null, string $contentType=null)
	attachPart (DataPart $part)
	bcc (... $addresses)
	cc (... $addresses)
	date (\DateTimeInterface $dateTime)
	embed ($body, string $name=null, string $contentType=null)
	embedFromPath (string $path, string $name=null, string $contentType=null)
	ensureValidity ()
	from (... $addresses)
	getAttachments ()
	getBcc ()
	getBody ()
	getCc ()
	getDate ()
	getFrom ()
	getHtmlBody ()
	getHtmlCharset ()
	getPriority ()
	getReplyTo ()
	getReturnPath ()
	getSender ()
	getSubject ()
	getTextBody ()
	getTextCharset ()
	getTo ()
	html ($body, string $charset='utf-8')
	priority (int $priority)
	replyTo (... $addresses)
	returnPath ($address)
	sender ($address)
	subject (string $subject)
	text ($body, string $charset='utf-8')
	to (... $addresses)
Public Member Functions inherited from Symfony\Component\Mime\Message
	__clone ()
	__construct (Headers $headers=null, AbstractPart $body=null)
	generateMessageId ()
	getHeaders ()
	getPreparedHeaders ()
	setBody (AbstractPart $body=null)
	setHeaders (Headers $headers)
	toIterable ()
	toString ()
Public Member Functions inherited from Symfony\Component\Mime\RawMessage
	__construct ($message)
	serialize ()
	unserialize ($serialized)

Data Fields
const	PRIORITY_HIGH = 2
const	PRIORITY_HIGHEST = 1
const	PRIORITY_LOW = 4
const	PRIORITY_LOWEST = 5
const	PRIORITY_NORMAL = 3

Detailed Description

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 25 of file Email.php.

Member Function Documentation

__serialize()

Symfony\Component\Mime\Email::__serialize

(

)

Reimplemented from Symfony\Component\Mime\Message.

Definition at line 559 of file Email.php.

References Symfony\Component\Mime\Email\html(), and Symfony\Component\Mime\Email\text().

__unserialize()

Symfony\Component\Mime\Email::__unserialize

(

array

$data

)

Reimplemented from Symfony\Component\Mime\Message.

Definition at line 593 of file Email.php.

addBcc()

Symfony\Component\Mime\Email::addBcc

(

$addresses

)

Parameters

Address|string

...$addresses

Returns

$this

Definition at line 220 of file Email.php.

addCc()

Symfony\Component\Mime\Email::addCc

(

$addresses

)

Parameters

Address|string

...$addresses

Returns

$this

Definition at line 192 of file Email.php.

addFrom()

Symfony\Component\Mime\Email::addFrom

(

$addresses

)

Parameters

Address|string

...$addresses

Returns

$this

Definition at line 108 of file Email.php.

addReplyTo()

Symfony\Component\Mime\Email::addReplyTo

(

$addresses

)

Parameters

Address|string

...$addresses

Returns

$this

Definition at line 136 of file Email.php.

addTo()

Symfony\Component\Mime\Email::addTo

(

$addresses

)

Parameters

Address|string

...$addresses

Returns

$this

Definition at line 164 of file Email.php.

attach()

Symfony\Component\Mime\Email::attach	(		$body,
		string	$name = null,
		string	$contentType = null
	)

Parameters

resource | string

$body

Returns

$this

Definition at line 331 of file Email.php.

attachFromPath()

Symfony\Component\Mime\Email::attachFromPath	(	string	$path,
		string	$name = null,
		string	$contentType = null
	)

Returns

$this

Definition at line 341 of file Email.php.

attachPart()

Symfony\Component\Mime\Email::attachPart

(

DataPart

$part

)

Returns

$this

Definition at line 373 of file Email.php.

bcc()

Symfony\Component\Mime\Email::bcc

(

$addresses

)

Parameters

Address|string

...$addresses

Returns

$this

Definition at line 230 of file Email.php.

cc()

Symfony\Component\Mime\Email::cc

(

$addresses

)

Parameters

Address|string

...$addresses

Returns

$this

Definition at line 202 of file Email.php.

date()

Symfony\Component\Mime\Email::date

(

\DateTimeInterface

$dateTime

)

Returns

$this

Definition at line 63 of file Email.php.

embed()

Symfony\Component\Mime\Email::embed	(		$body,
		string	$name = null,
		string	$contentType = null
	)

Parameters

resource | string

$body

Returns

$this

Definition at line 353 of file Email.php.

embedFromPath()

Symfony\Component\Mime\Email::embedFromPath	(	string	$path,
		string	$name = null,
		string	$contentType = null
	)

Returns

$this

Definition at line 363 of file Email.php.

ensureValidity()

Symfony\Component\Mime\Email::ensureValidity

(

)

Exceptions

LogicException

if the message is not valid

Reimplemented from Symfony\Component\Mime\Message.

Definition at line 402 of file Email.php.

References Symfony\Component\Mime\Email\html(), and Symfony\Component\Mime\Email\text().

from()

Symfony\Component\Mime\Email::from

(

$addresses

)

Parameters

Address|string

...$addresses

Returns

$this

Definition at line 118 of file Email.php.

getAttachments()

Symfony\Component\Mime\Email::getAttachments

(

)

Returns

DataPart[]

Definition at line 383 of file Email.php.

getBcc()

Symfony\Component\Mime\Email::getBcc

(

)

Returns

Address[]

Definition at line 238 of file Email.php.

References Symfony\Component\Mime\Message\getHeaders().

getBody()

Symfony\Component\Mime\Email::getBody

(

)

Reimplemented from Symfony\Component\Mime\Message.

Definition at line 393 of file Email.php.

getCc()

Symfony\Component\Mime\Email::getCc

(

)

Returns

Address[]

Definition at line 210 of file Email.php.

References Symfony\Component\Mime\Message\getHeaders().

getDate()

Symfony\Component\Mime\Email::getDate

(

)

Definition at line 68 of file Email.php.

References Symfony\Component\Mime\Message\getHeaders().

getFrom()

Symfony\Component\Mime\Email::getFrom

(

)

Returns

Address[]

Definition at line 126 of file Email.php.

References Symfony\Component\Mime\Message\getHeaders().

getHtmlBody()

Symfony\Component\Mime\Email::getHtmlBody

(

)

Returns

resource|string|null

Definition at line 316 of file Email.php.

getHtmlCharset()

Symfony\Component\Mime\Email::getHtmlCharset

(

)

Definition at line 321 of file Email.php.

getPriority()

Symfony\Component\Mime\Email::getPriority

(

)

Get the priority of this message.

The returned value is an integer where 1 is the highest priority and 5 is the lowest.

Definition at line 267 of file Email.php.

References Symfony\Component\Mime\Message\getHeaders().

getReplyTo()

Symfony\Component\Mime\Email::getReplyTo

(

)

Returns

Address[]

Definition at line 154 of file Email.php.

References Symfony\Component\Mime\Message\getHeaders().

getReturnPath()

Symfony\Component\Mime\Email::getReturnPath

(

)

Definition at line 83 of file Email.php.

References Symfony\Component\Mime\Message\getHeaders().

getSender()

Symfony\Component\Mime\Email::getSender

(

)

Definition at line 98 of file Email.php.

References Symfony\Component\Mime\Message\getHeaders().

getSubject()

Symfony\Component\Mime\Email::getSubject

(

)

Definition at line 55 of file Email.php.

References Symfony\Component\Mime\Message\getHeaders().

getTextBody()

Symfony\Component\Mime\Email::getTextBody

(

)

Returns

resource|string|null

Definition at line 290 of file Email.php.

getTextCharset()

Symfony\Component\Mime\Email::getTextCharset

(

)

Definition at line 295 of file Email.php.

getTo()

Symfony\Component\Mime\Email::getTo

(

)

Returns

Address[]

Definition at line 182 of file Email.php.

References Symfony\Component\Mime\Message\getHeaders().

html()

Symfony\Component\Mime\Email::html	(		$body,
		string	$charset = 'utf-8'
	)

Parameters

resource | string | null

$body

Returns

$this

Definition at line 305 of file Email.php.

Referenced by Symfony\Component\Mime\Email\__serialize(), and Symfony\Component\Mime\Email\ensureValidity().

priority()

Symfony\Component\Mime\Email::priority

(

int

$priority

)

Sets the priority of this message.

The value is an integer where 1 is the highest priority and 5 is the lowest.

Returns

$this

Definition at line 250 of file Email.php.

replyTo()

Symfony\Component\Mime\Email::replyTo

(

$addresses

)

Parameters

Address|string

...$addresses

Returns

$this

Definition at line 146 of file Email.php.

returnPath()

Symfony\Component\Mime\Email::returnPath

(

$address

)

Parameters

Address | string

$address

Returns

$this

Definition at line 78 of file Email.php.

References Symfony\Component\Mime\Address\create().

sender()

Symfony\Component\Mime\Email::sender

(

$address

)

Parameters

Address | string

$address

Returns

$this

Definition at line 93 of file Email.php.

References Symfony\Component\Mime\Address\create().

subject()

Symfony\Component\Mime\Email::subject

(

string

$subject

)

Returns

$this

Definition at line 50 of file Email.php.

text()

Symfony\Component\Mime\Email::text	(		$body,
		string	$charset = 'utf-8'
	)

Parameters

resource | string

$body

Returns

$this

Definition at line 279 of file Email.php.

Referenced by Symfony\Component\Mime\Email\__serialize(), and Symfony\Component\Mime\Email\ensureValidity().

to()

Symfony\Component\Mime\Email::to

(

$addresses

)

Parameters

Address|string

...$addresses

Returns

$this

Definition at line 174 of file Email.php.

Field Documentation

PRIORITY_HIGH

const Symfony\Component\Mime\Email::PRIORITY_HIGH = 2

Definition at line 28 of file Email.php.

PRIORITY_HIGHEST

const Symfony\Component\Mime\Email::PRIORITY_HIGHEST = 1

Definition at line 27 of file Email.php.

PRIORITY_LOW

const Symfony\Component\Mime\Email::PRIORITY_LOW = 4

Definition at line 30 of file Email.php.

PRIORITY_LOWEST

const Symfony\Component\Mime\Email::PRIORITY_LOWEST = 5

Definition at line 31 of file Email.php.

PRIORITY_NORMAL

const Symfony\Component\Mime\Email::PRIORITY_NORMAL = 3

Definition at line 29 of file Email.php.

---

The documentation for this class was generated from the following file:

• Email.php