ilMassMailDeliveryJob Class Reference

Inheritance diagram for ilMassMailDeliveryJob:

Collaboration diagram for ilMassMailDeliveryJob:

Public Member Functions
	__construct ()
	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 ()

Private Attributes
readonly ILIAS DI Container	$dic
readonly ilMailValueObjectJsonService	$mail_json_service

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.ilMassMailDeliveryJob.php.

Constructor & Destructor Documentation

__construct()

ilMassMailDeliveryJob::__construct

(

)

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

    {
        global $DIC;
        $this->dic = $DIC;
 
        $this->mail_json_service = new ilMailValueObjectJsonService();
    }

References $DIC.

Member Function Documentation

getExpectedTimeOfTaskInSeconds()

ilMassMailDeliveryJob::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 103 of file class.ilMassMailDeliveryJob.php.

                                                    : int
    {
        return 42; // The answer to life, universe and the rest
    }

getInputTypes()

ilMassMailDeliveryJob::getInputTypes

(

)

Returns

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

Implements ILIAS\BackgroundTasks\Task.

Definition at line 88 of file class.ilMassMailDeliveryJob.php.

                                   : array
    {
        return [
            new SingleType(IntegerValue::class), // User Id
            new SingleType(StringValue::class),  // JSON encoded array of ilMailValueObject
            new SingleType(StringValue::class),  // Context Id
            new SingleType(StringValue::class),  // Context Parameters
        ];
    }

getOutputType()

ilMassMailDeliveryJob::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

Definition at line 108 of file class.ilMassMailDeliveryJob.php.

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

isStateless()

ilMassMailDeliveryJob::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 98 of file class.ilMassMailDeliveryJob.php.

                                 : bool
    {
        return true;
    }

run()

ilMassMailDeliveryJob::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 43 of file class.ilMassMailDeliveryJob.php.

                                                         : Value
    {
        $value_objects = $this->mail_json_service->convertFromJson((string) $input[1]->getValue());
 
        foreach ($value_objects as $value_object) {
            $mail = new ilMail((int) $input[0]->getValue());
 
            $mail->setSaveInSentbox($value_object->shouldSaveInSentBox());
            $context_id = $input[2]->getValue();
            $mail = $mail
                ->withContextId((string) $context_id)
                ->withContextParameters((array) unserialize($input[3]->getValue(), ['allowed_classes' => false]));
 
            $recipients = $value_object->getRecipients();
            $recipients_cc = $value_object->getRecipientsCC();
            $recipients_bcc = $value_object->getRecipientsBCC();
 
            $this->dic->logger()->mail()->info(
                sprintf(
                    'Mail delivery to recipients: "%s" CC: "%s" BCC: "%s" From sender: "%s"',
                    $recipients,
                    $recipients_cc,
                    $recipients_bcc,
                    $value_object->getFrom()
                )
            );
 
            $mail_data = new MailDeliveryData(
                $recipients,
                $recipients_cc,
                $recipients_bcc,
                $value_object->getSubject(),
                $value_object->getBody(),
                $value_object->getAttachments(),
                $value_object->isUsingPlaceholders()
            );
            $mail->sendMail($mail_data);
        }
 
        $output = new BooleanValue();
        $output->setValue(true);
 
        return $output;
    }

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

Here is the call graph for this function:

Field Documentation

$dic

readonly ILIAS DI Container ilMassMailDeliveryJob::$dic

private

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

$mail_json_service

readonly ilMailValueObjectJsonService ilMassMailDeliveryJob::$mail_json_service

private

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

---

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

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