ERCMailMessage Class Reference

Inherits er::corebusinesslogic::_ERCMailMessage.

Inherited by _ERCMailMessageArchive.

Collaboration diagram for ERCMailMessage:

[legend]

List of all members.

Classes
class	ERCMailMessageClazz
Public Member Functions
void	addToBothSidesOfAttachments (ERCMessageAttachment attachement)
void	appendText (String text)
ERCMailMessage	archive ()
void	attachFileWithMimeType (String filePath, String mimeType)
NSArray	bccAddressesAsArray ()
NSArray	ccAddressesAsArray ()
	ERCMailMessage ()
boolean	hasAttachments ()
void	init (EOEditingContext anEditingContext)
boolean	isExceptionState ()
boolean	isReadAsBoolean ()
boolean	isReadyToSendState ()
boolean	isReceivedState ()
boolean	isSentState ()
String	longDescription ()
void	markReadBy (EOEnterpriseObject by)
void	setBccAddressesAsArray (NSArray bccAddresses)
void	setCcAddressesAsArray (NSArray ccAddresses)
void	setReadAsBoolean (boolean read)
void	setText (String aValue)
void	setToAddressesAsArray (NSArray toAddresses)
boolean	shouldArchiveSentMailAsBoolean ()
String	storedGzippedValueForKey (String key)
void	takeStoredGzippedValueForKey (String aValue, String key)
String	text ()
NSArray	toAddressesAsArray ()
String	toLongString ()
String	toString ()
Object	validateEmptyStringForKey (Object value, String field)
void	validateForSave () throws NSValidation.ValidationException
Object	validateFromAddress (String newValue)
Object	validateTitle (String newValue)
Object	validateToAddresses (String newValue)
Static Public Member Functions
static ERCMailMessageClazz	mailMessageClazz ()
Static Public Attributes
static final String	AddressSeparator = ","
static final Logger	log = Logger.getLogger(ERCMailMessage.class)

---

Constructor & Destructor Documentation

ERCMailMessage

(

)

Public constructor.

---

Member Function Documentation

void addToBothSidesOfAttachments

(

ERCMessageAttachment

attachement

)

void appendText

(

String

text

)

Appends test to the currently stored text. Useful for nested mime messages or multi-part messages.

Parameters:

text

to be appended

ERCMailMessage archive

(

)

void attachFileWithMimeType	(	String	filePath,
		String	mimeType
	)

NSArray bccAddressesAsArray

(

)

NSArray ccAddressesAsArray

(

)

boolean hasAttachments

(

)

Simple test if an attachment has any attachments.

Returns:

if the the message has any attachments

void init

(

EOEditingContext

anEditingContext

)

Default state of the mail message is 'Ready To Be Sent'.

Parameters:

anEditingContext

inserted into

Reimplemented from ERXGenericRecord.

Reimplemented in ERCMailMessageArchive.

boolean isExceptionState

(

)

boolean isReadAsBoolean

(

)

boolean isReadyToSendState

(

)

boolean isReceivedState

(

)

boolean isSentState

(

)

String longDescription

(

)

Long description of the mail message.

Returns:

very verbose description of the mail message.

static ERCMailMessageClazz mailMessageClazz

(

)

[static]

Gets the singleton clazz object for this Class.

Returns:

sigleton clazz object

void markReadBy

(

EOEnterpriseObject

by

)

void setBccAddressesAsArray

(

NSArray

bccAddresses

)

void setCcAddressesAsArray

(

NSArray

ccAddresses

)

void setReadAsBoolean

(

boolean

read

)

Use setIsRead(boolean)

Deprecated:

setIsRead

void setText

(

String

aValue

)

Reimplemented from _ERCMailMessage.

void setToAddressesAsArray

(

NSArray

toAddresses

)

boolean shouldArchiveSentMailAsBoolean

(

)

String storedGzippedValueForKey

(

String

key

)

void takeStoredGzippedValueForKey	(	String	aValue,
		String	key
	)

String text

(

)

Reimplemented from _ERCMailMessage.

NSArray toAddressesAsArray

(

)

String toLongString

(

)

[virtual]

Returns the super classes implementation of toString which prints out the current key-value pairs for all of the attributes and relationships for the current object. Very verbose.

Returns:

super's implementation of toString.

Reimplemented from ERXGenericRecord.

String toString

(

)

Overrides the EOGenericRecord's implementation to provide a slightly less verbose output. A typical output for an object mapped to the class com.foo.User with a primary key of 50 would look like: <com.foo.User pk:"50"> EOGenericRecord's implementation is preserved in the method toLongString. To restore the original verbose logging in your subclasses override this method and return toLongString.

Returns:

much less verbose description of an enterprise object.

Reimplemented from ERXGenericRecord.

Object validateEmptyStringForKey	(	Object	value,
		String	field
	)

void validateForSave

(

)

throws NSValidation.ValidationException

This method performs a few checks before invoking super's implementation. If the property key: ERDebuggingEnabled is set to true then the method checkConsistency will be called on this object.

Exceptions:

NSValidation.ValidationException

if the object does not pass validation for saving to the database.

Reimplemented from ERXGenericRecord.

Object validateFromAddress

(

String

newValue

)

Object validateTitle

(

String

newValue

)

Object validateToAddresses

(

String

newValue

)

---

Member Data Documentation

final String AddressSeparator = "," [static]

holds the address separator

final Logger log = Logger.getLogger(ERCMailMessage.class) [static]

logging support

Implements ERXEnterpriseObject.

Reimplemented in ERCMailMessageArchive.

---

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

• /opt/source/Wonder/Frameworks/BusinessLogic/ERCoreBusinessLogic/Sources/er/corebusinesslogic/ERCMailMessage.java