Package esendex.sdk.java.service.impl
Class InboxServiceImpl
java.lang.Object
esendex.sdk.java.service.impl.AbstractService
esendex.sdk.java.service.impl.InboxServiceImpl
- All Implemented Interfaces:
InboxService
The Class InboxServiceImpl.
- Author:
- Mike Whittaker
-
Field Summary
Fields inherited from class esendex.sdk.java.service.impl.AbstractService
authenticator
-
Constructor Summary
ConstructorsConstructorDescriptionInboxServiceImpl
(Authenticator authenticator) Instantiates a new inbox service -
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.
-
Constructor Details
-
InboxServiceImpl
Instantiates a new inbox service- Parameters:
authenticator
- the authenticator
-
-
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.- Specified by:
deleteMessage
in interfaceInboxService
- 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.- Specified by:
getMessage
in interfaceInboxService
- Parameters:
id
- the id- Returns:
- the message
- Throws:
EsendexException
- the esendex exception
-
getMessages
Gets the messages.- Specified by:
getMessages
in interfaceInboxService
- Returns:
- the messages
- Throws:
EsendexException
- the esendex exception
-
getMessages
public InboxMessageCollectionResponse getMessages(int pageNumber, int pageSize) throws EsendexException Gets the messages.- Specified by:
getMessages
in interfaceInboxService
- Parameters:
pageNumber
- the page numberpageSize
- the page size- Returns:
- the messages
- Throws:
EsendexException
- the esendex exception
-
getMessages
Gets the messages.- Specified by:
getMessages
in interfaceInboxService
- Parameters:
accountReference
- the account reference- Returns:
- the messages
- Throws:
EsendexException
- the esendex exception
-
getMessages
public InboxMessageCollectionResponse getMessages(String accountReference, int pageNumber, int pageSize) throws EsendexException Gets the messages.- Specified by:
getMessages
in interfaceInboxService
- Parameters:
accountReference
- the account referencepageNumber
- the page numberpageSize
- the page size- Returns:
- the messages
- Throws:
EsendexException
- the esendex exception
-
markMessageAsRead
Mark message as read.- Specified by:
markMessageAsRead
in interfaceInboxService
- Parameters:
id
- the id- Returns:
- true, if successful
- Throws:
EsendexException
- the esendex exception
-
markMessageAsUnread
Mark message as unread.- Specified by:
markMessageAsUnread
in interfaceInboxService
- Parameters:
id
- the id- Returns:
- true, if successful
- Throws:
EsendexException
- the esendex exception
-