ilMailValueObject Class Reference

Collaboration diagram for ilMailValueObject:

Public Member Functions
	__construct (string $from, string $recipients, string $recipientsCC, string $recipientsBCC, string $subject, string $body, array $attachments, bool $usePlaceholders=false, bool $saveInSentBox=false)
	getRecipients ()
	getRecipientsCC ()
	getRecipientsBCC ()
	getSubject ()
	getBody ()
	getAttachments ()
	isUsingPlaceholders ()
	shouldSaveInSentBox ()
	getFrom ()

Private Attributes
string	$recipients
string	$recipientsCC
string	$recipientsBCC
string	$subject
string	$body
array	$attachments
bool	$usePlaceholders
bool	$saveInSentBox
string	$from

Detailed Description

Author

Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Definition at line 24 of file class.ilMailValueObject.php.

Constructor & Destructor Documentation

__construct()

ilMailValueObject::__construct	(	string	$from,
		string	$recipients,
		string	$recipientsCC,
		string	$recipientsBCC,
		string	$subject,
		string	$body,
		array	$attachments,
		bool	$usePlaceholders = false,
		bool	$saveInSentBox = false
	)

Parameters

string[]

$attachments

Exceptions

InvalidArgumentException

Definition at line 41 of file class.ilMailValueObject.php.

References $body, $from, $recipients, $recipientsBCC, $recipientsCC, $saveInSentBox, $subject, $usePlaceholders, and ilStr\strLen().

      {
        if (ilStr::strLen($subject) > 255) {
            throw new InvalidArgumentException('Subject must not be longer than 255 characters');
        }

        $this->from = $from;
        $this->recipients = $recipients;
        $this->recipientsCC = $recipientsCC;
        $this->recipientsBCC = $recipientsBCC;
        $this->subject = $subject;
        $this->body = $body;
        $this->attachments = array_filter(array_map('trim', $attachments));
        $this->usePlaceholders = $usePlaceholders;
        $this->saveInSentBox = $saveInSentBox;
    }

Here is the call graph for this function:

Member Function Documentation

getAttachments()

ilMailValueObject::getAttachments

(

)

Returns

string[]

Definition at line 95 of file class.ilMailValueObject.php.

References $attachments.

                                    : array
    {
        return $this->attachments;
    }

getBody()

ilMailValueObject::getBody

(

)

Definition at line 87 of file class.ilMailValueObject.php.

References $body.

                             : string
    {
        return $this->body;
    }

getFrom()

ilMailValueObject::getFrom

(

)

Definition at line 110 of file class.ilMailValueObject.php.

References $from.

                             : string
    {
        return $this->from;
    }

getRecipients()

ilMailValueObject::getRecipients

(

)

Definition at line 67 of file class.ilMailValueObject.php.

References $recipients.

                                   : string
    {
        return $this->recipients;
    }

getRecipientsBCC()

ilMailValueObject::getRecipientsBCC

(

)

Definition at line 77 of file class.ilMailValueObject.php.

References $recipientsBCC.

                                      : string
    {
        return $this->recipientsBCC;
    }

getRecipientsCC()

ilMailValueObject::getRecipientsCC

(

)

Definition at line 72 of file class.ilMailValueObject.php.

References $recipientsCC.

                                     : string
    {
        return $this->recipientsCC;
    }

getSubject()

ilMailValueObject::getSubject

(

)

Definition at line 82 of file class.ilMailValueObject.php.

References $subject.

                                : string
    {
        return $this->subject;
    }

isUsingPlaceholders()

ilMailValueObject::isUsingPlaceholders

(

)

Definition at line 100 of file class.ilMailValueObject.php.

References $usePlaceholders.

                                         : bool
    {
        return $this->usePlaceholders;
    }

shouldSaveInSentBox()

ilMailValueObject::shouldSaveInSentBox

(

)

Definition at line 105 of file class.ilMailValueObject.php.

References $saveInSentBox.

                                         : bool
    {
        return $this->saveInSentBox;
    }

Field Documentation

$attachments

array ilMailValueObject::$attachments

private

Definition at line 32 of file class.ilMailValueObject.php.

Referenced by getAttachments().

$body

string ilMailValueObject::$body

private

Definition at line 30 of file class.ilMailValueObject.php.

Referenced by __construct(), and getBody().

$from

string ilMailValueObject::$from

private

Definition at line 35 of file class.ilMailValueObject.php.

Referenced by __construct(), and getFrom().

$recipients

string ilMailValueObject::$recipients

private

Definition at line 26 of file class.ilMailValueObject.php.

Referenced by __construct(), and getRecipients().

$recipientsBCC

string ilMailValueObject::$recipientsBCC

private

Definition at line 28 of file class.ilMailValueObject.php.

Referenced by __construct(), and getRecipientsBCC().

$recipientsCC

string ilMailValueObject::$recipientsCC

private

Definition at line 27 of file class.ilMailValueObject.php.

Referenced by __construct(), and getRecipientsCC().

$saveInSentBox

bool ilMailValueObject::$saveInSentBox

private

Definition at line 34 of file class.ilMailValueObject.php.

Referenced by __construct(), and shouldSaveInSentBox().

$subject

string ilMailValueObject::$subject

private

Definition at line 29 of file class.ilMailValueObject.php.

Referenced by __construct(), and getSubject().

$usePlaceholders

bool ilMailValueObject::$usePlaceholders

private

Definition at line 33 of file class.ilMailValueObject.php.

Referenced by __construct(), and isUsingPlaceholders().

---

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

• Services/Mail/classes/Object/class.ilMailValueObject.php