Package software.xdev.brevo.api

Class InboundParsingApi

java.lang.Object

software.xdev.brevo.api.InboundParsingApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class InboundParsingApi
extends Object

Constructor Summary

Constructors

Constructor	Description
InboundParsingApi()
InboundParsingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
File	getInboundEmailAttachment(String downloadToken)	Retrieve inbound attachment with download token.
File	getInboundEmailAttachment(String downloadToken, Map<String,String> additionalHeaders)	Retrieve inbound attachment with download token.
GetInboundEmailEvents	getInboundEmailEvents(String sender, String startDate, String endDate, Long limit, Long offset, String sort)	Get the list of all the events for the received emails.
GetInboundEmailEvents	getInboundEmailEvents(String sender, String startDate, String endDate, Long limit, Long offset, String sort, Map<String,String> additionalHeaders)	Get the list of all the events for the received emails.
GetInboundEmailEventsByUuid	getInboundEmailEventsByUuid(String uuid)	Fetch all events history for one particular received email.
GetInboundEmailEventsByUuid	getInboundEmailEventsByUuid(String uuid, Map<String,String> additionalHeaders)	Fetch all events history for one particular received email.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InboundParsingApi

public InboundParsingApi()

InboundParsingApi

public InboundParsingApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getInboundEmailAttachment

public File getInboundEmailAttachment(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(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(String sender,
 String startDate,
 String endDate,
 Long limit,
 Long offset,
 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(String sender,
 String startDate,
 String endDate,
 Long limit,
 Long offset,
 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(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(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