EmailLogEntry Class Reference

Inheritance diagram for EmailLogEntry:

Public Member Functions
	getAssocId ()
	getAssocType ()
	getBccs ()
	getBody ()
	getCcs ()
	getDateSent ()
	getEventType ()
	getFrom ()
	getPrefixedSubject ()
	getRecipients ()
	getSenderEmail ()
	getSenderFullName ()
	getSenderId ()
	getSubject ()
	setAssocId ($assocId)
	setAssocType ($assocType)
	setBccs ($bccs)
	setBody ($body)
	setCcs ($ccs)
	setDateSent ($dateSent)
	setEventType ($eventType)
	setFrom ($from)
	setRecipients ($recipients)
	setSenderId ($senderId)
	setSubject ($subject)
Public Member Functions inherited from DataObject
	__construct ()
	addSupportedMetadataAdapter ($metadataAdapter)
	extractMetadata ($metadataSchema)
	getAdditionalMetadataFieldNames ()
&	getAllData ()
	getDAO ()
&	getData ($key, $locale=null)
	getHasLoadableAdapters ()
	getId ()
	getLocaleMetadataFieldNames ()
	getLocalizedData ($key, $preferredLocale=null)
	getMetadataFieldNames ($translated=true)
	getSetMetadataFieldNames ($translated=true)
	getSupportedExtractionAdapters ()
	getSupportedInjectionAdapters ()
	getSupportedMetadataSchemas ()
	hasData ($key, $locale=null)
	injectMetadata ($metadataDescription)
	removeSupportedMetadataAdapter ($metadataSchemaName)
	setAllData (&$data)
	setData ($key, $value, $locale=null)
	setHasLoadableAdapters ($hasLoadableAdapters)
	setId ($id)
	unsetData ($key, $locale=null)
	upcastTo ($targetObject)

Additional Inherited Members
Data Fields inherited from DataObject
	$_data = array()
	$_extractionAdaptersLoaded = false
	$_hasLoadableAdapters = false
	$_injectionAdaptersLoaded = false
	$_metadataExtractionAdapters = array()
	$_metadataInjectionAdapters = array()

Detailed Description

Describes an entry in the email log.

See also

EmailLogDAO

Definition at line 18 of file EmailLogEntry.inc.php.

Member Function Documentation

getAssocId()

EmailLogEntry::getAssocId

(

)

Get associated ID.

Returns

int

Definition at line 92 of file EmailLogEntry.inc.php.

References DataObject\getData().

Referenced by SubmissionEmailLogEntry\getSubmissionId().

getAssocType()

EmailLogEntry::getAssocType

(

)

Get associated type.

Returns

int

Definition at line 76 of file EmailLogEntry.inc.php.

References DataObject\getData().

getBccs()

EmailLogEntry::getBccs

(

)

Definition at line 163 of file EmailLogEntry.inc.php.

References DataObject\getData().

getBody()

EmailLogEntry::getBody

(

)

Definition at line 179 of file EmailLogEntry.inc.php.

References DataObject\getData().

getCcs()

EmailLogEntry::getCcs

(

)

Definition at line 155 of file EmailLogEntry.inc.php.

References DataObject\getData().

getDateSent()

EmailLogEntry::getDateSent

(

)

Get date email was sent.

Returns

datestamp

Definition at line 44 of file EmailLogEntry.inc.php.

References DataObject\getData().

getEventType()

EmailLogEntry::getEventType

(

)

Get event type.

Returns

int

Definition at line 60 of file EmailLogEntry.inc.php.

References DataObject\getData().

getFrom()

EmailLogEntry::getFrom

(

)

Definition at line 139 of file EmailLogEntry.inc.php.

References DataObject\getData().

getPrefixedSubject()

EmailLogEntry::getPrefixedSubject

(

)

Returns the subject of the message with a prefix explaining the event type

Returns

string Prefixed subject

Definition at line 191 of file EmailLogEntry.inc.php.

References getSubject().

getRecipients()

EmailLogEntry::getRecipients

(

)

Definition at line 147 of file EmailLogEntry.inc.php.

References DataObject\getData().

getSenderEmail()

EmailLogEntry::getSenderEmail

(

)

Return the email address of sender.

Returns

string

Definition at line 123 of file EmailLogEntry.inc.php.

References DAORegistry\getDAO(), DataObject\getData(), and getSenderId().

getSenderFullName()

EmailLogEntry::getSenderFullName

(

)

Return the full name of the sender (not necessarily the same as the from address).

Returns

string

Definition at line 108 of file EmailLogEntry.inc.php.

References DAORegistry\getDAO(), DataObject\getData(), and getSenderId().

getSenderId()

EmailLogEntry::getSenderId

(

)

Get user ID of sender.

Returns

int

Definition at line 28 of file EmailLogEntry.inc.php.

References DataObject\getData().

Referenced by getSenderEmail(), and getSenderFullName().

getSubject()

EmailLogEntry::getSubject

(

)

Definition at line 171 of file EmailLogEntry.inc.php.

References DataObject\getData().

Referenced by getPrefixedSubject().

setAssocId()

EmailLogEntry::setAssocId

(

$assocId

)

Set associated ID.

Parameters

$assocId

int

Definition at line 100 of file EmailLogEntry.inc.php.

References DataObject\setData().

Referenced by SubmissionEmailLogEntry\setSubmissionId().

setAssocType()

EmailLogEntry::setAssocType

(

$assocType

)

Set associated type.

Parameters

$assocType

int

Definition at line 84 of file EmailLogEntry.inc.php.

References DataObject\setData().

setBccs()

EmailLogEntry::setBccs

(

$bccs

)

Definition at line 167 of file EmailLogEntry.inc.php.

References DataObject\setData().

setBody()

EmailLogEntry::setBody

(

$body

)

Definition at line 183 of file EmailLogEntry.inc.php.

References DataObject\setData().

setCcs()

EmailLogEntry::setCcs

(

$ccs

)

Definition at line 159 of file EmailLogEntry.inc.php.

References DataObject\setData().

setDateSent()

EmailLogEntry::setDateSent

(

$dateSent

)

Set date email was sent.

Parameters

$dateSent

datestamp

Definition at line 52 of file EmailLogEntry.inc.php.

References DataObject\setData().

setEventType()

EmailLogEntry::setEventType

(

$eventType

)

Set event type.

Parameters

$eventType

int

Definition at line 68 of file EmailLogEntry.inc.php.

References DataObject\setData().

setFrom()

EmailLogEntry::setFrom

(

$from

)

Definition at line 143 of file EmailLogEntry.inc.php.

References DataObject\setData().

setRecipients()

EmailLogEntry::setRecipients

(

$recipients

)

Definition at line 151 of file EmailLogEntry.inc.php.

References DataObject\setData().

setSenderId()

EmailLogEntry::setSenderId

(

$senderId

)

Set user ID of sender.

Parameters

$senderId

int

Definition at line 36 of file EmailLogEntry.inc.php.

References DataObject\setData().

setSubject()

EmailLogEntry::setSubject

(

$subject

)

Definition at line 175 of file EmailLogEntry.inc.php.

References DataObject\setData().

---

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

• EmailLogEntry.inc.php