planetj.dataengine.email
Class EmailPropertyGroup

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--planetj.property.PropertyGroup
                    |
                    +--planetj.property.DefaultPropertyGroup
                          |
                          +--planetj.dataengine.email.EmailPropertyGroup

All Implemented Interfaces:

Cloneable, Comparable, Map, Serializable

public class EmailPropertyGroup

extends DefaultPropertyGroup

This property group contains properties that are used for emailing.

Author:

PlanetJ Corporation.

See Also:

Serialized Form

Field Summary

static List	ALL_PROPERTIES
static String	EMAIL Email property group name.
static String	FROM Who the email is from.
static String	PASSWORD Password of the user connection to mail server with.
static String	POP3 POP3 server.
static String	RECIPIENTS_BCC Recipients that email is being blind carbon copied to.
static String	RECIPIENTS_CC Recipients that email is being carbon copied to.
static String	RECIPIENTS_TO Recipients that email is being sent to.
static String	REPLY_TO Address replies should be sent to.
static String	SMTP SMTP server.
static String	SUBJECT Subject of the email.
static String	USER User id to connect to mail server with.

Fields inherited from class planetj.property.DefaultPropertyGroup

NONE

Fields inherited from class planetj.property.PropertyGroup

ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, INTEGER_PROPERTY, LIST_PROPERTY, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

EmailPropertyGroup()
DistributionPropertyGroup constructor comment.

EmailPropertyGroup(int initialCapacity)
DistributionPropertyGroup constructor comment.

EmailPropertyGroup(String pName)
DistributionPropertyGroup constructor comment.

Method Summary

List	getAllPropertyNames() Gets a List containing the names of all the supported properties, not including metaproperties.
List	getBCC() Get the list of addresses the email is being blind carbon copied to.
List	getCC() Get the list of addresses the email is being carbon copied to.
String	getFrom() Get address email is being sent from
String	getPassword() Get the password for the user for the connection to the mail server.
String	getPOP3() Get the POP3 server
String	getReplyTo() Get address where replies to email are to be sent.
String	getSMTP() Get the SMTP server
String	getSubject() Get the subject of the email.
List	getTo() Get the list of addresses the email is being sent to.
String	getUser() Get the user for the connection to the mail server.

Methods inherited from class planetj.property.DefaultPropertyGroup

getDefaultPropertiesString, getRequiredPropertyNames

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, createProperty, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateValue, getDoubleValue, getIntValue, getListValue, getName, getProperty, getPropertyType, getStringValue, getValue, isMergeableOnList, isMetaproperty, iterator, mergeOnList, put, put, put, setName, toString, updateProperty

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

EMAIL

public static final String EMAIL

Email property group name.

See Also:

Constant Field Values

FROM

public static final String FROM

Who the email is from.

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

Password of the user connection to mail server with.

See Also:

Constant Field Values

POP3

public static final String POP3

POP3 server.

See Also:

Constant Field Values

RECIPIENTS_TO

public static final String RECIPIENTS_TO

Recipients that email is being sent to.

See Also:

Constant Field Values

RECIPIENTS_CC

public static final String RECIPIENTS_CC

Recipients that email is being carbon copied to.

See Also:

Constant Field Values

RECIPIENTS_BCC

public static final String RECIPIENTS_BCC

Recipients that email is being blind carbon copied to.

See Also:

Constant Field Values

REPLY_TO

public static final String REPLY_TO

Address replies should be sent to.

See Also:

Constant Field Values

SMTP

public static final String SMTP

SMTP server.

See Also:

Constant Field Values

SUBJECT

public static final String SUBJECT

Subject of the email.

See Also:

Constant Field Values

USER

public static final String USER

User id to connect to mail server with.

See Also:

Constant Field Values

ALL_PROPERTIES

public static final List ALL_PROPERTIES

Constructor Detail

EmailPropertyGroup

public EmailPropertyGroup()

DistributionPropertyGroup constructor comment.

EmailPropertyGroup

public EmailPropertyGroup(int initialCapacity)

DistributionPropertyGroup constructor comment.

Parameters:

initialCapacity - int

EmailPropertyGroup

public EmailPropertyGroup(String pName)

DistributionPropertyGroup constructor comment.

Parameters:

pName - java.lang.String

Method Detail

getAllPropertyNames

public List getAllPropertyNames()

Gets a List containing the names of all the supported properties, not including metaproperties.

Overrides:

getAllPropertyNames in class DefaultPropertyGroup

getBCC

public List getBCC()

Get the list of addresses the email is being blind carbon copied to.

Returns:

List of addresses email is being blind carbon copied to.

getCC

public List getCC()

Get the list of addresses the email is being carbon copied to.

Returns:

List of addresses email is being carbon copied to.

getFrom

public String getFrom()

Get address email is being sent from

Returns:

address email is being sent from.

getPassword

public String getPassword()

Get the password for the user for the connection to the mail server.

Returns:

password of user for connection to mail server

getPOP3

public String getPOP3()

Get the POP3 server

Returns:

POP3 server

getReplyTo

public String getReplyTo()

Get address where replies to email are to be sent.

Returns:

address replies to email are sent.

getSMTP

public String getSMTP()

Get the SMTP server

Returns:

SMTP server

getSubject

public String getSubject()

Get the subject of the email.

Returns:

subject of email.

getTo

public List getTo()

Get the list of addresses the email is being sent to.

Returns:

List of addresses email is being sent to.

getUser

public String getUser()

Get the user for the connection to the mail server.

Returns:

user for connection to mail server