Package esendex.sdk.java.service
Interface InboxService
- All Known Implementing Classes:
InboxServiceImpl
public interface InboxService
A service for querying an Esendex Inbox.
All methods throw an EsendexException to indicate either a problem during
the underlying connection or there was a none okay response.
- Author:
- Mike Whittaker
-
Method Summary
Modifier and TypeMethodDescriptionboolean
deleteMessage
(String id) This operation will remove an individual message from an Inbox.getMessage
(String id) Gets the message.Gets the messages.getMessages
(int pageNumber, int pageSize) Gets the messages.getMessages
(String accountReference) Gets the messages.getMessages
(String accountReference, int pageNumber, int pageSize) Gets the messages.boolean
Mark message as read.boolean
Mark message as unread.
-
Method Details
-
deleteMessage
This operation will remove an individual message from an Inbox. As the message is identified by its GUID there is no additional need to specify which Account the message belongs to.- Parameters:
id
- the message id- Returns:
- true if the message has been deleted successfully otherwise false
- Throws:
EsendexException
- the esendex exception
-
getMessage
Gets the message.- Parameters:
id
- the id- Returns:
- the message
- Throws:
EsendexException
- the esendex exception
-
getMessages
Gets the messages.- Returns:
- the messages
- Throws:
EsendexException
- the esendex exception
-
getMessages
Gets the messages.- Parameters:
pageNumber
- the page numberpageSize
- the page size- Returns:
- the messages
- Throws:
EsendexException
- the esendex exception
-
getMessages
Gets the messages.- Parameters:
accountReference
- the account reference- Returns:
- the messages
- Throws:
EsendexException
- the esendex exception
-
getMessages
InboxMessageCollectionResponse getMessages(String accountReference, int pageNumber, int pageSize) throws EsendexException Gets the messages.- Parameters:
accountReference
- the account referencepageNumber
- the page numberpageSize
- the page size- Returns:
- the messages
- Throws:
EsendexException
- the esendex exception
-
markMessageAsRead
Mark message as read.- Parameters:
id
- the id- Returns:
- true, if successful
- Throws:
EsendexException
- the esendex exception
-
markMessageAsUnread
Mark message as unread.- Parameters:
id
- the id- Returns:
- true, if successful
- Throws:
EsendexException
- the esendex exception
-