Package com.novomind.ecom.api.imail.core

Interface IncomingMessageAnalyzer

public interface IncomingMessageAnalyzer

This interface is an extension point to analyze an IncomingMessage after the message has been received but before it is pushed to the central backlog.
The result of an analysis contains several types of AnalyzerDecisions.
The extension point is also able to cancel the message processing by throwing an exception.

Since:

11.15

See Also:

• CorePlugin

Method Summary

Modifier and Type	Method	Description
IncomingMessageAnalyzerResult	analyzeIncomingMessage(IncomingMessageAnalyzerInput incomingMessageAnalyzerInput)	The method is called after the message has been received but before it is pushed to the central backlog.

Method Details

analyzeIncomingMessage

IncomingMessageAnalyzerResult analyzeIncomingMessage(IncomingMessageAnalyzerInput incomingMessageAnalyzerInput)
                                              throws PermanentMessagingException,
TemporaryMessagingException

The method is called after the message has been received but before it is pushed to the central backlog.

Parameters:

incomingMessageAnalyzerInput - an IncomingMessageAnalyzerInput that provides the current state of analysis, the current IncomingBindings and information about the IncomingMessage.

Returns:

the IncomingMessageAnalyzerResult which contains the AnalyzerDecisions for this analysis step, or IncomingMessageAnalyzerResult.UNMODIFIED if no decisions where made.

Throws:

PermanentMessagingException - Throw a PermanentMessagingException to indicate a permanent error. The message will be removed from the incoming source without being processed. The message will be archived by the novomind iAGENT system.

TemporaryMessagingException - Throw a TemporaryMessagingException to indicate a temporary error. The message will stay on the incoming source and retrieved again after a short period of time.

Since:

11.15