InboxRulesetControllerApi
All URIs are relative to https://java.api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
createNewInboxRuleset | POST /rulesets | Create an inbox ruleset |
deleteInboxRuleset | DELETE /rulesets/{id} | Delete an inbox ruleset |
deleteInboxRulesets | DELETE /rulesets | Delete inbox rulesets |
getInboxRuleset | GET /rulesets/{id} | Get an inbox ruleset |
getInboxRulesets | GET /rulesets | List inbox rulesets |
testInboxRuleset | POST /rulesets/{id}/test | Test an inbox ruleset |
testInboxRulesetsForInbox | PUT /rulesets | Test inbox rulesets for inbox |
testNewInboxRuleset | PATCH /rulesets | Test new inbox ruleset |
InboxRulesetDto createNewInboxRuleset(inboxId, createInboxRulesetOptions)
Create an inbox ruleset
Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.InboxRulesetControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://java.api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
InboxRulesetControllerApi apiInstance = new InboxRulesetControllerApi(defaultClient);
UUID inboxId = new UUID(); // UUID | Inbox id to attach ruleset to
CreateInboxRulesetOptions createInboxRulesetOptions = new CreateInboxRulesetOptions(); // CreateInboxRulesetOptions |
try {
InboxRulesetDto result = apiInstance.createNewInboxRuleset(inboxId, createInboxRulesetOptions);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InboxRulesetControllerApi#createNewInboxRuleset");
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 |
---|---|---|---|
inboxId | UUID | Inbox id to attach ruleset to | |
createInboxRulesetOptions | CreateInboxRulesetOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
deleteInboxRuleset(id)
Delete an inbox ruleset
Delete inbox ruleset
Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.InboxRulesetControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://java.api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
InboxRulesetControllerApi apiInstance = new InboxRulesetControllerApi(defaultClient);
UUID id = new UUID(); // UUID | ID of inbox ruleset
try {
apiInstance.deleteInboxRuleset(id);
} catch (ApiException e) {
System.err.println("Exception when calling InboxRulesetControllerApi#deleteInboxRuleset");
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 | UUID | ID of inbox ruleset |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | No Content | - |
deleteInboxRulesets(inboxId)
Delete inbox rulesets
Delete inbox rulesets. Accepts optional inboxId filter.
Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.InboxRulesetControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://java.api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
InboxRulesetControllerApi apiInstance = new InboxRulesetControllerApi(defaultClient);
UUID inboxId = new UUID(); // UUID | Optional inbox id to attach ruleset to
try {
apiInstance.deleteInboxRulesets(inboxId);
} catch (ApiException e) {
System.err.println("Exception when calling InboxRulesetControllerApi#deleteInboxRulesets");
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 |
---|---|---|---|
inboxId | UUID | Optional inbox id to attach ruleset to | [optional] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | No Content | - |
InboxRulesetDto getInboxRuleset(id)
Get an inbox ruleset
Get inbox ruleset
Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.InboxRulesetControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://java.api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
InboxRulesetControllerApi apiInstance = new InboxRulesetControllerApi(defaultClient);
UUID id = new UUID(); // UUID | ID of inbox ruleset
try {
InboxRulesetDto result = apiInstance.getInboxRuleset(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InboxRulesetControllerApi#getInboxRuleset");
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 | UUID | ID of inbox ruleset |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
PageInboxRulesetDto getInboxRulesets(inboxId, page, size, sort, searchFilter, since, before)
List inbox rulesets
List all rulesets attached to an inbox
Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.InboxRulesetControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://java.api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
InboxRulesetControllerApi apiInstance = new InboxRulesetControllerApi(defaultClient);
UUID inboxId = new UUID(); // UUID | Optional inbox id to get rulesets from
Integer page = 0; // Integer | Optional page in inbox ruleset list pagination
Integer size = 20; // Integer | Optional page size in inbox ruleset list pagination
String sort = "ASC"; // String | Optional createdAt sort direction ASC or DESC
String searchFilter = "searchFilter_example"; // String | Optional search filter
OffsetDateTime since = new OffsetDateTime(); // OffsetDateTime | Filter by created at after the given timestamp
OffsetDateTime before = new OffsetDateTime(); // OffsetDateTime | Filter by created at before the given timestamp
try {
PageInboxRulesetDto result = apiInstance.getInboxRulesets(inboxId, page, size, sort, searchFilter, since, before);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InboxRulesetControllerApi#getInboxRulesets");
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 |
---|---|---|---|
inboxId | UUID | Optional inbox id to get rulesets from | [optional] |
page | Integer | Optional page in inbox ruleset list pagination | [optional] [default to 0] |
size | Integer | Optional page size in inbox ruleset list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
searchFilter | String | Optional search filter | [optional] |
since | OffsetDateTime | Filter by created at after the given timestamp | [optional] |
before | OffsetDateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
InboxRulesetTestResult testInboxRuleset(id, inboxRulesetTestOptions)
Test an inbox ruleset
Test an inbox ruleset
Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.InboxRulesetControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://java.api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
InboxRulesetControllerApi apiInstance = new InboxRulesetControllerApi(defaultClient);
UUID id = new UUID(); // UUID | ID of inbox ruleset
InboxRulesetTestOptions inboxRulesetTestOptions = new InboxRulesetTestOptions(); // InboxRulesetTestOptions |
try {
InboxRulesetTestResult result = apiInstance.testInboxRuleset(id, inboxRulesetTestOptions);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InboxRulesetControllerApi#testInboxRuleset");
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 | UUID | ID of inbox ruleset | |
inboxRulesetTestOptions | InboxRulesetTestOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
InboxRulesetTestResult testInboxRulesetsForInbox(inboxId, inboxRulesetTestOptions)
Test inbox rulesets for inbox
Test inbox rulesets for inbox
Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.InboxRulesetControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://java.api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
InboxRulesetControllerApi apiInstance = new InboxRulesetControllerApi(defaultClient);
UUID inboxId = new UUID(); // UUID | ID of inbox
InboxRulesetTestOptions inboxRulesetTestOptions = new InboxRulesetTestOptions(); // InboxRulesetTestOptions |
try {
InboxRulesetTestResult result = apiInstance.testInboxRulesetsForInbox(inboxId, inboxRulesetTestOptions);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InboxRulesetControllerApi#testInboxRulesetsForInbox");
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 |
---|---|---|---|
inboxId | UUID | ID of inbox | |
inboxRulesetTestOptions | InboxRulesetTestOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
InboxRulesetTestResult testNewInboxRuleset(testNewInboxRulesetOptions)
Test new inbox ruleset
Test new inbox ruleset
Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.InboxRulesetControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://java.api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
InboxRulesetControllerApi apiInstance = new InboxRulesetControllerApi(defaultClient);
TestNewInboxRulesetOptions testNewInboxRulesetOptions = new TestNewInboxRulesetOptions(); // TestNewInboxRulesetOptions |
try {
InboxRulesetTestResult result = apiInstance.testNewInboxRuleset(testNewInboxRulesetOptions);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InboxRulesetControllerApi#testNewInboxRuleset");
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 |
---|---|---|---|
testNewInboxRulesetOptions | TestNewInboxRulesetOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |