Class RetrieveInboxMessagesResource


public class RetrieveInboxMessagesResource extends XmlResponderResource<MessageCollectionResponseDto>
This operation will return a paged response of all inbound messages to any Account that the user has permissions to view.
Author:
Mike Whittaker
  • Constructor Details

    • RetrieveInboxMessagesResource

      public RetrieveInboxMessagesResource(Authenticator auth, HttpQuery query)
      Instantiates a new retrieve inbox messages resource.
      Parameters:
      auth - the authenticator
      query - the query
    • RetrieveInboxMessagesResource

      public RetrieveInboxMessagesResource(Authenticator auth)
      Instantiates a new retrieve inbox messages resource.
      Parameters:
      auth - the authenticator
  • Method Details

    • getEndpointChild

      protected String getEndpointChild()
      Gets the child portion of the url required to access the resource. The child part is appended to the base url and must not start with a '/' The base url is of the form 'http://api.esendex.com/{version}/' where version maybe similar to 'v1.0'
      Specified by:
      getEndpointChild in class Resource
      Returns:
      the child portion of the url required to access this resource
    • getRequestMethod

      protected HttpRequestMethod getRequestMethod()
      Gets the HttpRequestMethod that this service stipulates eg GET, POST, PUT, DELETE.
      Specified by:
      getRequestMethod in class Resource
      Returns:
      the required HttpRequestMethod