Package com.flowable.platform.engine.impl.eventregistry.mail

Class MailInboundChannelModel

java.lang.Object

org.flowable.eventregistry.model.ChannelModel

org.flowable.eventregistry.model.InboundChannelModel

com.flowable.platform.engine.impl.eventregistry.mail.MailInboundChannelModel

public class MailInboundChannelModel
extends InboundChannelModel

Author:

Filip Hrisafov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MailInboundChannelModel.AuthenticationProperties
static class	MailInboundChannelModel.CustomProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected MailInboundChannelModel.AuthenticationProperties	authentication	The authentication configuration.
protected List<MailInboundChannelModel.CustomProperty>	customProperties	The custom properties that should be passed to the mail receiver.
protected String	deleteMessages	Whether messages should be deleted after they've been received.
protected String	markMessagesAsRead	Whether messages should be marked as read once they've been received.
protected String	maxMessagesPerPoll	The maximum number of messages that should be polled in one polling iteration.
protected String	pollingRate	The duration at which the messages from the mail server should be polled.
protected Pattern	subjectCorrelationPattern	A pattern that can be used to extract groups from the subject that should be used for creating the subject correlation payload.
protected String	supportsIdle	Whether the IMAP server support IMAP IDLE.
protected String	url	The IMAP url for the inbound mail
protected String	userFlag	The name of the flag to use to flag messages when the server does not support \Recent, but supports user flags.

Fields inherited from class org.flowable.eventregistry.model.InboundChannelModel

channelEventKeyDetection, channelEventTenantIdDetection, deserializerDelegateExpression, deserializerType, eventTransformerDelegateExpression, inboundEventChannelAdapter, inboundEventProcessingPipeline, payloadExtractorDelegateExpression, pipelineDelegateExpression

Fields inherited from class org.flowable.eventregistry.model.ChannelModel

category, channelType, description, key, name, type

Constructor Summary

Constructors

Constructor	Description
MailInboundChannelModel()

Method Summary

Modifier and Type	Method	Description
void	addCustomProperty(String name, String value)
MailInboundChannelModel.AuthenticationProperties	getAuthentication()
MailChannelEventTenantIdDetection	getChannelEventTenantIdDetection()
List<MailInboundChannelModel.CustomProperty>	getCustomProperties()
String	getDeleteMessages()
String	getMarkMessagesAsRead()
String	getMaxMessagesPerPoll()
String	getPollingRate()
Pattern	getSubjectCorrelationPattern()
String	getSubjectCorrelationPatternString()
String	getSupportsIdle()
String	getUrl()
String	getUserFlag()
void	setAuthentication(MailInboundChannelModel.AuthenticationProperties authentication)
void	setChannelEventTenantIdDetection(MailChannelEventTenantIdDetection channelEventTenantIdDetection)
void	setChannelEventTenantIdDetection(ChannelEventTenantIdDetection channelEventTenantIdDetection)
void	setCustomProperties(List<MailInboundChannelModel.CustomProperty> customProperties)
void	setDeleteMessages(String deleteMessages)
void	setMarkMessagesAsRead(String markMessagesAsRead)
void	setMaxMessagesPerPoll(String maxMessagesPerPoll)
void	setPollingRate(String pollingRate)
void	setSubjectCorrelationPattern(String subjectCorrelationPattern)
void	setSubjectCorrelationPattern(Pattern subjectCorrelationPattern)
void	setSupportsIdle(String supportsIdle)
void	setUrl(String url)
void	setUserFlag(String userFlag)

Methods inherited from class org.flowable.eventregistry.model.InboundChannelModel

getChannelEventKeyDetection, getDeserializerDelegateExpression, getDeserializerType, getEventTransformerDelegateExpression, getInboundEventChannelAdapter, getInboundEventProcessingPipeline, getPayloadExtractorDelegateExpression, getPipelineDelegateExpression, setChannelEventKeyDetection, setDeserializerDelegateExpression, setDeserializerType, setEventTransformerDelegateExpression, setInboundEventChannelAdapter, setInboundEventProcessingPipeline, setPayloadExtractorDelegateExpression, setPipelineDelegateExpression

