ilMailValueObject Class Reference

Collaboration diagram for ilMailValueObject:

Public Member Functions
	__construct (private readonly string $from, private readonly string $recipients, private readonly string $recipients_cc, private readonly string $recipients_bcc, private readonly string $subject, private readonly string $body, array $attachments, private readonly bool $use_placeholders=false, private readonly bool $save_in_sent_box=false)
	getRecipients ()
	getRecipientsCC ()
	getRecipientsBCC ()
	getSubject ()
	getBody ()
	getAttachments ()
	isUsingPlaceholders ()
	shouldSaveInSentBox ()
	getFrom ()

Private Attributes
readonly array	$attachments

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMailValueObject::__construct	(	private readonly string	$from,
		private readonly string	$recipients,
		private readonly string	$recipients_cc,
		private readonly string	$recipients_bcc,
		private readonly string	$subject,
		private readonly string	$body,
		array	$attachments,
		private readonly bool	$use_placeholders = false,
		private readonly bool	$save_in_sent_box = false
	)

Parameters

list<string>

$attachments

Exceptions

InvalidArgumentException

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

      {
        if (ilStr::strLen($this->subject) > 255) {
            throw new InvalidArgumentException('Subject must not be longer than 255 characters');
        }
        $this->attachments = array_filter(array_map('trim', $attachments));
    }

References $attachments, and ilStr\strLen().

Here is the call graph for this function:

Member Function Documentation

getAttachments()

ilMailValueObject::getAttachments

(

)

Returns

list<string>

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

                                    : array
    {
        return $this->attachments;
    }

References $attachments.

getBody()

ilMailValueObject::getBody

(

)

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

                             : string
    {
        return $this->body;
    }

getFrom()

ilMailValueObject::getFrom

(

)

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

                             : string
    {
        return $this->from;
    }

getRecipients()

ilMailValueObject::getRecipients

(

)

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

                                   : string
    {
        return $this->recipients;
    }

getRecipientsBCC()

ilMailValueObject::getRecipientsBCC

(

)

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

                                      : string
    {
        return $this->recipients_bcc;
    }

getRecipientsCC()

ilMailValueObject::getRecipientsCC

(

)

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

                                     : string
    {
        return $this->recipients_cc;
    }

getSubject()

ilMailValueObject::getSubject

(

)

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

                                : string
    {
        return $this->subject;
    }

isUsingPlaceholders()

ilMailValueObject::isUsingPlaceholders

(

)

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

                                         : bool
    {
        return $this->use_placeholders;
    }

shouldSaveInSentBox()

ilMailValueObject::shouldSaveInSentBox

(

)

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

                                         : bool
    {
        return $this->save_in_sent_box;
    }

Field Documentation

$attachments

readonly array ilMailValueObject::$attachments

private

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

Referenced by __construct(), and getAttachments().

---

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

• components/ILIAS/Mail/classes/Object/class.ilMailValueObject.php