com.aspc.DBObj.Email

Class DBEmail

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Email.DBEmail

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

DBEmailRead, DBEmailSend

public class DBEmail
extends DBObject

The DBEmail stored details of emails either sent or retrieved by users of the system.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

8 April 2002, 09:13

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BOOTSTRAP_COLOR_DANGER
static java.lang.String	BOOTSTRAP_COLOR_PRIMARY
static java.lang.String	BOOTSTRAP_COLOR_SUCCESS
static java.lang.String	BOOTSTRAP_COLOR_WARNING
static GlobalId	DBCLASS_GID The DBEmail stored details of emails either sent or retrieved by users of the system.
static java.lang.String	DBCLASS_NAME The DBEmail stored details of emails either sent or retrieved by users of the system.
static java.lang.String	HTML_ATTCH_NAME the attachment name
static java.lang.String	MESSAGE_ID the message id

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBEmail(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
boolean	checkMessage(Message message)
protected DBEmailAttachment	createAttachment(java.lang.String attachmentName, java.io.InputStream is, java.util.HashMap orginalAttachments, java.util.HashMap currentAttachments, DBEmailAccount account, java.lang.String mimeType)
java.lang.String	displayName() The human display name of this object.
boolean	doesEmailExistInFolder(java.lang.String inFolder) Does email exist in folder
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) We prevent some values from being set by a user.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
DBEmailAccount	findAccount(java.lang.String... args) Email account used to send this email from.
Person	findEnteredBy(java.lang.String... args) Entered by user.
static DBEmail	findKey(DataSource ds, int key) Find the target for this class by the primary key
Person	findSender(java.lang.String... args) The person who will receive all replies to this email.
DBEmailAccount	getAccount(java.lang.String... args)
java.lang.String	getAttachmentHTML(java.lang.String... args)
DBObject[]	getAttachments()
java.lang.String	getBody(java.lang.String... args)
java.lang.String	getDisplayHTML(java.lang.String... args)
java.lang.String	getDisplaySender(java.lang.String... args)
java.lang.String	getDisplayStatusHTML(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
java.lang.String	getHtmlBody(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getMessageId(java.lang.String... args)
DBEmailRecipient[]	getRecipients()
java.lang.String	getRecipientsHTML(java.lang.String... args)
Person	getSender(java.lang.String... args)
java.lang.String	getSenderEmail(java.lang.String... args)
java.util.Date	getSentDate(java.lang.String... args)
java.lang.String	getSubject(java.lang.String... args)
protected void	handleBodyMultiPart(Multipart mp, java.util.HashMap info, java.util.HashMap orginalAttachments, java.util.HashMap currentAttachments, DBEmailAccount account)
protected void	handleBodyPart(Part part, java.util.HashMap info, java.util.HashMap orginalAttachments, java.util.HashMap currentAttachments, DBEmailAccount account)
boolean	isRealWorld() Is this a "real" email ?
static DBQuery<DBEmail>	makeQuery(DataSource ds) Make a new QUERY for this class.
void	moveMessage(java.lang.String fromFolder, java.lang.String moveToFolder) Move message to different folder
protected void	readBody(Message message, DBEmailAccount account)
void	readFromMessage(Message message, DBEmailAccount account)
protected void	readRecipients(Message message)
protected void	readSender(Message message, DBEmailAccount account)
void	reAssociate()
void	sendAsErrorMesssage(java.lang.String subject, java.lang.String sendTo)
DBEmail	setAccount(com.aspc.dal.dbobj.email.DBEmailAccount value, java.lang.String... args)
DBEmail	setBody(java.lang.String value, java.lang.String... args)
DBEmail	setEnteredBy(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
DBEmail	setHtmlBody(java.lang.String value, java.lang.String... args)
DBEmail	setID(int value, java.lang.String... args)
DBEmail	setMessageId(java.lang.String value, java.lang.String... args)
DBEmail	setSender(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
DBEmail	setSenderEmail(java.lang.String value, java.lang.String... args)
DBEmail	setSentDate(java.util.Date value, java.lang.String... args)
DBEmail	setSubject(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MESSAGE_ID

public static final java.lang.String MESSAGE_ID

the message id

See Also:

Constant Field Values

HTML_ATTCH_NAME

public static final java.lang.String HTML_ATTCH_NAME

the attachment name

See Also:

Constant Field Values

BOOTSTRAP_COLOR_PRIMARY

public static final java.lang.String BOOTSTRAP_COLOR_PRIMARY

See Also:

Constant Field Values

BOOTSTRAP_COLOR_SUCCESS

public static final java.lang.String BOOTSTRAP_COLOR_SUCCESS

See Also:

Constant Field Values

BOOTSTRAP_COLOR_WARNING

public static final java.lang.String BOOTSTRAP_COLOR_WARNING

See Also:

Constant Field Values

BOOTSTRAP_COLOR_DANGER

public static final java.lang.String BOOTSTRAP_COLOR_DANGER

See Also:

Constant Field Values

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

The DBEmail stored details of emails either sent or retrieved by users of the system.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The DBEmail stored details of emails either sent or retrieved by users of the system.

Constructor Detail

DBEmail

public DBEmail(@Nonnull
               DBClass def,
               @Nonnull
               DataSource dataSource)
        throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public DBEmail setID(int value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getAccount

@CheckReturnValue
 @Nullable
public DBEmailAccount getAccount(java.lang.String... args)

findAccount

@CheckReturnValue
 @Nonnull
public final DBEmailAccount findAccount(java.lang.String... args)
                                                             throws NotFoundException

Email account used to send this email from.

--> DBEmailAccount (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Email Account

Throws:

NotFoundException - DBEmailAccount was not found

setAccount

@Nonnull
public DBEmail setAccount(com.aspc.dal.dbobj.email.DBEmailAccount value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getAttachmentHTML

@CheckReturnValue
 @Nonnull
public java.lang.String getAttachmentHTML(java.lang.String... args)

getBody

@CheckReturnValue
 @Nonnull
public java.lang.String getBody(java.lang.String... args)

setBody

@Nonnull
public DBEmail setBody(java.lang.String value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayHTML

@CheckReturnValue
 @Nonnull
public java.lang.String getDisplayHTML(java.lang.String... args)

getDisplaySender

@CheckReturnValue
 @Nonnull
public java.lang.String getDisplaySender(java.lang.String... args)

getDisplayStatusHTML

@CheckReturnValue
 @Nonnull
public java.lang.String getDisplayStatusHTML(java.lang.String... args)

getEnteredBy

@CheckReturnValue
 @Nullable
public Person getEnteredBy(java.lang.String... args)

findEnteredBy

@CheckReturnValue
 @Nonnull
public final Person findEnteredBy(java.lang.String... args)
                                                       throws NotFoundException

Entered by user.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setEnteredBy

@Nonnull
public DBEmail setEnteredBy(com.aspc.dal.dbobj.contact.Person value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getHtmlBody

@CheckReturnValue
 @Nonnull
public java.lang.String getHtmlBody(java.lang.String... args)

setHtmlBody

@Nonnull
public DBEmail setHtmlBody(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getMessageId

@CheckReturnValue
 @Nonnull
public java.lang.String getMessageId(java.lang.String... args)

setMessageId

@Nonnull
public DBEmail setMessageId(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getRecipientsHTML

@CheckReturnValue
 @Nonnull
public java.lang.String getRecipientsHTML(java.lang.String... args)

getSender

@CheckReturnValue
 @Nullable
public Person getSender(java.lang.String... args)

findSender

@CheckReturnValue
 @Nonnull
public final Person findSender(java.lang.String... args)
                                                    throws NotFoundException

The person who will receive all replies to this email.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setSender

@Nonnull
public DBEmail setSender(com.aspc.dal.dbobj.contact.Person value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getSenderEmail

@CheckReturnValue
 @Nonnull
public java.lang.String getSenderEmail(java.lang.String... args)

setSenderEmail

@Nonnull
public DBEmail setSenderEmail(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getSentDate

@CheckReturnValue
 @Nullable
public java.util.Date getSentDate(java.lang.String... args)

setSentDate

@Nonnull
public DBEmail setSentDate(java.util.Date value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getSubject

@CheckReturnValue
 @Nonnull
public java.lang.String getSubject(java.lang.String... args)

setSubject

@Nonnull
public DBEmail setSubject(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DBEmail> makeQuery(@Nonnull
                                                                     DataSource ds)
                                                              throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static DBEmail findKey(@Nonnull
                                                          DataSource ds,
                                                          int key)
                                                   throws NotFoundException,
                                                          java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

displayName

@CheckReturnValue
 @Nonnull
public java.lang.String displayName()

The human display name of this object.

Overrides:

displayName in class DBObject

Returns:

the display name

checkMessage

@CheckReturnValue
public boolean checkMessage(@Nonnull
                                              Message message)

Parameters:

message - the message

Returns:

true if ok

readFromMessage

public void readFromMessage(@Nonnull
                            Message message,
                            @Nonnull
                            DBEmailAccount account)
                     throws java.lang.Exception

Parameters:

message - the message

account - the account

Throws:

java.lang.Exception - a serious problem

reAssociate

public void reAssociate()
                 throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

readSender

protected void readSender(@Nonnull
                          Message message,
                          @Nonnull
                          DBEmailAccount account)
                   throws java.lang.Exception

Parameters:

message - the message

account - the account

Throws:

java.lang.Exception - a serious problem

readRecipients

protected void readRecipients(@Nonnull
                              Message message)
                       throws java.lang.Exception

Parameters:

message - the message

Throws:

java.lang.Exception - a serious problem

readBody

protected void readBody(@Nonnull
                        Message message,
                        @Nonnull
                        DBEmailAccount account)
                 throws java.lang.Exception

Parameters:

message - the message

account - the account

Throws:

java.lang.Exception - a serious problem

handleBodyMultiPart

protected void handleBodyMultiPart(@Nonnull
                                   Multipart mp,
                                   @Nonnull
                                   java.util.HashMap info,
                                   @Nonnull
                                   java.util.HashMap orginalAttachments,
                                   @Nonnull
                                   java.util.HashMap currentAttachments,
                                   @Nonnull
                                   DBEmailAccount account)
                            throws java.lang.Exception

Parameters:

mp - the part

info - the info

orginalAttachments - the attachments

currentAttachments - the attachments

account - the account

Throws:

java.lang.Exception - a serious problem

handleBodyPart

protected void handleBodyPart(@Nonnull
                              Part part,
                              @Nonnull
                              java.util.HashMap info,
                              @Nonnull
                              java.util.HashMap orginalAttachments,
                              @Nonnull
                              java.util.HashMap currentAttachments,
                              @Nonnull
                              DBEmailAccount account)
                       throws java.lang.Exception

Parameters:

part - the part

info - the info

orginalAttachments - the attachments

currentAttachments - the attachments

account - the account

Throws:

java.lang.Exception - a serious problem

createAttachment

@Nonnull
protected DBEmailAttachment createAttachment(@Nonnull
                                                      java.lang.String attachmentName,
                                                      @Nonnull
                                                      java.io.InputStream is,
                                                      @Nonnull
                                                      java.util.HashMap orginalAttachments,
                                                      @Nonnull
                                                      java.util.HashMap currentAttachments,
                                                      @Nonnull
                                                      DBEmailAccount account,
                                                      @Nonnull
                                                      java.lang.String mimeType)
                                               throws java.lang.Exception

Parameters:

attachmentName -

is -

orginalAttachments -

currentAttachments -

account -

mimeType -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

extSetValue

protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

We prevent some values from being set by a user.

Overrides:

extSetValue in class DBObject

Parameters:

field - The field that is being changed

currentValue - The new value

params - The extra parameters

Throws:

java.lang.Exception - A serious problem

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - a serious problem

getRecipients

@CheckReturnValue
 @Nonnull
public DBEmailRecipient[] getRecipients()

Returns:

the value

getAttachments

@CheckReturnValue
 @Nonnull
public DBObject[] getAttachments()

Returns:

the value

extAutoEnterCreate

@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

the value

Throws:

java.lang.Exception - A serious problem

isRealWorld

@CheckReturnValue
public boolean isRealWorld()

Is this a "real" email ?

Returns:

true if this is a real email

moveMessage

public void moveMessage(@Nonnull
                        java.lang.String fromFolder,
                        @Nonnull
                        java.lang.String moveToFolder)
                 throws java.lang.Exception

Move message to different folder

Parameters:

fromFolder - from folder

moveToFolder - to folder

Throws:

java.lang.Exception - a serious problem.

doesEmailExistInFolder

@CheckReturnValue
public boolean doesEmailExistInFolder(@Nonnull
                                                        java.lang.String inFolder)
                                                 throws java.lang.Exception

Does email exist in folder

Parameters:

inFolder - folder

Returns:

is exist

Throws:

java.lang.Exception - exception

sendAsErrorMesssage

public void sendAsErrorMesssage(@Nonnull
                                java.lang.String subject,
                                @Nonnull
                                java.lang.String sendTo)
                         throws java.lang.Exception

Throws:

java.lang.Exception