Class Email

Class representing the database entity of an email.

Email implements EmailInterface

Package: Email\Entities
Category: System
Located at Services/System/Email/Entities/Email.inc.php

Methods summary

`public`	# `__construct( EmailContactInterface $sender = null, EmailContactInterface $recipient = null, EmailSubjectInterface $subject = null, EmailContentInterface $contentHtml = null, EmailContentInterface $contentPlain = null )` Class Constructor Class Constructor All parameters are optional and can be set after the creation of the Email object. All class properties will have "null" as default value. Parameters `$sender` (optional) E-Mail sender. `$recipient` (optional) E-Mail recipient. `$subject` (optional) E-Mail subject. `$contentHtml` (optional) E-Mail HTML content. `$contentPlain` (optional) E-Mail plain content.
`public`	# `setId( IdType $id )` Sets the ID of an email. Sets the ID of an email. Parameters `$id` E-Mail ID. Implementation of `EmailInterface::setId()`
`public IdType`	# `getId( )` Returns the ID of an email. Returns the ID of an email. Returns `IdType` E-Mail ID. Implementation of `EmailInterface::getId()`
`public`	# `setSender( EmailContactInterface $sender )` Sets the sender of an email. Sets the sender of an email. Parameters `$sender` E-Mail sender. Implementation of `EmailInterface::setSender()`
`public EmailContactInterface`	# `getSender( )` Returns the sender of an email Returns the sender of an email Returns `EmailContactInterface` E-Mail sender. Implementation of `EmailInterface::getSender()`
`public`	# `setRecipient( EmailContactInterface $recipient )` Sets the recipient of an email. Sets the recipient of an email. Parameters `$recipient` E-Mail recipient. Implementation of `EmailInterface::setRecipient()`
`public EmailContactInterface`	# `getRecipient( )` Returns the recipient of an email. Returns the recipient of an email. Returns `EmailContactInterface` E-Mail recipient. Implementation of `EmailInterface::getRecipient()`
`public`	# `setReplyTo( EmailContactInterface $recipient )` Sets the 'reply to' option value of an email. Sets the 'reply to' option value of an email. Parameters `$recipient` E-Mail reply-to. Implementation of `EmailInterface::setReplyTo()`
`public EmailContactInterface`	# `getReplyTo( )` Returns the 'reply to' option value of an email. Returns the 'reply to' option value of an email. Returns `EmailContactInterface` E-Mail reply-to. Implementation of `EmailInterface::getReplyTo()`
`public`	# `setSubject( EmailSubjectInterface $subject )` Sets the subject of an email. Sets the subject of an email. Parameters `$subject` E-Mail subject. Implementation of `EmailInterface::setSubject()`
`public EmailSubjectInterface`	# `getSubject( )` Returns the subject of an email. Returns the subject of an email. Returns `EmailSubjectInterface` E-Mail subject. Implementation of `EmailInterface::getSubject()`
`public`	# `setContentPlain( EmailContentInterface $contentPlain )` Sets the plain content of an email. Sets the plain content of an email. Parameters `$contentPlain` E-Mail plain content. Implementation of `EmailInterface::setContentPlain()`
`public EmailContentInterface`	# `getContentPlain( )` Returns the plain content of an email. Returns the plain content of an email. Returns `EmailContentInterface` E-Mail plain content. Implementation of `EmailInterface::getContentPlain()`
`public`	# `setContentHtml( EmailContentInterface $contentHtml )` Sets the HTML content of an email. Sets the HTML content of an email. Parameters `$contentHtml` E-Mail HTML content. Implementation of `EmailInterface::setContentHtml()`
`public EmailContentInterface`	# `getContentHtml( )` Returns the HTML content of an email. Returns the HTML content of an email. Returns `EmailContentInterface` E-Mail HTML content. Implementation of `EmailInterface::getContentHtml()`
`public`	# `setAttachments( AttachmentCollectionInterface $attachments )` Sets the attachments of an email. Sets the attachments of an email. Parameters `$attachments` E-Mail attachments. Implementation of `EmailInterface::setAttachments()`
`public AttachmentCollectionInterface`	# `getAttachments( )` Returns the attachments of an email. Returns the attachments of an email. Returns `AttachmentCollectionInterface` E-Mail attachments. Implementation of `EmailInterface::getAttachments()`
`public`	# `setBcc( ContactCollectionInterface $bcc )` Sets the BCC of an email. Sets the BCC of an email. Parameters `$bcc` E-Mail BCC. Implementation of `EmailInterface::setBcc()`
`public ContactCollectionInterface`	# `getBcc( )` Returns the BCC of an email. Returns the BCC of an email. Returns `ContactCollectionInterface` E-Mail BCC. Implementation of `EmailInterface::getBcc()`
`public`	# `setCc( ContactCollectionInterface $cc )` Sets the CC of an email. Sets the CC of an email. Parameters `$cc` E-Mail CC. Implementation of `EmailInterface::setCc()`
`public ContactCollectionInterface`	# `getCc( )` Returns the CC of an email. Returns the CC of an email. Returns `ContactCollectionInterface` E-Mail CC. Implementation of `EmailInterface::getCc()`
`public`	# `setPending( boolean $p_isPending )` Sets an email status to pending if true is given, else sent. Sets an email status to pending if true is given, else sent. Parameters `$p_isPending` E-Mail pending status. Throws InvalidArgumentException If "$p_isPending" is not valid. Implementation of `EmailInterface::setPending()`
`public boolean`	# `isPending( )` Returns if an email is pending or sent. Returns if an email is pending or sent. Returns boolean E-Mail pending status. Implementation of `EmailInterface::isPending()`
`public`	# `setCreationDate( DateTime $creationDate )` Sets the creation date of an email. Sets the creation date of an email. Parameters `$creationDate` E-Mail creation date. Implementation of `EmailInterface::setCreationDate()`
`public DateTime`	# `getCreationDate( )` Returns the creation date of an email. Returns the creation date of an email. Returns DateTime E-Mail creation date. Implementation of `EmailInterface::getCreationDate()`
`public`	# `setSentDate( DateTime $sentDate )` Sets the sent date of an email. Sets the sent date of an email. Parameters `$sentDate` E-Mail sent date. Implementation of `EmailInterface::setSentDate()`
`public DateTime`	# `getSentDate( )` Returns the sent date of an email. Returns the sent date of an email. Returns DateTime E-Mail sent date. Implementation of `EmailInterface::getSentDate()`

