MailQueueEntry Class Reference

Inheritance diagram for MailQueueEntry:

Collaboration diagram for MailQueueEntry:

Public Member Functions
	__construct ($id=null)
	send ()
Public Member Functions inherited from SimpleORMap
	__construct ($id=null)
	__clone ()
	getRelationOptions ($relation)
	getTableMetadata ()
	hasAutoIncrementColumn ()
	setId ($id)
	getId ()
	getNewId ()
	toArray ($only_these_fields=null)
	toArrayRecursive ($only_these_fields=null)
	getValue ($field)
	getRelationValue ($relation, $field)
	setValue ($field, $value)
	__get ($field)
	__set ($field, $value)
	__isset ($field)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()
	count ()
	isField ($field)
	isAdditionalField ($field)
	isAliasField ($field)
	setData ($data, $reset=false)
	haveData ()
	isNew ()
	isDeleted ()
	setNew ($is_new)
	getWhereQuery ()
	restore ()
	store ()
	triggerChdate ()
	delete ()
	isDirty ()
	isFieldDirty ($field)
	revertValue ($field)
	getPristineValue ($field)
	initRelation ($relation)
	resetRelation ($relation)

Static Public Member Functions
static	add (StudipMail $mail, $message_id=null, $user_id=null)
static	sendNew ()
static	sendAll ()
Static Public Member Functions inherited from SimpleORMap
static	expireTableScheme ()
static	find ($id)
static	exists ($id)
static	countBySql ($sql=1, $params=array())
static	create ($data)
static	build ($data, $is_new=true)
static	buildExisting ($data)
static	import ($data)
static	findBySQL ($sql, $params=array())
static	findByObject (SimpleORMap $object)
static	findOneBySQL ($where, $params=array())
static	findThru ($foreign_key_value, $options)
static	findEachBySQL ($callable, $sql, $params=array())
static	findMany ($pks=array(), $order='', $order_params=array())
static	findEachMany ($callable, $pks=array(), $order='', $order_params=array())
static	findAndMapBySQL ($callable, $where, $params=array())
static	findAndMapMany ($callable, $pks=array(), $order='', $order_params=array())
static	deleteBySQL ($where, $params=array())
static	toObject ($id_or_object)
static	__callStatic ($name, $arguments)

Protected Member Functions
	cbSerializeMail ()
	cbUnserializeMail ()
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)
	getTableScheme ()
	storeRelations ($only_these=null)
	deleteRelations ()
	initializeContent ()
	applyCallbacks ($type)
	registerCallback ($types, $cb)
	unregisterCallback ($types, $cb)
	cbAutoIncrementColumn ($type)
	cbAutoKeyCreation ()
	cbNotificationMapper ($cb_type)
	setSerializedValue ($field, $value)

Static Protected Member Functions
static	configure ($config=array())
Static Protected Member Functions inherited from SimpleORMap
static	configure ($config=array())
static	tableScheme ($db_table)

Additional Inherited Members
Protected Attributes inherited from SimpleORMap
	$content = array()
	$content_db = array()
	$is_new = true
	$db_table = ''
	$db_fields = null
	$pk = null
	$default_values = array()
	$serialized_fields = array()
	$alias_fields = array()
	$additional_fields = array()
	$relations = array()
	$has_many = array()
	$has_one = array()
	$belongs_to = array()
	$has_and_belongs_to_many = array()
	$registered_callbacks
	$known_slots = array()
	$reserved_slots = array('value','newid','iterator','tablemetadata', 'relationvalue','wherequery','relationoptions','data','new','id')
	$notification_map = array()
	$additional_data = array()
Static Protected Attributes inherited from SimpleORMap
static	$schemes = null
static	$config = array()

Constructor & Destructor Documentation

__construct()

__construct

(

$id = null

)

Constructor. Just like any SimpleORMap-constructor. See there for details.

Parameters

string | null

$id

: id of a queue-entry or null.

Here is the call graph for this function:

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.

Here is the caller graph for this function:

cbSerializeMail()

cbSerializeMail ( )

protected

Serializes the mail-object to the database.

Returns

true

cbUnserializeMail()

cbUnserializeMail ( )

protected

Unserializes the mail-object from the database.

Returns

true

configure()

static configure (   $config = array() )

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.

Here is the call graph for this function:

sendAll()

static sendAll ( )

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.

Here is the caller graph for this function:

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