ilMassMailDeliveryJob Class Reference

Inheritance diagram for ilMassMailDeliveryJob:

Collaboration diagram for ilMassMailDeliveryJob:

Public Member Functions
	__construct ()
	ilMassMailDeliveryJob constructor. More...
	run (array $input, Observer $observer)
	Parameters \ILIAS\BackgroundTasks\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. More...
	getInputTypes ()
	Returns Type[] A list of types that are taken as input. More...
	isStateless ()
	Returns bool returns true iff the job's output ONLY depends on the input. Stateless task results may be cached! More...
	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 More...
	getOutputType ()
	Returns Type A single type. More...
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
	$dic
	$mailJsonService

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 ($values)
	extractType ($value)
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	$input = []
	$output

Detailed Description

Author

Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilMassMailDeliveryJob::__construct

(

)

ilMassMailDeliveryJob constructor.

Parameters

\ILIAS\DI\Container | null	$dic
ilMailValueObjectJsonService | null	$mailJsonService

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

    {
        global $DIC;
        $this->dic = $DIC;
 
        $this->mailJsonService = 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 111 of file class.ilMassMailDeliveryJob.php.

    {
        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 90 of file class.ilMassMailDeliveryJob.php.

    {
        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

(

)

Returns

Type A single type.

Implements ILIAS\BackgroundTasks\Task.

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

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

    {
        return true;
    }

run()

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

Parameters

\ILIAS\BackgroundTasks\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.

Exceptions

ILIAS\BackgroundTasks\Exceptions\InvalidArgumentException

Implements ILIAS\BackgroundTasks\Task\Job.

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

    {
        $mailValueObjects = $this->mailJsonService->convertFromJson((string) $input[1]->getValue());
 
        foreach ($mailValueObjects as $mailValueObject) {
            $mail = new ilMail((int) $input[0]->getValue());
 
            $mail->setSaveInSentbox((bool) $mailValueObject->shouldSaveInSentBox());
            $contextId = $input[2]->getValue();
            $mail = $mail
                ->withContextId((string) $contextId)
                ->withContextParameters((array) unserialize($input[3]->getValue()));
 
            $recipients = (string) $mailValueObject->getRecipients();
            $recipientsCC = (string) $mailValueObject->getRecipientsCC();
            $recipientsBCC = (string) $mailValueObject->getRecipientsBCC();
 
            $this->dic->logger()->mail()->info(
                sprintf(
                    'Mail delivery to recipients: "%s" CC: "%s" BCC: "%s" From sender: "%s"',
                    $recipients,
                    $recipientsCC,
                    $recipientsBCC,
                    $mailValueObject->getFrom()
                )
            );
 
            $mail->sendMail(
                $recipients,
                $recipientsCC,
                $recipientsBCC,
                (string) $mailValueObject->getSubject(),
                (string) $mailValueObject->getBody(),
                (array) $mailValueObject->getAttachments(),
                (bool) $mailValueObject->isUsingPlaceholders()
            );
        }
 
        $output = new BooleanValue();
        $output->setValue(true);
 
        return $output;
    }

References ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$input, and ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$output.

Field Documentation

$dic

ilMassMailDeliveryJob::$dic

private

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

$mailJsonService

ilMassMailDeliveryJob::$mailJsonService

private

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

---

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

• Services/Mail/classes/BackgroundTask/class.ilMassMailDeliveryJob.php