Package com.novomind.ecom.api.iagent.message

Interface IncomingMessageHandler

public interface IncomingMessageHandler

This handler provides functionality to append a Message to the incoming queue for a specific Account to be processed by the novomind iAGENT Core process. The IncomingMessageHandler is injectable in the novomind iAGENT routing process and also in the novomind iAGENT Desk- and core process.

Since:

13.0

Method Summary

Modifier and Type	Method	Description
NextMessageInfo	createNextMessageInfo()	The method creates a new NextMessageInfo object that can be used to apply Storage data or IncomingBindings to the Ticket that will be created by the receiveMessage(Message, Account, Optional) method.
MessageInfo	receiveMessage(jakarta.mail.Message message, Account account, Optional<NextMessageInfo> nextMessageInfo)	The method appends a Message to the incoming queue for the specified Account to be asynchronously processed by the novomind iAGENT Core process and returns the MessageInfo with the id of the associated Ticket.

Method Details

createNextMessageInfo

NextMessageInfo createNextMessageInfo()

The method creates a new NextMessageInfo object that can be used to apply Storage data or IncomingBindings to the Ticket that will be created by the receiveMessage(Message, Account, Optional) method.

Returns:

the NextMessageInfo object

Since:

13.0

receiveMessage

MessageInfo receiveMessage(jakarta.mail.Message message,
 Account account,
 Optional<NextMessageInfo> nextMessageInfo)
                    throws jakarta.mail.MessagingException,
ValidationException,
TemporaryMessagingException,
PermanentMessagingException

The method appends a Message to the incoming queue for the specified Account to be asynchronously processed by the novomind iAGENT Core process and returns the MessageInfo with the id of the associated Ticket. Please note that when the method returns, the message is not yet processed and therefore the associated ticket has neither a Category nor any Storage data and also does not appear in the backlog until being fully processed by the novomind iAGENT Core process.

Parameters:

message - the Message to be processed

account - the Account to be used to process the message

nextMessageInfo - the optional NextMessageInfo object to pass specific data to the message analyze procedure

Returns:

the MessageInfo object with the id of the ticket associated with the appended message

Throws:

jakarta.mail.MessagingException - in case of invalid message

ValidationException - in case of invalid or inappropriate account

TemporaryMessagingException - in case of a temporary message processing error

PermanentMessagingException - in case of a permanent message processing error

Since:

13.0