PaperEmailLogEntry Class Reference
[Paper_log]

Describes an entry in the paper email log. More...

List of all members.

Public Member Functions
	getAssocId ()
	getAssocType ()
	getAssocTypeLongString ()
	getAssocTypeString ()
	getBccs ()
	getBody ()
	getCcs ()
	getDateSent ()
	getEventType ()
	getFrom ()
	getIPAddress ()
	getLogId ()
	getPaperId ()
	getRecipients ()
	getSenderEmail ()
	getSenderFullName ()
	getSenderId ()
	getSubject ()
	PaperEmailLogEntry ()
	setAssocId ($assocId)
	setAssocType ($assocType)
	setBccs ($bccs)
	setBody ($body)
	setCcs ($ccs)
	setDateSent ($dateSent)
	setEventType ($eventType)
	setFrom ($from)
	setIPAddress ($ipAddress)
	setLogId ($logId)
	setPaperId ($paperId)
	setRecipients ($recipients)
	setSenderId ($senderId)
	setSubject ($subject)

---

Detailed Description

Describes an entry in the paper email log.

See also:

PaperEmailLogDAO

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

---

Member Function Documentation

PaperEmailLogEntry.getAssocId

(

)

Get associated ID.

Returns:

int

Definition at line 173 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.getAssocType

(

)

Get associated type.

Returns:

int

Definition at line 157 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.getAssocTypeLongString

(

)

Return locale message key for the long format of the associated type.

Returns:

string

Definition at line 236 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.getAssocTypeString

(

)

Return string representation of the associated type.

Returns:

string

Definition at line 219 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.getDateSent

(

)

Get date email was sent.

Returns:

datestamp

Definition at line 109 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.getEventType

(

)

Get event type.

Returns:

int

Definition at line 141 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.getIPAddress

(

)

Get IP address of sender.

Returns:

string

Definition at line 125 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.getLogId

(

)

Get ID of log entry.

Returns:

int

Definition at line 61 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.getPaperId

(

)

Get ID of paper.

Returns:

int

Definition at line 77 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.getSenderEmail

(

)

Return the email address of sender.

Returns:

string

Definition at line 204 of file PaperEmailLogEntry.inc.php.

References getSenderId().

PaperEmailLogEntry.getSenderFullName

(

)

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

Returns:

string

Definition at line 189 of file PaperEmailLogEntry.inc.php.

References getSenderId().

PaperEmailLogEntry.getSenderId

(

)

Get user ID of sender.

Returns:

int

Definition at line 93 of file PaperEmailLogEntry.inc.php.

Referenced by getSenderEmail(), and getSenderFullName().

PaperEmailLogEntry.PaperEmailLogEntry

(

)

Constructor.

Definition at line 49 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.setAssocId

(

$

assocId

)

Set associated ID.

Parameters:

$assocId

int

Definition at line 181 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.setAssocType

(

$

assocType

)

Set associated type.

Parameters:

$assocType

int

Definition at line 165 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.setDateSent

(

$

dateSent

)

Set date email was sent.

Parameters:

$dateSent

datestamp

Definition at line 117 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.setEventType

(

$

eventType

)

Set event type.

Parameters:

$eventType

int

Definition at line 149 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.setIPAddress

(

$

ipAddress

)

Set IP address of sender.

Parameters:

$ipAddress

string

Definition at line 133 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.setLogId

(

$

logId

)

Set ID of log entry.

Parameters:

$logId

int

Definition at line 69 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.setPaperId

(

$

paperId

)

Set ID of paper.

Parameters:

$paperId

int

Definition at line 85 of file PaperEmailLogEntry.inc.php.

PaperEmailLogEntry.setSenderId

(

$

senderId

)

Set user ID of sender.

Parameters:

$senderId

int

Definition at line 101 of file PaperEmailLogEntry.inc.php.

---

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

• classes/paper/log/PaperEmailLogEntry.inc.php

---