Class AbstractMailListener<M, A, S extends IMailFileSystem<M,A>>

java.lang.Object

org.frankframework.filesystem.AbstractFileSystemListener<M,S>

org.frankframework.filesystem.AbstractMailListener<M,A,S>

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IHasProcessState<M>, IListener<M>, IProvidesMessageBrowsers<M>, IPullingListener<M>, IScopeProvider, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ExchangeMailListener, ImapListener

public abstract class AbstractMailListener<M, A, S extends IMailFileSystem<M,A>>
extends AbstractFileSystemListener<M,S>

Implementation of a AbstractFileSystemListener that enables a Receiver to look in a folder for received mails. When a mail is found, it is moved to an output folder (or it's deleted), so that it isn't found more then once. A xml string with information about the mail is passed to the pipeline.

example:

  <email>
     <recipients>
        <recipient type="to">***@nn.nl</recipient>
        <recipient type="cc">***@nn.nl</recipient>
     </recipients>
     <from>***@nn.nl</from>
     <subject>this is the subject</subject>
     <headers>
        <header name="prop1">value of first header property</header>
        <header name="prop2">value of second header property</header>
     </headers>
     <dateTimeSent>2015-11-18T11:40:19.000+0100</dateTimeSent>
     <dateTimeReceived>2015-11-18T11:41:04.000+0100</dateTimeReceived>
  </email>

Author:

Peter Leeuwenburgh, Gerrit van Brakel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractMailListener.MessageType

Nested classes/interfaces inherited from class AbstractFileSystemListener

AbstractFileSystemListener.IMessageType

Field Summary

Fields inherited from class AbstractFileSystemListener

FILENAME_KEY, FILEPATH_KEY, ORIGINAL_FILENAME_KEY

Constructor Summary

Constructors

Constructor	Description
AbstractMailListener()

Method Summary

Modifier and Type	Method	Description
Message	extractMessage(@NonNull RawMessageWrapper<M> rawMessage, @NonNull Map<String,Object> context)	Returns the filename, or the contents
AbstractMailListener.MessageType	getMessageType()
void	setMessageType(AbstractMailListener.MessageType messageType)	Determines the contents of the message that is sent to the Pipeline. can be one of: EMAIL, for an XML containing most relevant information, except the body and the attachments CONTENTS, for the body of the message MIME, for the MIME contents of the message NAME or PATH, for an internal handle of mail message, that can be used by a related MailFileSystemSender HEADER, for the value of the header matching the searchKey in the message context

Methods inherited from class AbstractFileSystemListener

afterMessageProcessed, changeProcessState, checkForExistenceOfFolder, closeThread, configure, createFileSystem, extractMessageProperties, getMessageBrowser, getPhysicalDestinationName, getRawMessage, getStateFolder, knownProcessStates, openThread, setCharset, setCreateFolders, setDelete, setDisableMessageBrowsers, setErrorFolder, setExcludeWildcard, setFileTimeSensitive, setHoldFolder, setInProcessFolder, setInputFolder, setLogFolder, setMessageIdPropertyKey, setMessageType, setMinStableTime, setName, setNumberOfBackups, setOutputFormat, setOverwrite, setProcessedFolder, setStoreMetadataInSessionKey, setWildcard, start, stop, targetProcessStates

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Constructor Details

AbstractMailListener

public AbstractMailListener()

Method Details

extractMessage

public Message extractMessage(@NonNull RawMessageWrapper<M> rawMessage,
 @NonNull Map<String,Object> context)
                       throws ListenerException

Description copied from class: AbstractFileSystemListener

Returns the filename, or the contents

Specified by:

extractMessage in interface IListener<M>

Overrides:

extractMessage in class AbstractFileSystemListener<M, S extends IMailFileSystem<M,A>>

Parameters:

rawMessage - The RawMessageWrapper from which to extract the Message.

context - Context to populate. Either a PipeLineSession or a Map threadContext depending on caller.

Returns:

input Message for adapter.

Throws:

ListenerException

setMessageType

public void setMessageType(AbstractMailListener.MessageType messageType)

Determines the contents of the message that is sent to the Pipeline. can be one of:

• EMAIL, for an XML containing most relevant information, except the body and the attachments
• CONTENTS, for the body of the message
• MIME, for the MIME contents of the message
• NAME or PATH, for an internal handle of mail message, that can be used by a related MailFileSystemSender
• HEADER, for the value of the header matching the searchKey in the message context

Default value

EMAIL

getMessageType

public AbstractMailListener.MessageType getMessageType()