Inheritance diagram for MailQueueEntry:

Public Member Functions
	send ()

Public Member Functions inherited from SimpleORMap
	__construct ($id=null)

	__clone ()

	getRelationOptions ($relation)

	getTableMetadata ()

	hasAutoIncrementColumn ()

	setId ($id)

	getId ()

	getNewId ()

	toArray ($only_these_fields=null)

	toRawArray ($only_these_fields=null)

	toArrayRecursive ($only_these_fields=null)

	getValue ($field)

	getRelationValue ($relation, $field)

	getDefaultValue ($field)

	setValue ($field, $value)

	__get ($field)

	__set ($field, $value)

	__isset ($field)

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	getIterator ()

	count ()

	isField ($field)

	isRelation ($field)

	isAdditionalField ($field)

	isAliasField ($field)

	isI18nField ($field)

	setData ($data, $reset=false)

	isNew ()

	isDeleted ()

	setNew ($is_new)

	getWhereQuery ()

	restore ()

	store ()

	triggerChdate ()

	delete ()

	isDirty ()

	isFieldDirty ($field)

	revertValue ($field)

	getPristineValue ($field)

	initRelation ($relation)

	resetRelation ($relation)

	cleanup ()

Static Public Member Functions
static	add (StudipMail $mail, $message_id=null, $user_id=null)

static	sendNew ()

static	sendAll ($limit=null)

Static Public Member Functions inherited from SimpleORMap
static	tableScheme ($db_table)

static	expireTableScheme ()

static	exists ($id)

static	countBySql ($sql='1', $params=[])

static	create ($data)

static	build ($data, $is_new=true)

static	buildExisting ($data)

static	import ($data)

static	findBySQL ($sql, $params=[])

static	findOneBySQL ($where, $params=[])

static	findThru ($foreign_key_value, $options)

static	findEachBySQL ($callable, $sql, $params=[])

static	findMany ($pks=[], $order='', $order_params=[])

static	findEachMany ($callable, $pks=[], $order='', $order_params=[])

static	findAndMapBySQL ($callable, $where, $params=[])

static	findAndMapMany ($callable, $pks=[], $order='', $order_params=[])

static	deleteBySQL ($where, $params=[])

static	toObject ($id_or_object)

static	__callStatic (string $name, array $arguments)

Static Protected Member Functions
static	configure ($config=[])

Static Protected Member Functions inherited from SimpleORMap
static	db_table ()

static	db_fields ()

static	pk ()

static	default_values ()

static	serialized_fields ()

static	alias_fields ()

static	i18n_fields ()

static	additional_fields ()

static	has_many ()

static	has_one ()

static	belongs_to ()

static	has_and_belongs_to_many ()

static	registered_callbacks ()

static	known_slots ()

static	notification_map ()

static	getter_setter_map ()

static	configure ($config=[])

static	config ($key)

static	registerCallback ($types, $cb)

static	unregisterCallback ($types, $cb)

Additional Inherited Members
Data Fields inherited from SimpleORMap
const	ID_SEPARATOR = '_'

Static Public Attributes inherited from SimpleORMap
static	$schemes = null

Protected Member Functions inherited from SimpleORMap
	_getId ($field)

	_setId ($field, $value)

	_getAdditionalValueFromRelation ($field)

	_setAdditionalValueFromRelation ($field, $value)

	_getAdditionalValue ($field)

	_setAdditionalValue ($field, $value)

	parseRelationOptions ($type, $name, $options)

	storeRelations ($only_these=null)

	deleteRelations ()

	initializeContent ()

	applyCallbacks ($type)

	cbNotificationMapper ($cb_type)

	cbAfterInitialize ($cb_type)

	setSerializedValue ($field, $value)

	setI18nValue ($field, $value)

Protected Attributes inherited from SimpleORMap
	$content = []

	$content_db = []

	$is_new = true

	$is_deleted = false

	$relations = []

	$additional_data = []

Static Protected Attributes inherited from SimpleORMap
static	$config = []

static	$reserved_slots = ['value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id']

static	$performs_batch_operation = false

Member Function Documentation

◆ add()

static add	(	StudipMail	$mail,
			$message_id = `null`,
			$user_id = `null`
	)

static

Add an email to the queue.

Parameters

StudipMail	$mail	: the mailobject that should be added and sent later.
string \| null	$message_id	: the id of the Stud.IP internal message the mail is related to. Leave this null if it isn't related to any internal message.
string \| null	$user_id	: user_id of the receiver. Leave null if the receiver has no account in Stud.IP.

Returns: MailQueueEntry : object in the mailqueue.

◆ configure()

static configure ( $config = [] )

staticprotected

◆ send()

send ( )

Sends the object in the mailqueue. If this succeeds, the object will be deleted immediately. Otherwise the field "tries" in the mailqueue table will be incremented by one.

Returns: bool True, if the mail in the mailqueue entry could be sent, false otherwise.

◆ sendAll()

static sendAll ( $limit = null )

static

Sends all mails in the mailqueue. Stud.IP will give each mail 24 tries to deliver it. If the mail could not be sent after 24 tries (which are 24 hours) it will stay in the mailqueue table but won't be sent anymore. Each mail will only be tried to deliver once per hour. So if it fails Stud.IP will try again next hour.

Parameters

int $limit The maximum amount of messages to be sent.

Returns: array An empty array if no status messages are output or an array with status messages, one for each mail.

◆ sendNew()

static sendNew ( )

static

Sends all new mails in the mailqueue (which means they haven't been sent yet).

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

lib/models/MailQueueEntry.class.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ add()

◆ configure()

◆ send()

◆ sendAll()

◆ sendNew()