com.aspc.DBObj.Email

Class DBEmailAccount

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Email.DBEmailAccount

All Implemented Interfaces:

SecondaryCacheGroup

public class DBEmailAccount
extends DBObject

Specifies an Email account that emails will be sent from or received to.

Notes

Sending Emails

When sending emails, the email address will be used to specify the sender of the email.

If SMTP server details are not supplied such as the URL, user name and password then the default SMTP server will be used for sending all emails from this account.
This is setup by the administrator through the settings in the database tab or can be passed to the application when it is started through the system properties mail.stmp.host, mail.smtp.user and mail.smtp.password.

Email Synchronization

Email Synchronization is a process which allows the system to load emails from your mail server in the same way as other mail clients such as Microsoft Outlook. The purpose of the sync is not to provide a fully fledge email application, but to allow emails that are related to correspondence with clients to be recorded against those clients.

How Synchronization works

Once the email accounts have been set within the system, these accounts are periodically scanned for new emails. The scanning interval is set by default to 10 minutes but can be modified by changing the repeat_every setting in the startup.xml file if it is run as a startup task, or if run through stEmailScan.properties file.

Each folder within the email account is scanned and is updated with the last scanned time when it is complete.
When each email is read, the system tries to locate a contact for each email address by comparing it against the contacts email addresses.

Once contacts have been found for the email address the filtering is checked for the email account to determine if this email should be loaded into the system.

• If 'Sender Must Exist' was selected then a contact must have been found that matched the 'from' email address before it is loaded.
• If 'Recipient Must Exist' was selected then a contact must have been found that matched one of the recipients email addresses before it is loaded.
• If 'Include Alerts' is selected then email notifications sent from the system will not be imported. ST Alerts emails will contain the header 'ST_EMAIL' with the key of the DBAlert as the value.
• If the email passes all filtering then the email is loaded into the system and can then be view from the summary screen of those Contacts included in the email.

Special consideration for 'Sent Items'

To allow ST to load emails sent from other mail clients, some additional setup is required. IMAP servers allow storing of sent items within a seperate folder on the server, however if your server is a POP3 server then emails sent from your email client will only be stored within that client and not on the server.
To resolve this issue, you can always include your self as a recipient or setup a 'rule' within your client to automatically do this. Another option is have a seperate email account and to include this email address as a recipient or setup a 'rule' within your client to automatically do this. Please refer to the documentation of your mail client on how to setup 'rules'.

'Delete from server' option

Most email clients, have an option to 'Delete from server' so that the email is removed once it is read. This is often the default option. To allow the system to have access to these emails, this needs to be turned off so the email is not deleted once your client has read it. To stop the folder filling up with emails, most mail clients have options so that emails can be deleted when it is deleted from the mail client.
Another option is to set up an additional account that all emails are copied to, as explained in the section Special consideration for 'Sent Items'.

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

Since:

