Package com.iizix.prop
Class MailProps
- java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- com.iizix.prop.PropCnr
- com.iizix.prop.MailProps
 
 
 
- All Implemented Interfaces:
- EventListener,- IGProp<GProp<?>[]>,- IPropCnr,- java.lang.Cloneable
 - Direct Known Subclasses:
- EditorMailProps
 - public class MailProps extends PropCnr Container holding mail settings.- Author:
- Christopher Mindus
 
- Field Summary- Fields - Modifier and Type - Field - Description - static java.lang.String- COMPRESSProperty name, saved mail compression type: 0=none, 1=gzip (default), 2=xz.- static java.lang.String- DEBUGProperty name, debug: "debug", default false.- static java.lang.String- DEFAULT_BCCSProperty name, default sender: "defaultBCCs".- static java.lang.String- DEFAULT_CCSProperty name, default sender: "defaultCCs".- static java.lang.String- DEFAULT_REPLYTOProperty name, default sender: "defaultReplyTo".- static java.lang.String- DEFAULT_SENDERProperty name, default sender: "defaultSender".- static java.lang.String- MAIL_HOSTProperty name, mail host: "host".- static java.lang.String- PASSWORDThe password property name: "password" (a PasswordProp).- static java.lang.String- PORTProperty name, mail port: "port" (1-65534, default 25).- static java.lang.String- QUEUED_MAIL_DIRECTORYProperty name: queued mail directory: "directory".- static java.lang.String- SERVER_IDENTITY_CHECKServer identity check: "serverIDCheck.- static java.lang.String- SMTPS_PROTOCOLProperty name, mail host: "smtps".- static java.lang.String- TIMEOUTProperty name, timeout in milliseconds: "timeout".- static java.lang.String- USE_SSLProperty name: enable SSL: "ssl".- static java.lang.String- USE_STARTTLSProperty name: use STARTTLS: "STARTTLS".- static java.lang.String- USER_NAMEThe user name property string: "userName" (a StringProp).- Fields inherited from class com.iizix.prop.PropCnr- EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID
 - Fields inherited from class com.iizix.prop.GProp- GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2
 - Fields inherited from interface com.iizix.prop.IGProp- EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE
 
 - Method Summary- All Methods Instance Methods Concrete Methods - Modifier and Type - Method - Description - MailProps- clone()Clone must be overridden.- MailSender- createInstance(java.util.concurrent.ExecutorService executorService, java.io.File baseDir)Constructs the mail sender from the property if not already done.- InternetAddress[]- getDefaultBCCs()Gets the Default BCCs.- InternetAddress[]- getDefaultCCs()Gets the Default CCs.- InternetAddress- getDefaultReplyTo()Gets the Default Reply To.- InternetAddress- getDefaultSender()Gets the Default Sender.- java.io.File- getMailQueueDirectory(java.io.File baseDir)Gets the send mail queue directory to use.- MailSender- getMailSender()Gets the current mail sender.- boolean- isDefaultSender()Returns if this is the default mail sender.- boolean- verify(PropVerification verification)Verifies this property container.- Methods inherited from class com.iizix.prop.PropCnr- __transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, shouldSerializeToXML, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verifyInternalUseOnly, verifyTree, virtualize
 - Methods inherited from class com.iizix.prop.GProp- addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getModuleFolder, getModuleFolder, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning
 - Methods inherited from class java.lang.Object- getClass, hashCode, notify, notifyAll, wait, wait, wait
 - Methods inherited from interface com.iizix.prop.IGProp- addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onRemoteEvent, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning
 - Methods inherited from interface com.iizix.prop.IPropCnr- canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized
 
 
- Field Detail- COMPRESS- public static final java.lang.String COMPRESS Property name, saved mail compression type: 0=none, 1=gzip (default), 2=xz.- See Also:
- Constant Field Values
 
 - DEBUG- public static final java.lang.String DEBUG Property name, debug: "debug", default false.- See Also:
- Constant Field Values
 
 - QUEUED_MAIL_DIRECTORY- public static final java.lang.String QUEUED_MAIL_DIRECTORY Property name: queued mail directory: "directory".- See Also:
- Constant Field Values
 
 - DEFAULT_SENDER- public static final java.lang.String DEFAULT_SENDER Property name, default sender: "defaultSender".- See Also:
