ILIAS\Mail\Autoresponder\AutoresponderNotification Class Reference

Inheritance diagram for ILIAS\Mail\Autoresponder\AutoresponderNotification:

Collaboration diagram for ILIAS\Mail\Autoresponder\AutoresponderNotification:

Public Member Functions
	__construct (private readonly ilMailOptions $sender_mail_options, int $receiver_id, private readonly DateTimeImmutable $next_auto_responder_datetime)
	send ()
Public Member Functions inherited from ilMailNotification
	__construct (protected bool $is_in_wsp=false)
	setType (int $a_type)
	getType ()
	setSender (int $a_usr_id)
	getSender ()
	setRecipients (array $a_rcp)
	getRecipients ()
	setAttachments (array $a_att)
	getAttachments ()
	setLangModules (array $a_modules)
	getUserLanguage (int $a_usr_id)
	setRefId (int $a_id)
	getRefId ()
	getObjId ()
	setObjId (int $a_obj_id)
	getObjType ()
	setAdditionalInformation (array $a_info)
	getAdditionalInformation ()
	sendMail (array $a_rcp, bool $a_parse_recipients=true)
	getBlockBorder ()

Additional Inherited Members
Data Fields inherited from ilMailNotification
final const int	SUBJECT_TITLE_LENGTH = 60
Protected Member Functions inherited from ilMailNotification
	setSubject (string $a_subject)
	getSubject ()
	setBody (string $a_body)
	appendBody (string $a_body)
	getBody ()
	initLanguage (int $a_usr_id)
	initLanguageByIso2Code (string $a_code='')
	setLanguage (ilLanguage $a_language)
	getLanguage ()
	getLanguageText (string $a_keyword)
	getObjectTitle (bool $a_shorten=false)
	initMail ()
	getMail ()
	createPermanentLink (array $a_params=[], string $a_append='')
	userToString (int $a_usr_id)
	isRefIdAccessible (int $a_user_id, int $a_ref_id, string $a_permission='read')
Protected Attributes inherited from ilMailNotification
int	$type
int	$sender
ilMail	$mail = null
string	$subject = ''
string	$body = ''
array	$attachments = []
ilLanguage	$language
array	$lang_modules = []
array	$recipients = []
int	$ref_id
int	$obj_id = 0
string	$obj_type = ''
array	$additional_info = []
ilWorkspaceTree	$wsp_tree
ilWorkspaceAccessHandler	$wsp_access_handler

Detailed Description

Definition at line 29 of file AutoresponderNotification.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Mail\Autoresponder\AutoresponderNotification::__construct	(	private readonly ilMailOptions	$sender_mail_options,
		int	$receiver_id,
		private readonly DateTimeImmutable	$next_auto_responder_datetime
	)

Definition at line 31 of file AutoresponderNotification.php.

      {
        parent::__construct();
 
        $this->setSender($sender_mail_options->getUsrId());
        $this->setRecipients([$receiver_id]);
    }

References ILIAS\GlobalScreen\Provider\__construct(), ilMailNotification\setRecipients(), and ilMailNotification\setSender().

Here is the call graph for this function:

Member Function Documentation

send()

ILIAS\Mail\Autoresponder\AutoresponderNotification::send

(

)

Definition at line 42 of file AutoresponderNotification.php.

                          : bool
    {
        $use_relative_dates = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
 
        foreach ($this->getRecipients() as $recipient) {
            $this->initLanguage($recipient);
            $this->initMail();
 
            $this->getMail()->setSaveInSentbox(false);
            $former_language = ilDatePresentation::getLanguage();
            ilDatePresentation::setLanguage($this->getLanguage());
 
            $this->setSubject($this->sender_mail_options->getAbsenceAutoresponderSubject());
 
            $this->setBody($this->sender_mail_options->getAbsenceAutoresponderBody());
            $this->appendBody("\n");
            $this->appendBody($this->sender_mail_options->getSignature());
            $this->appendBody("\n\n");
            $this->appendBody(
                str_ireplace(
                    [
                        '[NEXT_AUTO_RESPONDER_DATETIME]'
                    ],
                    [
                        ilDatePresentation::formatDate(
                            new ilDateTime($this->next_auto_responder_datetime->getTimestamp(), IL_CAL_UNIX)
                        )
                    ],
                    $this->getLanguageText('mail_absence_auto_responder_body_hint')
                )
            );
 
            $this->sendMail([$recipient]);
 
            ilDatePresentation::setLanguage($former_language);
        }
 
        ilDatePresentation::setUseRelativeDates($use_relative_dates);
 
        return true;
    }

References ilMailNotification\appendBody(), ilDatePresentation\formatDate(), ilDatePresentation\getLanguage(), ilMailNotification\getLanguage(), ilMailNotification\getMail(), ilMailNotification\getRecipients(), IL_CAL_UNIX, ilMailNotification\initLanguage(), ilMailNotification\initMail(), ilMailNotification\sendMail(), ilMailNotification\setBody(), ilDatePresentation\setLanguage(), ilMailNotification\setSubject(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Here is the call graph for this function:

---

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

• components/ILIAS/Mail/classes/Autoresponder/AutoresponderNotification.php