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

Interface OutgoingMessageHandler

public interface OutgoingMessageHandler

This handler provides functionality to access the messages on the central outgoing message folder. It also allows to append a Message to the central outgoing message folder to be sent by a specific Account. The appended message will be sent asynchronously by the novomind iAGENT core process. The OutgoingMessageHandler is injectable in the novomind iAGENT routing process and also in the novomind iAGENT Desk- and core process.

Since:

12.9

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	OutgoingMessageHandler.SendOptions	Represents options to send a message

Method Summary

Modifier and Type	Method	Description
jakarta.mail.Message	sendMessage(jakarta.mail.Message message, Account account, OutgoingMessageHandler.SendOptions sendOptions)	Appends a Message to the central outgoing message folder to be sent by a specific Account.
Stream<OutgoingMessageInfo>	stream()	Returns a Stream over the OutgoingMessageInfo elements on the central outgoing message folder as its source that are related to a ticket.

Method Details

stream

Stream<OutgoingMessageInfo> stream()

Returns a Stream over the OutgoingMessageInfo elements on the central outgoing message folder as its source that are related to a ticket. The OutgoingMessageInfo provides the OutgoingMessage and the related Ticket. Please note that there may be more than one element for the same related Ticket on the central outgoing message folder, e.g. a confirmation and an intermediate reply or an external forwarded message that are all related to the same Ticket and waiting to be sent.

Returns:

a Stream over the OutgoingMessageInfo elements as its source.

Since:

13.15

sendMessage

jakarta.mail.Message sendMessage(jakarta.mail.Message message,
 Account account,
 OutgoingMessageHandler.SendOptions sendOptions)
                          throws jakarta.mail.MessagingException,
ValidationException

Appends a Message to the central outgoing message folder to be sent by a specific Account. Please note that the specified Account to send the message must be able to send messages Account.isSendAllowed(). Otherwise a ValidationException will be thrown. The message will be sent asynchronously by the novomind iAGENT core process. In case of a PermanentMessagingException during the send operation the message remains flagged on the central outgoing folder and requires manual action by a supervisor.

Parameters:

message - the Message to be sent

account - the Account to be used to send the message

sendOptions - the OutgoingMessageHandler.SendOptions for the message

Returns:

the message after it has been successfully appended to the outgoing message folder

Throws:

jakarta.mail.MessagingException - in case of invalid message

ValidationException - in case of invalid or inappropriate account

Since:

12.9