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

Interface IncomingMessageManipulator

public interface IncomingMessageManipulator

This plugin allows to manipulate the incoming message before being processed. Both the original and the manipulated message will be archived but only the manipulated message will be used in the workflow. Please note that the methods of this interface will be called very frequently during single threaded synchronous account polling operations that keep blocking until the method returns. Please do not implement any long term operations within the method implementations of this interface. Any long term operations must be implemented in other suitable extension points like IncomingMessageReceivedEventListener or IncomingMessageAnalyzer or TemplateMessageManipulator.

Since:
11.4

  • Method Details

    • manipulateIncomingMessage

      IncomingMessageManipulationResult manipulateIncomingMessage(IncomingMessageManipulationInput incomingMessageManipulationInput)
      This method is called before the incoming message enters the processing cycle. Please note that this method will be called on all plugins implementing the interface IncomingMessageManipulator. Subsequent plugins will receive the manipulated data from the previous manipulation step.
      Parameters:
      incomingMessageManipulationInput - provides all data to manipulate the incoming message
      Returns:
      the IncomingMessageManipulationResult optionally provides the manipulated message.
      Since:
      11.4