nl.nn.adapterframework.filesystem

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

java.lang.Object

nl.nn.adapterframework.filesystem.FileSystemListener<M,S>

nl.nn.adapterframework.filesystem.MailListener<M,A,S>

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IHasProcessState<M>, IListener<M>, INamedObject, IProvidesMessageBrowsers<M>, IPullingListener<M>, IScopeProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ExchangeMailListener, ImapListener

public abstract class MailListener<M,A,S extends IMailFileSystem<M,A>>
extends FileSystemListener<M,S>

Implementation of a FileSystemListener 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

Field Summary

Fields

Modifier and Type	Field and Description
String	EMAIL_MESSAGE_TYPE
String	MIME_MESSAGE_TYPE

Fields inherited from class nl.nn.adapterframework.filesystem.FileSystemListener

FILENAME_KEY, FILEPATH_KEY, log, ORIGINAL_FILENAME_KEY

Constructor Summary

Constructors

Constructor and Description
MailListener()

Method Summary

Modifier and Type	Method and Description
Message	extractMessage(RawMessageWrapper<M> rawMessage, Map<String,Object> context) Returns the filename, or the contents
void	setMessageType(String messageType) Determines the contents of the message that is sent to the Pipeline.
void	setSimple(boolean b) Deprecated.
void	setStoreEmailAsStreamInSessionKey(String string) Deprecated.

Methods inherited from class nl.nn.adapterframework.filesystem.FileSystemListener

afterMessageProcessed, changeProcessState, checkForExistenceOfFolder, close, closeThread, configure, createFileSystem, extractMessageProperties, getDomain, getMessageBrowser, getPhysicalDestinationName, getRawMessage, getStateFolder, knownProcessStates, open, openThread, setCharset, setCreateFolders, setCreateInputDirectory, setDelete, setDisableMessageBrowsers, setErrorFolder, setExcludeWildcard, setExcludeWildCard, setFileTimeSensitive, setHoldFolder, setInProcessFolder, setInputDirectory, setInputFolder, setLogFolder, setMessageIdPropertyKey, setMinStableTime, setName, setNumberOfBackups, setOutputDirectory, setOutputFormat, setOverwrite, setProcessedDirectory, setProcessedFolder, setStoreMetadataInSessionKey, setWildcard, setWildCard, targetProcessStates

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Field Detail

EMAIL_MESSAGE_TYPE

public final String EMAIL_MESSAGE_TYPE

See Also:

Constant Field Values

MIME_MESSAGE_TYPE

public final String MIME_MESSAGE_TYPE

See Also:

Constant Field Values

Constructor Detail

MailListener

public MailListener()

Method Detail

extractMessage

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

Description copied from class: FileSystemListener

Returns the filename, or the contents

Specified by:

extractMessage in interface IListener<M>

Overrides:

extractMessage in class FileSystemListener<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

setSimple

@Deprecated
 @ConfigurationWarning(value="Please use <code>messageType</code> to control the message produced by the listener")
public void setSimple(boolean b)

Deprecated.

when set to true, the xml string passed to the pipeline only contains the subject of the mail (to save memory)

Default value

false

setStoreEmailAsStreamInSessionKey

@Deprecated
 @ConfigurationWarning(value="Please use <code>messageType=mime</code> and sessionKey originalMessage")
public void setStoreEmailAsStreamInSessionKey(String string)

Deprecated.

setMessageType

public void setMessageType(String 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
• the key of any header present in the message context

Overrides:

setMessageType in class FileSystemListener<M,S extends IMailFileSystem<M,A>>

Default value

email