Package software.xdev.brevo.api

Class InboundParsingApi

java.lang.Object
software.xdev.brevo.client.BaseApi
software.xdev.brevo.api.InboundParsingApi
public class InboundParsingApi extends BaseApi

  • Constructor Details

    • InboundParsingApi

      public InboundParsingApi()

    • InboundParsingApi

      public InboundParsingApi(ApiClient apiClient)

  • Method Details

    • getInboundEmailAttachment

      public File getInboundEmailAttachment(@Nonnull String downloadToken) throws ApiException
      Retrieve inbound attachment with download token. This endpoint will retrieve inbound attachment with download token.
      Parameters:
      downloadToken - Token to fetch a particular attachment (required)
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getInboundEmailAttachment

      public File getInboundEmailAttachment(@Nonnull String downloadToken, Map<String,String> additionalHeaders) throws ApiException
      Retrieve inbound attachment with download token. This endpoint will retrieve inbound attachment with download token.
      Parameters:
      downloadToken - Token to fetch a particular attachment (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getInboundEmailEvents

      public GetInboundEmailEvents getInboundEmailEvents(@Nullable String sender, @Nullable String startDate, @Nullable String endDate, @Nullable Long limit, @Nullable Long offset, @Nullable String sort) throws ApiException
      Get the list of all the events for the received emails. This endpoint will show the list of all the events for the received emails.
      Parameters:
      sender - Email address of the sender. (optional)
      startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional)
      endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional)
      limit - Number of documents returned per page (optional, default to 100)
      offset - Index of the first document on the page (optional, default to 0)
      sort - Sort the results in the ascending/descending order of record creation (optional, default to desc)
      Returns:
      GetInboundEmailEvents
      Throws:
      ApiException - if fails to make API call

    • getInboundEmailEvents

      public GetInboundEmailEvents getInboundEmailEvents(@Nullable String sender, @Nullable String startDate, @Nullable String endDate, @Nullable Long limit, @Nullable Long offset, @Nullable String sort, Map<String,String> additionalHeaders) throws ApiException
      Get the list of all the events for the received emails. This endpoint will show the list of all the events for the received emails.
      Parameters:
      sender - Email address of the sender. (optional)
      startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional)
      endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional)
      limit - Number of documents returned per page (optional, default to 100)
      offset - Index of the first document on the page (optional, default to 0)
      sort - Sort the results in the ascending/descending order of record creation (optional, default to desc)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetInboundEmailEvents
      Throws:
      ApiException - if fails to make API call

    • getInboundEmailEventsByUuid

      public GetInboundEmailEventsByUuid getInboundEmailEventsByUuid(@Nonnull String uuid) throws ApiException
      Fetch all events history for one particular received email. This endpoint will show the list of all events history for one particular received email.
      Parameters:
      uuid - UUID to fetch events specific to recieved email (required)
      Returns:
      GetInboundEmailEventsByUuid
      Throws:
      ApiException - if fails to make API call

    • getInboundEmailEventsByUuid

      public GetInboundEmailEventsByUuid getInboundEmailEventsByUuid(@Nonnull String uuid, Map<String,String> additionalHeaders) throws ApiException
      Fetch all events history for one particular received email. This endpoint will show the list of all events history for one particular received email.
      Parameters:
      uuid - UUID to fetch events specific to recieved email (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetInboundEmailEventsByUuid
      Throws:
      ApiException - if fails to make API call

    • invokeAPI

      public <T> T invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders) throws ApiException
      Description copied from class: BaseApi
      Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.
      Specified by:
      invokeAPI in class BaseApi
      Parameters:
      url - The URL for the request, either full URL or only the path.
      method - The HTTP method for the request.
      request - The request object.
      returnType - The return type.
      additionalHeaders - Additional headers for the request.
      Returns:
      The API response in the specified type.
      Throws:
      ApiException - if fails to make API call.