Package com.iizix.prop
Class MailProps
- All Implemented Interfaces:
EventListener,IGProp<GProp<?>[]>,IPropCnr,Cloneable
- Direct Known Subclasses:
EditorMailProps
Container holding mail settings.
- Author:
- Christopher Mindus
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringProperty name, mail bind port, defaultnullfor none.static final StringProperty name, saved mail compression type: 0=none, 1=gzip (default), 2=xz.static final StringProperty name, debug: "debug", default false.static final StringProperty name, default sender: "defaultBCCs".static final StringProperty name, default sender: "defaultCCs".static final StringProperty name, default sender: "defaultReplyTo".static final StringProperty name, default sender: "defaultSender".static final StringProperty name, mail host: "host".static final StringThe password property name: "password" (a PasswordProp).static final StringProperty name, mail port: "port" (1-65534, default 25).static final StringProperty name: queued mail directory: "directory".static final StringServer identity check: "serverIDCheck.static final StringProperty name, mail host: "smtps".static final StringProperty name, timeout in milliseconds: "timeout".static final StringProperty name: enable SSL: "ssl".static final StringProperty name: use STARTTLS: "STARTTLS".static final StringThe user name property string: "userName" (a StringProp).Fields inherited from class com.iizix.prop.PropCnr
EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_IDFields 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_2Fields inherited from interface com.iizix.prop.IGProp
EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_INCLUDE_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATEConstructor Summary
ConstructorsMethod Summary
Modifier and TypeMethodDescriptionclone()Clone must be overridden.createInstance(ExecutorService executorService, File baseDir) Constructs the mail sender from the property if not already done.Gets the Default BCCs.Gets the Default CCs.Gets the Default Reply To.Gets the Default Sender.getMailQueueDirectory(File baseDir) Gets the send mail queue directory to use.Gets the current mail sender.booleanReturns if this is the default mail sender.booleanverify(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, 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, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, onVirtualContainerCreated, onVirtualizationCompleted, 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, virtualizeMethods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, appendProp, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, 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, getReferencePropNameNoAssert, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParentNoAssert, getTreeLock, hasChanged, hasCircularReferencesError, 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, isPropRootLoading, isPropRootTreeModificationsAllowed, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, isSibling, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, paramString, 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, warning, warning, warningMethods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, waitMethods 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, hasCircularReferencesError, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, isSibling, 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, warning, warning, warningMethods inherited from interface com.iizix.prop.IPropCnr
canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized
Field Details
COMPRESS
Property name, saved mail compression type: 0=none, 1=gzip (default), 2=xz.- See Also:
DEBUG
Property name, debug: "debug", default false.- See Also:
QUEUED_MAIL_DIRECTORY
Property name: queued mail directory: "directory".- See Also:
DEFAULT_SENDER
Property name, default sender: "defaultSender".- See Also:
DEFAULT_REPLYTO
Property name, default sender: "defaultReplyTo".- See Also:
DEFAULT_CCS
Property name, default sender: "defaultCCs".- See Also:
DEFAULT_BCCS
Property name, default sender: "defaultBCCs".- See Also:
MAIL_HOST
Property name, mail host: "host".- See Also:
PORT
Property name, mail port: "port" (1-65534, default 25).- See Also:
BIND_ADDRESS
Property name, mail bind port, defaultnullfor none.- See Also:
SMTPS_PROTOCOL
Property name, mail host: "smtps".- See Also:
USE_SSL
Property name: enable SSL: "ssl".- See Also:
USE_STARTTLS
Property name: use STARTTLS: "STARTTLS".- See Also:
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:
TIMEOUT
Property name, timeout in milliseconds: "timeout".- See Also:
USER_NAME
The user name property string: "userName" (a StringProp).- See Also:
PASSWORD
The password property name: "password" (a PasswordProp).- See Also:
Constructor Details
MailProps
public MailProps()Creates the container properties without a name.MailProps
Creates the container properties with a name.- Parameters:
atom- The atom name.
Method Details
clone
Clone must be overridden.getMailQueueDirectory
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
Gets the current mail sender.- Returns:
- The instance created, or null if not yet created.
getDefaultSender
Gets the Default Sender.- Returns:
- The address, or null for none.
- Throws:
AddressException- If the address is invalid.
getDefaultReplyTo
Gets the Default Reply To.- Returns:
- The address, or null for none.
- Throws:
AddressException- If the address is invalid.
getDefaultCCs
Gets the Default CCs.- Returns:
- The address array "never zero in length", or null for none.
- Throws:
AddressException- If the address is invalid.
getDefaultBCCs
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(ExecutorService executorService, File baseDir) throws 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:
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
Verifies this property container. The check performed is the extension of classes and that no circular reference is present.