Interface MailSource
-
- All Superinterfaces:
EventSource<MailEvent>
,Runnable
- All Known Subinterfaces:
FilteredMailSource
,PollingMailSource
- All Known Implementing Classes:
FilteredMailEventActivitySource
,FilteredMailEventSource
,MailEventActivitySource
,MailEventSource
@ConfigurationDescription(properties={@Property(name="Protocol",description="The protocol to use for this mail events, for instance pop3, imap, ..."),,,,,,}) public interface MailSource extends EventSource<MailEvent>
An event source causing an event based on the presence of a mail. This may be a mail that has been received or that has been stored to a special folder.
An ordinary implementation of this mail source creates an event for each mail present in the folder. This is good for mostly empty folders. Filters may apply for specific mails. It is not advised to track the mails internally and only create events for new mails and ignore existing mails. This should be rather solved with an event handler moving a mail that has been successfully handled so that the mail source does not find the mail again.
-
-
Field Summary
Fields Modifier and Type Field Description static String
CONF_FOLDER
Configuration key for the folder in which to look for the mails that cause the events of this event source.static String
CONF_HOST
Configuration key for the host to connect to and from which to use as mail source.static String
CONF_PASSWORD
Configuration key for the password to connect to the host with.static String
CONF_PORT
Configuration key for the port of the host to which to connect to.static String
CONF_PROTOCOL
Configuration key for the protocol to use for this mail events, for instance pop3, imap, ...static String
CONF_SSL_PROTOCOLS
Configuration key for the SSL protocols used for secure protocols.static String
CONF_TIMEOUT
Configuration key for the timeout which to use for the connection.static String
CONF_USER_NAME
Configuration key for the user name to connect to the host with.
-
Method Summary
-
Methods inherited from interface de.aristaflow.adept2.model.events.sources.EventSource
addAll, addHandler, getEventHandler, getHierarchicalSourceName, getID, getType, removeHandler, setConfiguration
-
-
-
-
Field Detail
-
CONF_PROTOCOL
static final String CONF_PROTOCOL
Configuration key for the protocol to use for this mail events, for instance pop3, imap, ...- See Also:
- Constant Field Values
-
CONF_SSL_PROTOCOLS
static final String CONF_SSL_PROTOCOLS
Configuration key for the SSL protocols used for secure protocols. This may be a list of protocols where each protocol is separated by whitespace (TLSv1.2 TLSv1.3
).- See Also:
- Constant Field Values
-
CONF_HOST
static final String CONF_HOST
Configuration key for the host to connect to and from which to use as mail source.- See Also:
- Constant Field Values
-
CONF_PORT
static final String CONF_PORT
Configuration key for the port of the host to which to connect to.- See Also:
- Constant Field Values
-
CONF_TIMEOUT
static final String CONF_TIMEOUT
Configuration key for the timeout which to use for the connection.- See Also:
- Constant Field Values
-
CONF_USER_NAME
static final String CONF_USER_NAME
Configuration key for the user name to connect to the host with.- See Also:
- Constant Field Values
-
CONF_PASSWORD
static final String CONF_PASSWORD
Configuration key for the password to connect to the host with.- See Also:
- Constant Field Values
-
CONF_FOLDER
static final String CONF_FOLDER
Configuration key for the folder in which to look for the mails that cause the events of this event source.- See Also:
- Constant Field Values
-
-