Package com.storedobject.mail

Class Sender

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.mail.Sender

All Implemented Interfaces:

Displayable, StringFiller, HasId, Closeable, AutoCloseable

Direct Known Subclasses:

GMailSender, MailSender

public abstract class Sender
extends StoredObject
implements Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Sender.Debugger

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.mail.Session	session
protected jakarta.mail.Transport	transport

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
Sender()

Method Summary

Modifier and Type	Method	Description
static String[]	browseColumns()
boolean	canSend()
void	close()
static void	columns(Columns columns)
protected abstract void	createTransport(Sender.Debugger debugger)
static String[]	displayColumns()
String	getBody()
String	getBodyType()
String	getFooter()
String	getFooterType()
String	getFromAddress()
String	getFromAddressName()
String	getName()
String	getReplyToAddress()
String	getReplyToAddressName()
SenderGroup	getSenderGroup()
Id	getSenderGroupId()
int	getStatus()
String	getStatusValue()
static String	getStatusValue(int value)
static String[]	getStatusValues()
String	getSubject()
String	getUniqueCondition()	Gets the unique index condition of this object.
static int	hints()
static void	indices(Indices indices)
Error	send(Mail mail)
static int	sendMails(int count, TransactionManager tm)
static int	sendMails(TransactionManager tm)
void	sendTestMail(String to, String subject, String content)
void	sendTestMail(String to, String subject, String content, Device device)
void	setBody(String body)
void	setBodyType(String bodyType)
protected static void	setEncryptionProperties(Properties p, int encryptionType)
void	setFooter(String footer)
void	setFooterType(String footerType)
void	setFromAddress(String fromAddress)
void	setFromAddressName(String fromAddressName)
void	setName(String name)
void	setReplyToAddress(String replyToAddress)
void	setReplyToAddressName(String replyToAddressName)
void	setSenderGroup(Id senderGroupId)
void	setSenderGroup(SenderGroup senderGroup)
void	setSenderGroup(BigDecimal idValue)
void	setStatus(int status)
void	setSubject(String subject)
String	toString()	String representation of the instance.
void	validateData(TransactionManager tm)	This will be invoked by the system whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAttachment, getAttachmentId, getChildren, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Field Details

session

protected jakarta.mail.Session session

transport

protected jakarta.mail.Transport transport

Constructor Details

Sender

public Sender()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

getUniqueCondition

public String getUniqueCondition()

Description copied from class: StoredObject

Gets the unique index condition of this object.

Overrides:

getUniqueCondition in class StoredObject

Returns:

Unique index condition.

hints

public static int hints()

displayColumns

public static String[] displayColumns()

browseColumns

public static String[] browseColumns()

setName

public void setName(String name)

getName

@Column(order=100)
public String getName()

setFromAddressName

public void setFromAddressName(String fromAddressName)

getFromAddressName

@Column(required=false,
        order=200)
public String getFromAddressName()

setFromAddress

public void setFromAddress(String fromAddress)

getFromAddress

@Column(order=300)
public String getFromAddress()

setReplyToAddressName

public void setReplyToAddressName(String replyToAddressName)

getReplyToAddressName

@Column(required=false,
        order=400)
public String getReplyToAddressName()

setReplyToAddress

public void setReplyToAddress(String replyToAddress)

getReplyToAddress

@Column(required=false,
        order=500)
public String getReplyToAddress()

setSubject

public void setSubject(String subject)

getSubject

@Column(required=false,
        order=600)
public String getSubject()

setBody

public void setBody(String body)

getBody

@Column(required=false,
        order=700,
        style="(large)")
public String getBody()

setBodyType

public void setBodyType(String bodyType)

getBodyType

@Column(required=false,
        order=800)
public String getBodyType()

setFooter

public void setFooter(String footer)

getFooter

@Column(required=false,
        order=900,
        style="(large)")
public String getFooter()

setFooterType

public void setFooterType(String footerType)

getFooterType

@Column(required=false,
        order=1000)
public String getFooterType()

setStatus

public void setStatus(int status)

getStatus

@Column(order=1100)
public int getStatus()

getStatusValues

public static String[] getStatusValues()

getStatusValue

public static String getStatusValue(int value)

getStatusValue

public String getStatusValue()

setSenderGroup

public void setSenderGroup(Id senderGroupId)

setSenderGroup

public void setSenderGroup(BigDecimal idValue)

setSenderGroup

public void setSenderGroup(SenderGroup senderGroup)

getSenderGroupId

@Column(order=1200)
public Id getSenderGroupId()

getSenderGroup

public SenderGroup getSenderGroup()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

This will be invoked by the system whenever the object is saved to the DB. It will be invoked in all cases, while creating new objects and updating/deleting/un-deleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

canSend

public boolean canSend()

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

sendTestMail

public void sendTestMail(String to,
 String subject,
 String content)
                  throws Exception

Throws:

Exception

sendTestMail

public void sendTestMail(String to,
 String subject,
 String content,
 Device device)
                  throws Exception

Throws:

Exception

createTransport

protected abstract void createTransport(Sender.Debugger debugger)
                                 throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException

send

public Error send(Mail mail)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

sendMails

public static int sendMails(TransactionManager tm)

sendMails

public static int sendMails(int count,
 TransactionManager tm)

setEncryptionProperties

protected static void setEncryptionProperties(Properties p,
 int encryptionType)