April 14, 2003

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 GlobalId	DBCLASS_GID Specifies an Email account that emails will be sent from or received to.
static java.lang.String	DBCLASS_NAME Specifies an Email account that emails will be sent from or received to.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBEmailAccount	create(MutableDataSource mds) Make a new instance of this class.
java.lang.String	displayName() The human display name of this object.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extFixUp() The extended fix up routine for known problems.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
static DBEmailAccount	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBEmailAccountSecurity	findSecurity(java.lang.String... args) Connection security.
DBEmailAccountSecurity	findSmtpSecurtiy(java.lang.String... args) SMTP connection type.
Store	findStore()
DBEmailAccountType	findType(java.lang.String... args) Must be pop3 or imap.
Person	findUser(java.lang.String... args) User.
java.lang.String	getCss(java.lang.String... args)
java.lang.String	getEmail(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getMailPassword(java.lang.String... args)
java.lang.String	getMailServerURL(java.lang.String... args)
java.lang.String	getMailUser(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
DBEmailAccountSecurity	getSecurity(java.lang.String... args)
java.lang.String	getSmtpPassword(java.lang.String... args)
int	getSmtpPort(java.lang.String... args)
DBEmailAccountSecurity	getSmtpSecurtiy(java.lang.String... args)
java.lang.String	getSmtpServer(java.lang.String... args)
java.lang.String	getSmtpUser(java.lang.String... args)
DBEmailAccountType	getType(java.lang.String... args)
Person	getUser(java.lang.String... args)
boolean	isDefaultFg(java.lang.String... args)
static DBQuery<DBEmailAccount>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBEmailAccount	setCss(java.lang.String value, java.lang.String... args)
DBEmailAccount	setDefaultFg(boolean value, java.lang.String... args)
DBEmailAccount	setEmail(java.lang.String value, java.lang.String... args)
DBEmailAccount	setID(int value, java.lang.String... args)
DBEmailAccount	setMailPassword(java.lang.String value, java.lang.String... args)
DBEmailAccount	setMailServerURL(java.lang.String value, java.lang.String... args)
DBEmailAccount	setMailUser(java.lang.String value, java.lang.String... args)
DBEmailAccount	setName(java.lang.String value, java.lang.String... args)
DBEmailAccount	setSecurity(com.aspc.dal.dbobj.email.DBEmailAccountSecurity value, java.lang.String... args)
DBEmailAccount	setSmtpPassword(java.lang.String value, java.lang.String... args)
DBEmailAccount	setSmtpPort(int value, java.lang.String... args)
DBEmailAccount	setSmtpSecurtiy(com.aspc.dal.dbobj.email.DBEmailAccountSecurity value, java.lang.String... args)
DBEmailAccount	setSmtpServer(java.lang.String value, java.lang.String... args)
DBEmailAccount	setSmtpUser(java.lang.String value, java.lang.String... args)
DBEmailAccount	setType(com.aspc.dal.dbobj.email.DBEmailAccountType value, java.lang.String... args)
DBEmailAccount	setUser(com.aspc.dal.dbobj.contact.Person 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, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, 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

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Specifies an Email account that emails will be sent from or received to.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Specifies an Email account that emails will be sent from or received to.

Constructor Detail

DBEmailAccount

public DBEmailAccount(DBClass def,
                      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 DBEmailAccount setID(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getCss

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

setCss

@Nonnull
public DBEmailAccount setCss(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isDefaultFg

@CheckReturnValue
public boolean isDefaultFg(java.lang.String... args)

setDefaultFg

@Nonnull
public DBEmailAccount setDefaultFg(boolean value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getEmail

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

setEmail

@Nonnull
public DBEmailAccount setEmail(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getMailPassword

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

setMailPassword

@Nonnull
public DBEmailAccount setMailPassword(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getMailServerURL

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

setMailServerURL

@Nonnull
public DBEmailAccount setMailServerURL(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getMailUser

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

setMailUser

@Nonnull
public DBEmailAccount setMailUser(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public DBEmailAccount setName(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getSecurity

@CheckReturnValue
 @Nullable
public DBEmailAccountSecurity getSecurity(java.lang.String... args)

findSecurity

@CheckReturnValue
 @Nonnull
public final DBEmailAccountSecurity findSecurity(java.lang.String... args)
                                                                      throws NotFoundException

Connection security.

--> DBEmailAccountSecurity (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailAccountSecurity

Throws:

NotFoundException - DBEmailAccountSecurity was not found

setSecurity

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

Throws:

java.lang.Exception

getSmtpPassword

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

setSmtpPassword

@Nonnull
public DBEmailAccount setSmtpPassword(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getSmtpPort

@CheckReturnValue
 @Nonnegative
public int getSmtpPort(java.lang.String... args)

setSmtpPort

@Nonnull
public DBEmailAccount setSmtpPort(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSmtpSecurtiy

@CheckReturnValue
 @Nullable
public DBEmailAccountSecurity getSmtpSecurtiy(java.lang.String... args)

findSmtpSecurtiy

@CheckReturnValue
 @Nonnull
public final DBEmailAccountSecurity findSmtpSecurtiy(java.lang.String... args)
                                                                          throws NotFoundException

SMTP connection type.

--> DBEmailAccountSecurity (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailAccountSecurity

Throws:

NotFoundException - DBEmailAccountSecurity was not found

setSmtpSecurtiy

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

Throws:

java.lang.Exception

getSmtpServer

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

setSmtpServer

@Nonnull
public DBEmailAccount setSmtpServer(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getSmtpUser

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

setSmtpUser

@Nonnull
public DBEmailAccount setSmtpUser(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public DBEmailAccountType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final DBEmailAccountType findType(java.lang.String... args)
                                                              throws NotFoundException

Must be pop3 or imap.

--> DBEmailAccountType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailAccountType

Throws:

NotFoundException - DBEmailAccountType was not found

setType

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

Throws:

java.lang.Exception

getUser

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

findUser

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

User.

--> Person (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setUser

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

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBEmailAccount create(@Nonnull
                                                                MutableDataSource mds)
                                                         throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DBEmailAccount> 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 DBEmailAccount 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

extPreValidate

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

Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

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

findStore

@CheckReturnValue
 @Nonnull
public Store findStore()
                                            throws java.lang.Exception

Returns:

the store

Throws:

java.lang.Exception - a serious problem

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()

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