ilMailDeliveryJob Class Reference

Inheritance diagram for ilMailDeliveryJob:

Collaboration diagram for ilMailDeliveryJob:

Public Member Functions
	run (array $input, Observer $observer)
	getInputTypes ()
	isStateless ()
	getExpectedTimeOfTaskInSeconds ()
	getOutputType ()
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob
	getInput ()
	Returns Value[] More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	setInput (array $values)
	getOutput ()
	getInput ()
	getType ()
	unfoldTask ()
	Unfold the task. More...
	getRemoveOption ()
	Returns Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position) See also self::getAbortOption(); More...
	getAbortOption ()
	Returns Option In case a Job is failed or did not respond for some time, an Abort-Option is displayed. There is already a Standard-Abort-Option registered, you can override with your own and do some cleanup if possible. More...
	getType ()
	getInputTypes ()
	getOutputType ()
	getOutput ()
	setInput (array $values)
	getInput ()
	unfoldTask ()
	getRemoveOption ()
	getAbortOption ()
	run (array $input, Observer $observer)
	isStateless ()
	getInput ()
	getExpectedTimeOfTaskInSeconds ()

Additional Inherited Members
Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'
const	MAIN_ABORT = 'bt_main_abort'
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes (array $values)
	extractType ($value)
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
array	$input = []
Value	$output

Detailed Description

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

Member Function Documentation

getExpectedTimeOfTaskInSeconds()

ilMailDeliveryJob::getExpectedTimeOfTaskInSeconds

(

)

Returns

int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 107 of file class.ilMailDeliveryJob.php.

                                                    : int
    {
        return 30;
    }

getInputTypes()

ilMailDeliveryJob::getInputTypes

(

)

Returns

Type[] A list of types that are taken as input.

Implements ILIAS\BackgroundTasks\Task.

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

                                   : array
    {
        return [
            new SingleType(IntegerValue::class), // 0. User Id
            new SingleType(StringValue::class), // 1. To
            new SingleType(StringValue::class), // 2. CC
            new SingleType(StringValue::class), // 3. BCC
            new SingleType(StringValue::class), // 4. Subject
            new SingleType(StringValue::class), // 5. Message
            new SingleType(StringValue::class), // 6. Attachments
            new SingleType(BooleanValue::class), // 7. Use placeholders
            new SingleType(BooleanValue::class), // 8. Save in sentbox
            new SingleType(StringValue::class), // 9. Context Id
            new SingleType(StringValue::class), // 10. Context Parameters
        ];
    }

getOutputType()

ilMailDeliveryJob::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

Definition at line 112 of file class.ilMailDeliveryJob.php.

                                   : Type
    {
        return new SingleType(BooleanValue::class);
    }

isStateless()

ilMailDeliveryJob::isStateless

(

)

Returns

bool returns true iff the job's output ONLY depends on the input. Stateless task results may be cached!

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 102 of file class.ilMailDeliveryJob.php.

                                 : bool
    {
        return true;
    }

run()

ilMailDeliveryJob::run	(	array	$input,
		Observer	$observer
	)

Parameters

Value[]	$input	This will be a list of Values hinted by getInputTypes.
Observer	$observer	Notify the bucket about your progress!

Returns

Value The returned Value must be of the type hinted by getOutputType.

Implements ILIAS\BackgroundTasks\Task\Job.

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

                                                         : Value
    {
        global $DIC;
 
        $arguments = array_map(static fn($value) => $value->getValue(), $input);
 
        $DIC->logger()->mail()->info('Mail delivery background task executed');
 
        $DIC->logger()->mail()->debug(sprintf(
            'Input: %s',
            json_encode(array_slice($arguments, 0, 5), JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT)
        ));
 
        $context_parameters = (array) unserialize($input[10]->getValue(), ['allowed_classes' => false]);
 
        if ((int) $input[0]->getValue() === ANONYMOUS_USER_ID) {
            $mail = new ilMail((int) $input[0]->getValue());
        } else {
            $mail = new ilFormatMail((int) $input[0]->getValue());
        }
 
        if (isset($context_parameters['auto_responder'])) {
            if ($context_parameters['auto_responder']) {
                $mail->autoresponder()->enableAutoresponder();
            } else {
                $mail->autoresponder()->disableAutoresponder();
            }
        }
 
        $mail->setSaveInSentbox((bool) $input[8]->getValue());
        $mail = $mail
            ->withContextId((string) $input[9]->getValue())
            ->withContextParameters($context_parameters);
 
        $mail_data = new MailDeliveryData(
            (string) $input[1]->getValue(), // To
            (string) $input[2]->getValue(),  // Cc
            (string) $input[3]->getValue(),  // Bcc
            (string) $input[4]->getValue(),  // Subject
            (string) $input[5]->getValue(),  // Message
            (array) unserialize($input[6]->getValue(), ['allowed_classes' => false]),  // Attachments
            (bool) $input[7]->getValue() // Use Placeholders
        );
        $mail->sendMail($mail_data);
 
        $DIC->logger()->mail()->info('Mail delivery background task finished');
 
        $output = new BooleanValue();
        $output->setValue(true);
 
        return $output;
    }

References $DIC, ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$input, ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$output, ANONYMOUS_USER_ID, ILIAS\UI\Implementation\Component\Input\getValue(), and ILIAS\BackgroundTasks\Value\setValue().

Here is the call graph for this function:

---

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

• components/ILIAS/Mail/classes/BackgroundTask/class.ilMailDeliveryJob.php