- Constant Field Values
 
 - DEFAULT_REPLYTO- public static final java.lang.String DEFAULT_REPLYTO Property name, default sender: "defaultReplyTo".- See Also:
- Constant Field Values
 
 - DEFAULT_CCS- public static final java.lang.String DEFAULT_CCS Property name, default sender: "defaultCCs".- See Also:
- Constant Field Values
 
 - DEFAULT_BCCS- public static final java.lang.String DEFAULT_BCCS Property name, default sender: "defaultBCCs".- See Also:
- Constant Field Values
 
 - MAIL_HOST- public static final java.lang.String MAIL_HOST Property name, mail host: "host".- See Also:
- Constant Field Values
 
 - PORT- public static final java.lang.String PORT Property name, mail port: "port" (1-65534, default 25).- See Also:
- Constant Field Values
 
 - SMTPS_PROTOCOL- public static final java.lang.String SMTPS_PROTOCOL Property name, mail host: "smtps".- See Also:
- Constant Field Values
 
 - USE_SSL- public static final java.lang.String USE_SSL Property name: enable SSL: "ssl".- See Also:
- Constant Field Values
 
 - USE_STARTTLS- public static final java.lang.String USE_STARTTLS Property name: use STARTTLS: "STARTTLS".- See Also:
- Constant Field Values
 
 - SERVER_IDENTITY_CHECK- public static final java.lang.String SERVER_IDENTITY_CHECK Server identity check: "serverIDCheck.- RFC 2595 specifies addition checks that must be performed on the server's certificate to ensure that the server you connected to is the server you intended to connect to. This reduces the risk of "man in the middle" attacks. - See Also:
- Constant Field Values
 
 - TIMEOUT- public static final java.lang.String TIMEOUT Property name, timeout in milliseconds: "timeout".- See Also:
- Constant Field Values
 
 - USER_NAME- public static final java.lang.String USER_NAME The user name property string: "userName" (a StringProp).- See Also:
- Constant Field Values
 
 - PASSWORD- public static final java.lang.String PASSWORD The password property name: "password" (a PasswordProp).- See Also:
- Constant Field Values
 
 
 - Constructor Detail- MailProps- public MailProps() Creates the container properties without a name.
 - MailProps- public MailProps(Atom atom) Creates the container properties with a name.- Parameters:
- atom- The atom name.
 
 
 - Method Detail- getMailQueueDirectory- public java.io.File getMailQueueDirectory(java.io.File baseDir) Gets the send mail queue directory to use.- Parameters:
- baseDir- The base directory where the server is (generally current directory).
- Returns:
- The mail directory, null for failure.
 
 - isDefaultSender- public boolean isDefaultSender() Returns if this is the default mail sender.- Returns:
- true if default, false otherwise.
 
 - getMailSender- public MailSender getMailSender() Gets the current mail sender.- Returns:
- The instance created, or null if not yet created.
 
 - getDefaultSender- public InternetAddress getDefaultSender() throws AddressException Gets the Default Sender.- Returns:
- The address, or null for none.
- Throws:
- AddressException- If the address is invalid.
 
 - getDefaultReplyTo- public InternetAddress getDefaultReplyTo() throws AddressException Gets the Default Reply To.- Returns:
- The address, or null for none.
- Throws:
- AddressException- If the address is invalid.
 
 - getDefaultCCs- public InternetAddress[] getDefaultCCs() throws AddressException Gets the Default CCs.- Returns:
- The address array "never zero in length", or null for none.
- Throws:
- AddressException- If the address is invalid.
 
 - getDefaultBCCs- public InternetAddress[] getDefaultBCCs() throws AddressException Gets the Default BCCs.- Returns:
- The address array "never zero in length", or null for none.
- Throws:
- AddressException- If the address is invalid.
 
 - createInstance- public MailSender createInstance(java.util.concurrent.ExecutorService executorService, java.io.File baseDir) throws java.io.IOException, NoSuchProviderException, AddressException Constructs the mail sender from the property if not already done.- Parameters:
- executorService- The executor service.
- baseDir- The base directory where the server is (generally current directory).
- Returns:
- The instance created, or the existing one.
- Throws:
- java.io.IOException- If the mail queue directory does not exist.
- NoSuchProviderException- If the "smtp" or "smtps" providers do not exist!
- AddressException- If the default sender failed to parse.
 
 - verify- public boolean verify(PropVerification verification) Verifies this property container. The check performed is the extension of classes and that no circular reference is present.