Methods inherited from class org.flowable.eventregistry.model.ChannelModel

getCategory, getChannelType, getDescription, getKey, getName, getType, setCategory, setChannelType, setDescription, setKey, setName, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

url

protected String url

The IMAP url for the inbound mail

deleteMessages

protected String deleteMessages

Whether messages should be deleted after they've been received. If not set the global default will be used.

markMessagesAsRead

protected String markMessagesAsRead

Whether messages should be marked as read once they've been received. If not set the global default will be used.

userFlag

protected String userFlag

The name of the flag to use to flag messages when the server does not support \Recent, but supports user flags. If not set the global default will be used.

supportsIdle

protected String supportsIdle

Whether the IMAP server support IMAP IDLE. When this is set to true then IMAP IDLE will be used to receive messages.

pollingRate

protected String pollingRate

The duration at which the messages from the mail server should be polled.

maxMessagesPerPoll

protected String maxMessagesPerPoll

The maximum number of messages that should be polled in one polling iteration.

subjectCorrelationPattern

protected Pattern subjectCorrelationPattern

A pattern that can be used to extract groups from the subject that should be used for creating the subject correlation payload.

authentication

protected MailInboundChannelModel.AuthenticationProperties authentication

The authentication configuration.

customProperties

protected List<MailInboundChannelModel.CustomProperty> customProperties

The custom properties that should be passed to the mail receiver.

Constructor Detail

MailInboundChannelModel

public MailInboundChannelModel()

Method Detail

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getDeleteMessages

public String getDeleteMessages()

setDeleteMessages

public void setDeleteMessages(String deleteMessages)

getMarkMessagesAsRead

public String getMarkMessagesAsRead()

setMarkMessagesAsRead

public void setMarkMessagesAsRead(String markMessagesAsRead)

getUserFlag

public String getUserFlag()

setUserFlag

public void setUserFlag(String userFlag)

getSupportsIdle

public String getSupportsIdle()

setSupportsIdle

public void setSupportsIdle(String supportsIdle)

getPollingRate

public String getPollingRate()

getMaxMessagesPerPoll

public String getMaxMessagesPerPoll()

setMaxMessagesPerPoll

public void setMaxMessagesPerPoll(String maxMessagesPerPoll)

setPollingRate

public void setPollingRate(String pollingRate)

getSubjectCorrelationPattern

public Pattern getSubjectCorrelationPattern()

setSubjectCorrelationPattern

public void setSubjectCorrelationPattern(Pattern subjectCorrelationPattern)

getSubjectCorrelationPatternString

public String getSubjectCorrelationPatternString()

setSubjectCorrelationPattern

public void setSubjectCorrelationPattern(String subjectCorrelationPattern)

getAuthentication

public MailInboundChannelModel.AuthenticationProperties getAuthentication()

setAuthentication

public void setAuthentication(MailInboundChannelModel.AuthenticationProperties authentication)

getCustomProperties

public List<MailInboundChannelModel.CustomProperty> getCustomProperties()

addCustomProperty

public void addCustomProperty(String name,
                              String value)

setCustomProperties

public void setCustomProperties(List<MailInboundChannelModel.CustomProperty> customProperties)

getChannelEventTenantIdDetection

public MailChannelEventTenantIdDetection getChannelEventTenantIdDetection()

Overrides:

getChannelEventTenantIdDetection in class InboundChannelModel

setChannelEventTenantIdDetection

public void setChannelEventTenantIdDetection(ChannelEventTenantIdDetection channelEventTenantIdDetection)

Overrides:

setChannelEventTenantIdDetection in class InboundChannelModel

setChannelEventTenantIdDetection

public void setChannelEventTenantIdDetection(MailChannelEventTenantIdDetection channelEventTenantIdDetection)