# CommonActionsControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
createNewEmailAddress | POST /createInbox | Create new random inbox |
createNewEmailAddress1 | POST /newEmailAddress | Create new random inbox |
emptyInbox | DELETE /emptyInbox | Delete all emails in an inbox |
sendEmailSimple | POST /sendEmail | Send an email |
# createNewEmailAddress
Inbox createNewEmailAddress(expiresAt, expiresIn, useDomainPool)
Create new random inbox
Returns an Inbox with an `id` and an `emailAddress`
# 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.CommonActionsControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://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");
CommonActionsControllerApi apiInstance = new CommonActionsControllerApi(defaultClient);
OffsetDateTime expiresAt = new OffsetDateTime(); // OffsetDateTime | expiresAt
Long expiresIn = 56L; // Long | expiresIn
Boolean useDomainPool = true; // Boolean | useDomainPool
try {
Inbox result = apiInstance.createNewEmailAddress(expiresAt, expiresIn, useDomainPool);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CommonActionsControllerApi#createNewEmailAddress");
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 |
---|---|---|---|
expiresAt | OffsetDateTime | expiresAt | [optional] |
expiresIn | Long | expiresIn | [optional] |
useDomainPool | Boolean | useDomainPool | [optional] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
# createNewEmailAddress1
Inbox createNewEmailAddress1(expiresAt, expiresIn, useDomainPool)
Create new random inbox
Returns an Inbox with an `id` and an `emailAddress`
# 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.CommonActionsControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://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");
CommonActionsControllerApi apiInstance = new CommonActionsControllerApi(defaultClient);
OffsetDateTime expiresAt = new OffsetDateTime(); // OffsetDateTime | expiresAt
Long expiresIn = 56L; // Long | expiresIn
Boolean useDomainPool = true; // Boolean | useDomainPool
try {
Inbox result = apiInstance.createNewEmailAddress1(expiresAt, expiresIn, useDomainPool);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CommonActionsControllerApi#createNewEmailAddress1");
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 |
---|---|---|---|
expiresAt | OffsetDateTime | expiresAt | [optional] |
expiresIn | Long | expiresIn | [optional] |
useDomainPool | Boolean | useDomainPool | [optional] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
# emptyInbox
emptyInbox(inboxId)
Delete all emails in an inbox
Deletes all emails
# 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.CommonActionsControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://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");
CommonActionsControllerApi apiInstance = new CommonActionsControllerApi(defaultClient);
UUID inboxId = new UUID(); // UUID | inboxId
try {
apiInstance.emptyInbox(inboxId);
} catch (ApiException e) {
System.err.println("Exception when calling CommonActionsControllerApi#emptyInbox");
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 | inboxId |
# 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 | - |
401 | Unauthorized | - |
403 | Forbidden | - |
# sendEmailSimple
sendEmailSimple(emailOptions)
Send an email
If no senderId or inboxId provided a random email address will be used to send from.
# 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.CommonActionsControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://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");
CommonActionsControllerApi apiInstance = new CommonActionsControllerApi(defaultClient);
SimpleSendEmailOptions emailOptions = new SimpleSendEmailOptions(); // SimpleSendEmailOptions | emailOptions
try {
apiInstance.sendEmailSimple(emailOptions);
} catch (ApiException e) {
System.err.println("Exception when calling CommonActionsControllerApi#sendEmailSimple");
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 |
---|---|---|---|
emailOptions | SimpleSendEmailOptions | emailOptions |
# Return type
null (empty response body)
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: Not defined
# HTTP response details
Status code | Description | Response headers |
---|---|---|
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |