com.aspc.DBObj.Email.Internal

Class DBEmailSend

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Email.DBEmail

com.aspc.DBObj.Email.Internal.DBEmailSend

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

DBEmailSend, DBEmailSend, DBEmailSend

public class DBEmailSend
extends DBEmail

Sends an Electronic Mail Message ( EMAIL) through an SMTP server to a set of recipients.
The Emails can be sent containing HTML and/or plain text and can also include a number of attached documents.

Notes

Emails can be created with dynamic email components, such as personalized greetings, signatures, phone numbers etc.
These are produced by calling specifying a field path enclosed within dollar signs within the email body.

For example, to create a personalized greeting you could type:

Dear $recipient.name,Sir/Madam$,

This would create an email that reads:

Dear John Doe,

(if the name field was not filled in the record for the contact the Sir/Madam text would be substituted for the name of the contact)

Information can also be retrieved from the senders details by starting the path the prefix of "sender.".
For example.

Please contact $sender.name$ for more information

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 GlobalId	DBCLASS_GID Sends an Electronic Mail Message ( EMAIL) through an SMTP server to a set of recipients.
static java.lang.String	DBCLASS_NAME Sends an Electronic Mail Message ( EMAIL) through an SMTP server to a set of recipients.
static java.lang.String	DEFAULT_MESSAGE_PARSER
static java.lang.String	DO_NOT_CHECK_EMAIL_VARIABLE
static java.lang.String	EMAIL_QUEUE

Fields inherited from class com.aspc.DBObj.Email.DBEmail

BOOTSTRAP_COLOR_DANGER, BOOTSTRAP_COLOR_PRIMARY, BOOTSTRAP_COLOR_SUCCESS, BOOTSTRAP_COLOR_WARNING, HTML_ATTCH_NAME, MESSAGE_ID

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	addReceiptTracking(java.lang.String emailHTML, MutableDataSource mds, DBEmailRecipient[] trackRecipientList)
void	changeStatus(DBObject purchase)
static java.lang.String	checkBodyLink(java.lang.String body, int layerid)
void	createEmailRecipient(DBObject recipient)
void	createRecipientLinkedAttachments(Contact contact, java.lang.String batch)
static void	disableCleanUp()
static void	enableCleanUp()
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extFixUp() The extended fix up routine for known problems.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsOnChange(DBField field) Determines if a field will affect the values of other fields when updated
protected void	extPostSaveRecord(long transNr) Performs processing after the DBObject has been saved In this case the email is to be sent.
protected void	extPreSaveRecord() Additional functionality WHILE saving this record to the database.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
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.
protected void	extValidateRecord(ValidationList list) Text is mandatory if not file.
DBTriStateOption	findEnableEmailReadTracking(java.lang.String... args) Update recipients as Read where the user has actually opened the email (showing images).
DBEmailSendFormat	findFormat(java.lang.String... args) The format that the email should be composed in.
DBEmailMessageParser	findMessageParser(java.lang.String... args) linked to DBEmailMessageParser to select the parser for html body or text body.
DBEmailRecipientType	findRecipientType(java.lang.String... args) Recipient type.
Contact	findReplyTo(java.lang.String... args) Reply To Person.
DBEmailSendStatus	findSendStatus(java.lang.String... args) send status.
DBEmailTemplate	findTemplateId(java.lang.String... args) The template used to fill in the body of the email.
DBEmailTemplate	findTemplateUsed(java.lang.String... args) Template Used.
DBFile	findTmpAttachment(java.lang.String... args) Tmp Attachment.
java.lang.String	getCharset(java.lang.String... args)
java.lang.String	getCss(java.lang.String... args)
int	getDaysLinkAttachmentAvailable(java.lang.String... args)
java.lang.String	getDbObjectKey(java.lang.String... args)
java.lang.String	getDbObjectRestUrl(java.lang.String... args)
DBTriStateOption	getEnableEmailReadTracking(java.lang.String... args)
java.lang.String	getFailTx(java.lang.String... args)
DBEmailSendFormat	getFormat(java.lang.String... args)
java.util.Date	getLastSent(java.lang.String... args)
DBEmailMessageParser	getMessageParser(java.lang.String... args)
java.lang.String	getOnCompleteCommand(java.lang.String... args)
java.lang.String	getOnErrorCommand(java.lang.String... args)
java.lang.String	getRecipientSend(java.lang.String... args)
DBEmailRecipientType	getRecipientType(java.lang.String... args)
Contact	getReplyTo(java.lang.String... args)
java.lang.String	getReplyToEmail(java.lang.String... args)
RuntimeJSONVariable	getRuntimeLinkedAttachments(Contact contact)
DBEmailSendStatus	getSendStatus(java.lang.String... args)
DBEmailTemplate	getTemplateId(java.lang.String... args)
java.lang.String	getTemplateJson(java.lang.String... args)
DBEmailTemplate	getTemplateUsed(java.lang.String... args)
DBFile	getTmpAttachment(java.lang.String... args)
java.lang.String	getTmpAttachmentKey(java.lang.String... args)
java.lang.String	getVariableParseMsg(java.lang.String... args)
boolean	hasImageEmbedded(java.lang.String... args)
boolean	isDryRun(java.lang.String... args)
static boolean	isDynamic(java.lang.String text)
boolean	isEmbedRemoteImages(java.lang.String... args)
boolean	isExcludeNoEmailRecipients(java.lang.String... args)
boolean	isLinkedAttachment(java.lang.String... args)
boolean	isReadReceipt(java.lang.String... args)
boolean	isSendAsOneEmail(java.lang.String... args)
boolean	isSendCopyToSender(java.lang.String... args)
boolean	isServerReceipt(java.lang.String... args)
java.lang.String	parseMessage(java.lang.String msg, Contact recipient, DBEmailRecipient[] allRecipientList, boolean isParseRecipient, boolean isHtml, boolean isValidating) Parses the text being used in the email message for Path strings delimited by $ signs. The string path can begin with recipient.
void	send(MutableDataSource mds) This function generates a MailMessage object based on the current information and notifies the MailMessage to send the email
protected void	sendMail(MutableDataSource mds, java.lang.String senderEmail, Contact baseRecipient, java.lang.String[] recipientToList, java.lang.String[] recipientCCList, java.lang.String[] recipientBCCList, java.util.HashMap attachmentTable, DBEmailRecipient[] trackRecipientList) Generates a MailMessage object and calls send
DBEmailSend	setCharset(java.lang.String value, java.lang.String... args)
DBEmailSend	setCss(java.lang.String value, java.lang.String... args)
DBEmailSend	setDaysLinkAttachmentAvailable(int value, java.lang.String... args)
DBEmailSend	setDbObjectKey(java.lang.String value, java.lang.String... args)
DBEmailSend	setDbObjectRestUrl(java.lang.String value, java.lang.String... args)
DBEmailSend	setDryRun(boolean value, java.lang.String... args)
DBEmailSend	setEmbedRemoteImages(boolean value, java.lang.String... args)
DBEmailSend	setEnableEmailReadTracking(com.aspc.dal.dbobj.misc.DBTriStateOption value, java.lang.String... args)
DBEmailSend	setExcludeNoEmailRecipients(boolean value, java.lang.String... args)
DBEmailSend	setFailTx(java.lang.String value, java.lang.String... args)
DBEmailSend	setFormat(com.aspc.dal.dbobj.email.internal.DBEmailSendFormat value, java.lang.String... args)
DBEmailSend	setHasImageEmbedded(boolean value, java.lang.String... args)
DBEmailSend	setLastSent(java.util.Date value, java.lang.String... args)
DBEmailSend	setLinkedAttachment(boolean value, java.lang.String... args)
DBEmailSend	setMessageParser(com.aspc.dal.dbobj.email.internal.parser.DBEmailMessageParser value, java.lang.String... args)
DBEmailSend	setOnCompleteCommand(java.lang.String value, java.lang.String... args)
DBEmailSend	setOnErrorCommand(java.lang.String value, java.lang.String... args)
DBEmailSend	setReadReceipt(boolean value, java.lang.String... args)
DBEmailSend	setRecipientSend(java.lang.String value, java.lang.String... args)
DBEmailSend	setRecipientType(com.aspc.dal.dbobj.email.DBEmailRecipientType value, java.lang.String... args)
DBEmailSend	setReplyTo(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
DBEmailSend	setReplyToEmail(java.lang.String value, java.lang.String... args)
DBEmailSend	setSendAsOneEmail(boolean value, java.lang.String... args)
DBEmailSend	setSendCopyToSender(boolean value, java.lang.String... args)
DBEmailSend	setSendStatus(com.aspc.dal.dbobj.email.DBEmailSendStatus value, java.lang.String... args)
DBEmailSend	setServerReceipt(boolean value, java.lang.String... args)
void	setSMTP(MailMessage mm)
DBEmailSend	setTemplateId(com.aspc.dal.dbobj.email.DBEmailTemplate value, java.lang.String... args)
DBEmailSend	setTemplateJson(java.lang.String value, java.lang.String... args)
DBEmailSend	setTemplateUsed(com.aspc.dal.dbobj.email.DBEmailTemplate value, java.lang.String... args)
DBEmailSend	setTmpAttachment(com.aspc.dal.file.DBFile value, java.lang.String... args)
DBEmailSend	setTmpAttachmentKey(java.lang.String value, java.lang.String... args)
DBEmailSend	setVariableParseMsg(java.lang.String value, java.lang.String... args)
static long	throttleEmail(java.lang.String title, int sentCount, int totalCount)
java.lang.String	wrapContent(java.lang.String content) Get HTML with CSS style

Methods inherited from class com.aspc.DBObj.Email.DBEmail

checkMessage, createAttachment, displayName, doesEmailExistInFolder, findAccount, findEnteredBy, findKey, findSender, getAccount, getAttachmentHTML, getAttachments, getBody, getDisplayHTML, getDisplaySender, getDisplayStatusHTML, getEnteredBy, getHtmlBody, getID, getMessageId, getRecipients, getRecipientsHTML, getSender, getSenderEmail, getSentDate, getSubject, handleBodyMultiPart, handleBodyPart, isRealWorld, makeQuery, moveMessage, readBody, readFromMessage, readRecipients, readSender, reAssociate, sendAsErrorMesssage, setAccount, setBody, setEnteredBy, setHtmlBody, setID, setMessageId, setSender, setSenderEmail, setSentDate, setSubject

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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetValue, extIsMandatory, extMarkSavePoint, extPostDeleteRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, 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

Sends an Electronic Mail Message ( EMAIL) through an SMTP server to a set of recipients.
The Emails can be sent containing HTML and/or plain text and can also include a number of attached documents.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Sends an Electronic Mail Message ( EMAIL) through an SMTP server to a set of recipients.
The Emails can be sent containing HTML and/or plain text and can also include a number of attached documents.

DEFAULT_MESSAGE_PARSER

public static final java.lang.String DEFAULT_MESSAGE_PARSER

See Also:

Constant Field Values

DO_NOT_CHECK_EMAIL_VARIABLE

public static final java.lang.String DO_NOT_CHECK_EMAIL_VARIABLE

See Also:

Constant Field Values

EMAIL_QUEUE

public static final java.lang.String EMAIL_QUEUE

See Also:

Constant Field Values

Constructor Detail

DBEmailSend

public DBEmailSend(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

getCharset

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

setCharset

@Nonnull
public DBEmailSend setCharset(java.lang.String 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 DBEmailSend setCss(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getDaysLinkAttachmentAvailable

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

setDaysLinkAttachmentAvailable

@Nonnull
public DBEmailSend setDaysLinkAttachmentAvailable(int value,
                                                           java.lang.String... args)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDbObjectKey

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

setDbObjectKey

@Nonnull
public DBEmailSend setDbObjectKey(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDbObjectRestUrl

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

setDbObjectRestUrl

@Nonnull
public DBEmailSend setDbObjectRestUrl(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

isDryRun

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

setDryRun

@Nonnull
public DBEmailSend setDryRun(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isEmbedRemoteImages

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

setEmbedRemoteImages

@Nonnull
public DBEmailSend setEmbedRemoteImages(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getEnableEmailReadTracking

@CheckReturnValue
 @Nullable
public DBTriStateOption getEnableEmailReadTracking(java.lang.String... args)

findEnableEmailReadTracking

@CheckReturnValue
 @Nonnull
public final DBTriStateOption findEnableEmailReadTracking(java.lang.String... args)
                                                                               throws NotFoundException

Update recipients as Read where the user has actually opened the email (showing images).

--> DBTriStateOption (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBTriStateOption

Throws:

NotFoundException - DBTriStateOption was not found

setEnableEmailReadTracking

@Nonnull
public DBEmailSend setEnableEmailReadTracking(com.aspc.dal.dbobj.misc.DBTriStateOption value,
                                                       java.lang.String... args)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

isExcludeNoEmailRecipients

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

setExcludeNoEmailRecipients

@Nonnull
public DBEmailSend setExcludeNoEmailRecipients(boolean value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getFailTx

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

setFailTx

@Nonnull
public DBEmailSend setFailTx(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getFormat

@CheckReturnValue
 @Nullable
public DBEmailSendFormat getFormat(java.lang.String... args)

findFormat

@CheckReturnValue
 @Nonnull
public final DBEmailSendFormat findFormat(java.lang.String... args)
                                                               throws NotFoundException

The format that the email should be composed in.

--> DBEmailSendFormat (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailSendFormat

Throws:

NotFoundException - DBEmailSendFormat was not found

setFormat

@Nonnull
public DBEmailSend setFormat(com.aspc.dal.dbobj.email.internal.DBEmailSendFormat value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

hasImageEmbedded

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

setHasImageEmbedded

@Nonnull
public DBEmailSend setHasImageEmbedded(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getLastSent

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

setLastSent

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

Throws:

java.lang.Exception

isLinkedAttachment

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

setLinkedAttachment

@Nonnull
public DBEmailSend setLinkedAttachment(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getMessageParser

@CheckReturnValue
 @Nullable
public DBEmailMessageParser getMessageParser(java.lang.String... args)

findMessageParser

@CheckReturnValue
 @Nonnull
public final DBEmailMessageParser findMessageParser(java.lang.String... args)
                                                                         throws NotFoundException

linked to DBEmailMessageParser to select the parser for html body or text body.

--> .DBEmailMessageParser DBEmailMessageParser (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailMessageParser

Throws:

NotFoundException - DBEmailMessageParser was not found

setMessageParser

@Nonnull
public DBEmailSend setMessageParser(com.aspc.dal.dbobj.email.internal.parser.DBEmailMessageParser value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getOnCompleteCommand

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

setOnCompleteCommand

@Nonnull
public DBEmailSend setOnCompleteCommand(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getOnErrorCommand

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

setOnErrorCommand

@Nonnull
public DBEmailSend setOnErrorCommand(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isReadReceipt

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

setReadReceipt

@Nonnull
public DBEmailSend setReadReceipt(boolean value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getRecipientSend

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

setRecipientSend

@Nonnull
public DBEmailSend setRecipientSend(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getRecipientType

@CheckReturnValue
 @Nullable
public DBEmailRecipientType getRecipientType(java.lang.String... args)

findRecipientType

@CheckReturnValue
 @Nonnull
public final DBEmailRecipientType findRecipientType(java.lang.String... args)
                                                                         throws NotFoundException

Recipient type.

--> DBEmailRecipientType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Recipient Type

Throws:

NotFoundException - DBEmailRecipientType was not found

setRecipientType

@Nonnull
public DBEmailSend setRecipientType(com.aspc.dal.dbobj.email.DBEmailRecipientType value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getReplyTo

@CheckReturnValue
 @Nullable
public Contact getReplyTo(java.lang.String... args)

findReplyTo

@CheckReturnValue
 @Nonnull
public final Contact findReplyTo(java.lang.String... args)
                                                      throws NotFoundException

Reply To Person.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setReplyTo

@Nonnull
public DBEmailSend setReplyTo(com.aspc.dal.dbobj.contact.Contact value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getReplyToEmail

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

setReplyToEmail

@Nonnull
public DBEmailSend setReplyToEmail(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

isSendAsOneEmail

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

setSendAsOneEmail

@Nonnull
public DBEmailSend setSendAsOneEmail(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isSendCopyToSender

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

setSendCopyToSender

@Nonnull
public DBEmailSend setSendCopyToSender(boolean value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getSendStatus

@CheckReturnValue
 @Nullable
public DBEmailSendStatus getSendStatus(java.lang.String... args)

findSendStatus

@CheckReturnValue
 @Nonnull
public final DBEmailSendStatus findSendStatus(java.lang.String... args)
                                                                   throws NotFoundException

send status.

--> DBEmailSendStatus (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailSendStatus

Throws:

NotFoundException - DBEmailSendStatus was not found

setSendStatus

@Nonnull
public DBEmailSend setSendStatus(com.aspc.dal.dbobj.email.DBEmailSendStatus value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isServerReceipt

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

setServerReceipt

@Nonnull
public DBEmailSend setServerReceipt(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getTemplateId

@CheckReturnValue
 @Nullable
public DBEmailTemplate getTemplateId(java.lang.String... args)

findTemplateId

@CheckReturnValue
 @Nonnull
public final DBEmailTemplate findTemplateId(java.lang.String... args)
                                                                 throws NotFoundException

The template used to fill in the body of the email.

--> DBEmailTemplate (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailTemplate

Throws:

NotFoundException - DBEmailTemplate was not found

setTemplateId

@Nonnull
public DBEmailSend setTemplateId(com.aspc.dal.dbobj.email.DBEmailTemplate value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getTemplateJson

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

setTemplateJson

@Nonnull
public DBEmailSend setTemplateJson(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getTemplateUsed

@CheckReturnValue
 @Nullable
public DBEmailTemplate getTemplateUsed(java.lang.String... args)

findTemplateUsed

@CheckReturnValue
 @Nonnull
public final DBEmailTemplate findTemplateUsed(java.lang.String... args)
                                                                   throws NotFoundException

Template Used.

--> DBEmailTemplate (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailTemplate

Throws:

NotFoundException - DBEmailTemplate was not found

setTemplateUsed

@Nonnull
public DBEmailSend setTemplateUsed(com.aspc.dal.dbobj.email.DBEmailTemplate value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getTmpAttachment

@CheckReturnValue
 @Nullable
public DBFile getTmpAttachment(java.lang.String... args)

findTmpAttachment

@CheckReturnValue
 @Nonnull
public final DBFile findTmpAttachment(java.lang.String... args)
                                                           throws NotFoundException

Tmp Attachment.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setTmpAttachment

@Nonnull
public DBEmailSend setTmpAttachment(com.aspc.dal.file.DBFile value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getTmpAttachmentKey

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

setTmpAttachmentKey

@Nonnull
public DBEmailSend setTmpAttachmentKey(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getVariableParseMsg

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

setVariableParseMsg

@Nonnull
public DBEmailSend setVariableParseMsg(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBEmail

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

Description copied from class: DBEmail

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBEmail

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

extGetDerivedGlobalKey

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

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field to get

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

Returns:

The calculated global key

Throws:

java.lang.Exception - A serious problem

extValidateField

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

Additional validation for a particular field.

Overrides:

extValidateField in class DBEmail

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

checkBodyLink

@CheckReturnValue
 @Nullable
public static java.lang.String checkBodyLink(@Nonnull
                                                                          java.lang.String body,
                                                                          int layerid)

parseMessage

@CheckReturnValue
 @Nonnull
public java.lang.String parseMessage(java.lang.String msg,
                                                                 Contact recipient,
                                                                 DBEmailRecipient[] allRecipientList,
                                                                 boolean isParseRecipient,
                                                                 boolean isHtml,
                                                                 boolean isValidating)
                                                          throws java.lang.Exception

Parses the text being used in the email message for Path strings delimited
by $ signs.
The string path can begin with recipient. or sender. followed by the
appropriate field.
By adding text after a comma at the end of the path, any missing data will
will be substituted by the supplied text.
Format: $path,text if missing$

Parameters:

msg - - the text that should be parsed

recipient - - the recipient object used to retrieve data from if the variable starts with 'recipient.'

allRecipientList - the list of recipients

isParseRecipient -

isHtml - true to encode < to < etc

isValidating - the email template variable will be skipped if isValidating is true and ignoreValidating flag is checked for this template variable

Returns:

the message text with the variables converted to data based on recipient

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 DBEmail

Parameters:

field - The field that is being changed

currentValue - The new value

params - The extra parameters

Throws:

java.lang.Exception - A serious problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem

createEmailRecipient

public void createEmailRecipient(DBObject recipient)
                          throws java.lang.Exception

Throws:

java.lang.Exception

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

Determines if a field will affect the values of other fields when updated

Overrides:

extIsOnChange in class DBObject

Parameters:

field - - the field that is to be checked

Returns:

true if the supplied field will cause updates to other fields when modified

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Text is mandatory if not file.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list

Throws:

java.lang.Exception - A serious problem

enableCleanUp

public static void enableCleanUp()

disableCleanUp

public static void disableCleanUp()

extPreSaveRecord

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

Additional functionality WHILE saving this record to the database.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A serious problem

throttleEmail

public static long throttleEmail(java.lang.String title,
                                 int sentCount,
                                 int totalCount)
                          throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

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

changeStatus

public void changeStatus(DBObject purchase)
                  throws java.lang.Exception

Throws:

java.lang.Exception

extPostSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)

Performs processing after the DBObject has been saved In this case the email is to be sent.

Overrides:

extPostSaveRecord in class DBObject

Parameters:

transNr - - the transaction number of the transaction used for save

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 DBEmail

Throws:

java.lang.Exception - a serious problem

send

public final void send(@Nonnull
                       MutableDataSource mds)
                throws java.lang.Exception

This function generates a MailMessage object based on the current information and notifies the MailMessage to send the email

Parameters:

mds - the data source

Throws:

java.lang.Exception - a serious problem

sendMail

protected void sendMail(MutableDataSource mds,
                        java.lang.String senderEmail,
                        Contact baseRecipient,
                        java.lang.String[] recipientToList,
                        java.lang.String[] recipientCCList,
                        java.lang.String[] recipientBCCList,
                        java.util.HashMap attachmentTable,
                        DBEmailRecipient[] trackRecipientList)
                 throws java.lang.Exception

Generates a MailMessage object and calls send

Parameters:

mds - the data source

senderEmail - - the email that the mail will be sent from

baseRecipient - the base recipient

recipientToList - - list of email addresses to appear in TO list

recipientCCList - - list of email addresses to appear in CC list

recipientBCCList - - list of email addresses to appear in BCC list

attachmentTable - list of DBFile objects that should be added to email

trackRecipientList - should we track ?

Throws:

java.lang.Exception - a serious problem.

setSMTP

public void setSMTP(MailMessage mm)
             throws java.lang.Exception

Throws:

java.lang.Exception

isDynamic

@CheckReturnValue
public static boolean isDynamic(@Nonnull
                                                  java.lang.String text)

addReceiptTracking

@CheckReturnValue
 @Nonnull
public java.lang.String addReceiptTracking(java.lang.String emailHTML,
                                                                       MutableDataSource mds,
                                                                       DBEmailRecipient[] trackRecipientList)
                                                                throws java.lang.Exception

Throws:

java.lang.Exception

createRecipientLinkedAttachments

public void createRecipientLinkedAttachments(Contact contact,
                                             java.lang.String batch)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getRuntimeLinkedAttachments

@CheckReturnValue
 @Nullable
public RuntimeJSONVariable getRuntimeLinkedAttachments(Contact contact)
                                                                             throws java.lang.Exception

Throws:

java.lang.Exception

wrapContent

@CheckReturnValue
 @Nonnull
public java.lang.String wrapContent(java.lang.String content)
                                                         throws java.lang.Exception

Get HTML with CSS style

Parameters:

content - content

Returns:

the value

Throws:

java.lang.Exception - a serious problem.