Properties summary

`protected integer`	`$id` E-Mail ID. E-Mail ID.	#
`protected EmailContactInterface`	`$sender` E-Mail sender. E-Mail sender.	#
`protected EmailContactInterface`	`$recipient` E-Mail recipient. E-Mail recipient.	#
`protected EmailContactInterface`	`$replyTo` E-Mail reply-to contact. E-Mail reply-to contact.	#
`protected EmailSubjectInterface`	`$subject` E-Mail subject. E-Mail subject.	#
`protected EmailContentInterface`	`$contentPlain` E-Mail plain content E-Mail plain content	#
`protected EmailContentInterface`	`$contentHtml` E-Mail HTML content. E-Mail HTML content.	#
`protected AttachmentCollectionInterface`	`$attachments` E-Mail attachments. E-Mail attachments.	#
`protected ContactCollectionInterface`	`$bcc` E-Mail BCC. E-Mail BCC.	#
`protected ContactCollectionInterface`	`$cc` E-Mail CC. E-Mail CC.	#
`protected boolean`	`$isPending` Is E-Mail pending? Is E-Mail pending?	#
`protected DateTime`	`$creationDate` Create date time. Create date time.	#
`protected DateTime`	`$sentDate` Sent date time. Sent date time.	#

Packages

Classes

Class Email

Methods summary

Parameters

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Throws

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Implementation of

Returns

Implementation of

Properties summary