ISendMessagePluginResponse (formcycle: bom 8.4.0 API)

All Superinterfaces:: Serializable

public interface ISendMessagePluginResponse
extends Serializable

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Map<String,String>`	`getMessageProperties()`	Optional.
`String`	`getMessageReferenceId()`	Optional.
`String`	`getResolvedInboxId()`	Returns the ID of the postbox that was used to send the message.
`boolean`	`isSuccessful()`	Returns whether the message was successfully sent to the external message service provided by the plugin.

- Method Detail
  - getMessageProperties
```
Map<String,String> getMessageProperties()
```
    Optional. Returns an optional map of properties that were stored with the message.
    
    Returns:
    
    A map of properties that were stored with the message or empty if none are available.
  - getMessageReferenceId
```
String getMessageReferenceId()
```
    Optional. Returns some sort of ID that uniquely identifies the message within the external message service provided by the plugin.
    
    Returns:
    
    The message reference ID within the external message service provided by the plugin or empty if not available.
  - getResolvedInboxId
```
String getResolvedInboxId()
```
    Returns the ID of the postbox that was used to send the message.
    
    Returns:
    
    The ID of the postbox that was used to send the message, or empty if not available.
  - isSuccessful
```
boolean isSuccessful()
```
    Returns whether the message was successfully sent to the external message service provided by the plugin.
    
    Returns:
    
    True if the message was successfully sent, false otherwise.