InboundRouteApi

All URIs are relative to https://api.elasticemail.com/v4

Method	HTTP request	Description
inboundrouteByIdDelete	DELETE /inboundroute/{id}	Delete Route
inboundrouteByIdGet	GET /inboundroute/{id}	Get Route
inboundrouteByIdPut	PUT /inboundroute/{id}	Update Route
inboundrouteGet	GET /inboundroute	Get Routes
inboundrouteOrderPut	PUT /inboundroute/order	Update Sorting
inboundroutePost	POST /inboundroute	Create Route

inboundrouteByIdDelete

inboundrouteByIdDelete(id)

Delete Route

Deletes the Inbound Route. Required Access Level: ModifySettings

Example

// Import classes:
import com.elasticemail.client.ApiClient;
import com.elasticemail.client.ApiException;
import com.elasticemail.client.Configuration;
import com.elasticemail.client.auth.*;
import com.elasticemail.client.models.*;
import com.elasticemail.api.InboundRouteApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.elasticemail.com/v4");
    
    // Configure API key authorization: apikey
    ApiKeyAuth apikey = (ApiKeyAuth) defaultClient.getAuthentication("apikey");
    apikey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //apikey.setApiKeyPrefix("Token");

    InboundRouteApi apiInstance = new InboundRouteApi(defaultClient);
    String id = "id_example"; // String | 
    try {
      apiInstance.inboundrouteByIdDelete(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling InboundRouteApi#inboundrouteByIdDelete");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String

Return type

null (empty response body)

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

inboundrouteByIdGet

InboundRoute inboundrouteByIdGet(id)

Get Route

Load an Inbound Route. Required Access Level: ViewSettings

Example

// Import classes:
import com.elasticemail.client.ApiClient;
import com.elasticemail.client.ApiException;
import com.elasticemail.client.Configuration;
import com.elasticemail.client.auth.*;
import com.elasticemail.client.models.*;
import com.elasticemail.api.InboundRouteApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.elasticemail.com/v4");
    
    // Configure API key authorization: apikey
    ApiKeyAuth apikey = (ApiKeyAuth) defaultClient.getAuthentication("apikey");
    apikey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //apikey.setApiKeyPrefix("Token");

    InboundRouteApi apiInstance = new InboundRouteApi(defaultClient);
    String id = "123456"; // String | ID number of your attachment
    try {
      InboundRoute result = apiInstance.inboundrouteByIdGet(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling InboundRouteApi#inboundrouteByIdGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String	ID number of your attachment

Return type

InboundRoute

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

inboundrouteByIdPut

InboundRoute inboundrouteByIdPut(id, inboundPayload)

Update Route

Update the Inbound Route. Required Access Level: ModifySettings

Example

// Import classes:
import com.elasticemail.client.ApiClient;
import com.elasticemail.client.ApiException;
import com.elasticemail.client.Configuration;
import com.elasticemail.client.auth.*;
import com.elasticemail.client.models.*;
import com.elasticemail.api.InboundRouteApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.elasticemail.com/v4");
    
    // Configure API key authorization: apikey
    ApiKeyAuth apikey = (ApiKeyAuth) defaultClient.getAuthentication("apikey");
    apikey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //apikey.setApiKeyPrefix("Token");

    InboundRouteApi apiInstance = new InboundRouteApi(defaultClient);
    String id = "id_example"; // String | 
    InboundPayload inboundPayload = new InboundPayload(); // InboundPayload | 
    try {
      InboundRoute result = apiInstance.inboundrouteByIdPut(id, inboundPayload);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling InboundRouteApi#inboundrouteByIdPut");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
id	String
inboundPayload	InboundPayload

Return type

InboundRoute

Authorization

apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

inboundrouteGet

List<InboundRoute> inboundrouteGet()

Get Routes

Get all your Inbound Routes. Required Access Level: ViewSettings

Example

// Import classes:
import com.elasticemail.client.ApiClient;
import com.elasticemail.client.ApiException;
import com.elasticemail.client.Configuration;
import com.elasticemail.client.auth.*;
import com.elasticemail.client.models.*;
import com.elasticemail.api.InboundRouteApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.elasticemail.com/v4");
    
    // Configure API key authorization: apikey
    ApiKeyAuth apikey = (ApiKeyAuth) defaultClient.getAuthentication("apikey");
    apikey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //apikey.setApiKeyPrefix("Token");

    InboundRouteApi apiInstance = new InboundRouteApi(defaultClient);
    try {
      List<InboundRoute> result = apiInstance.inboundrouteGet();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling InboundRouteApi#inboundrouteGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

List<InboundRoute>

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

inboundrouteOrderPut

List<InboundRoute> inboundrouteOrderPut(sortOrderItem)

Update Sorting

Required Access Level: ViewSettings

Example

// Import classes:
import com.elasticemail.client.ApiClient;
import com.elasticemail.client.ApiException;
import com.elasticemail.client.Configuration;
import com.elasticemail.client.auth.*;
import com.elasticemail.client.models.*;
import com.elasticemail.api.InboundRouteApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.elasticemail.com/v4");
    
    // Configure API key authorization: apikey
    ApiKeyAuth apikey = (ApiKeyAuth) defaultClient.getAuthentication("apikey");
    apikey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //apikey.setApiKeyPrefix("Token");

    InboundRouteApi apiInstance = new InboundRouteApi(defaultClient);
    List<SortOrderItem> sortOrderItem = Arrays.asList(); // List<SortOrderItem> | Change the ordering of inbound routes for when matching the inbound
    try {
      List<InboundRoute> result = apiInstance.inboundrouteOrderPut(sortOrderItem);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling InboundRouteApi#inboundrouteOrderPut");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
sortOrderItem	List<SortOrderItem>	Change the ordering of inbound routes for when matching the inbound

Return type

List<InboundRoute>

Authorization

apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

inboundroutePost

InboundRoute inboundroutePost(inboundPayload)

Create Route

Create new Inbound Route. Required Access Level: ModifySettings

Example

// Import classes:
import com.elasticemail.client.ApiClient;
import com.elasticemail.client.ApiException;
import com.elasticemail.client.Configuration;
import com.elasticemail.client.auth.*;
import com.elasticemail.client.models.*;
import com.elasticemail.api.InboundRouteApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.elasticemail.com/v4");
    
    // Configure API key authorization: apikey
    ApiKeyAuth apikey = (ApiKeyAuth) defaultClient.getAuthentication("apikey");
    apikey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //apikey.setApiKeyPrefix("Token");

    InboundRouteApi apiInstance = new InboundRouteApi(defaultClient);
    InboundPayload inboundPayload = new InboundPayload(); // InboundPayload | 
    try {
      InboundRoute result = apiInstance.inboundroutePost(inboundPayload);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling InboundRouteApi#inboundroutePost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
inboundPayload	InboundPayload

Return type

InboundRoute

Authorization

apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

FilesExpand file tree

InboundRouteApi.md

Latest commit

History

InboundRouteApi.md

File metadata and controls

InboundRouteApi

inboundrouteByIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inboundrouteByIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inboundrouteByIdPut

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inboundrouteGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inboundrouteOrderPut

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

inboundroutePost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details