ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier Class Reference

Collaboration diagram for ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier:

Public Member Functions
	__construct (private readonly ilMailCronOrphanedMails $job, private readonly NotificationsCollector $collector, private readonly int $mail_expiration_days, private readonly int $mail_expiration_warning_days, ?ilDBInterface $db=null, ?ClockInterface $clock=null)
	send ()

Private Member Functions
	markAsNotified (ReportDto $collection_obj)
	sendMail (ReportDto $collection_obj)

Private Attributes
const int	NOTIFICATION_MARKER_PING_THRESHOLD = 250
const int	MAIL_DELIVERY_PING_THRESHOLD = 25
readonly ilDBInterface	$db
readonly ClockInterface	$clock
readonly ilDBStatement	$mark_as_notified_stmt

Detailed Description

Definition at line 31 of file Notifier.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier::__construct	(	private readonly ilMailCronOrphanedMails	$job,
		private readonly NotificationsCollector	$collector,
		private readonly int	$mail_expiration_days,
		private readonly int	$mail_expiration_warning_days,
		?ilDBInterface	$db = null,
		?ClockInterface	$clock = null
	)

Definition at line 40 of file Notifier.php.

      {
        global $DIC;
 
        $this->db = $db ?? $DIC->database();
        $this->clock = $clock ?? (new Factory())->clock()->system();
 
        $this->mark_as_notified_stmt = $this->db->prepareManip(
            'INSERT INTO mail_cron_orphaned (mail_id, folder_id, ts_do_delete) VALUES (?, ?, ?)',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER]
        );
    }

References ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier\$clock, ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier\$db, $DIC, and ilDBConstants\T_INTEGER.

Member Function Documentation

markAsNotified()

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier::markAsNotified ( ReportDto  $collection_obj )

private

Definition at line 59 of file Notifier.php.

                                                              : void
    {
        $notify_days_before = 1;
        if ($this->mail_expiration_days > $this->mail_expiration_warning_days) {
            $notify_days_before = $this->mail_expiration_days - $this->mail_expiration_warning_days;
        }
 
        $deletion_datetime = $this->clock->now()
                                         ->modify('+ ' . $notify_days_before . ' days')
                                         ->setTime(0, 0);
 
        $i = 0;
        foreach ($collection_obj->getFolderObjects() as $folder_obj) {
            $folder_id = $folder_obj->getFolderId();
 
            foreach ($folder_obj->getOrphanedMailObjects() as $mail_obj) {
                $mail_id = $mail_obj->getMailId();
 
                if ($i > 0 && $i % self::NOTIFICATION_MARKER_PING_THRESHOLD === 0) {
                    $this->job->ping();
                }
 
                $this->db->execute(
                    $this->mark_as_notified_stmt,
                    [$mail_id, $folder_id, $deletion_datetime->getTimestamp()]
                );
                $i++;
            }
        }
    }

References ReportDto\getFolderObjects().

Referenced by ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier\send().

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier::send

(

)

Definition at line 98 of file Notifier.php.

                          : void
    {
        $i = 0;
        foreach ($this->collector->getCollection() as $collection_obj) {
            if ($i > 0 && $i % self::MAIL_DELIVERY_PING_THRESHOLD === 0) {
                $this->job->ping();
            }
 
            $this->sendMail($collection_obj);
            $this->markAsNotified($collection_obj);
            ++$i;
        }
    }

References ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier\markAsNotified(), and ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier\sendMail().

Here is the call graph for this function:

sendMail()

ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier::sendMail ( ReportDto  $collection_obj )

private

Definition at line 90 of file Notifier.php.

                                                        : void
    {
        $mail = new MailNotification();
        $mail->setRecipients([$collection_obj->getUserId()]);
        $mail->setAdditionalInformation(['mail_folders' => $collection_obj->getFolderObjects()]);
        $mail->send();
    }

References ReportDto\getFolderObjects(), and ReportDto\getUserId().

Referenced by ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier\send().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$clock

readonly ClockInterface ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier::$clock

private

Definition at line 37 of file Notifier.php.

Referenced by ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier\__construct().

$db

readonly ilDBInterface ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier::$db

private

Definition at line 36 of file Notifier.php.

Referenced by ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier\__construct().

$mark_as_notified_stmt

readonly ilDBStatement ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier::$mark_as_notified_stmt

private

Definition at line 38 of file Notifier.php.

MAIL_DELIVERY_PING_THRESHOLD

const int ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier::MAIL_DELIVERY_PING_THRESHOLD = 25

private

Definition at line 34 of file Notifier.php.

NOTIFICATION_MARKER_PING_THRESHOLD

const int ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier::NOTIFICATION_MARKER_PING_THRESHOLD = 250

private

Definition at line 33 of file Notifier.php.

---

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

• components/ILIAS/Mail/classes/Cron/ExpiredOrOrphanedMails/Notifier.php