# AliasControllerApi

All URIs are relative to https://api.mailslurp.com

Method	HTTP request	Description
createAlias	POST /aliases	Create an email alias
createAnonymousAlias	POST /aliases/anonymous	Create an anonymous email alias
deleteAlias	DELETE /aliases/{aliasId}	Delete an owned alias
getAlias	GET /aliases/{aliasId}	Get an email alias
getAliases	GET /aliases	Get all email aliases
updateAlias	PUT /aliases/{aliasId}	Update an owned alias

# createAlias

createAlias(createOwnedAliasOptions)

Create an email alias

Create an email alias belonging to a user ID. To create anonymous aliases use the `createAnonymousAlias` method.

# 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.AliasControllerApi;
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");
    AliasControllerApi apiInstance = new AliasControllerApi(defaultClient);
    CreateOwnedAliasOptions createOwnedAliasOptions = new CreateOwnedAliasOptions(); // CreateOwnedAliasOptions | createOwnedAliasOptions
    try {
      apiInstance.createAlias(createOwnedAliasOptions);
    } catch (ApiException e) {
      System.err.println("Exception when calling AliasControllerApi#createAlias");
      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
createOwnedAliasOptions	CreateOwnedAliasOptions	createOwnedAliasOptions

# Return type

null (empty response body)

# Authorization

API_KEY

# HTTP request headers

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

# HTTP response details

Status code	Description	Response headers
201	Created	-
202	Accepted	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

# createAnonymousAlias

Alias createAnonymousAlias(createAnonymousAliasOptions)

Create an anonymous email alias

# 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.AliasControllerApi;
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");
    AliasControllerApi apiInstance = new AliasControllerApi(defaultClient);
    CreateAnonymousAliasOptions createAnonymousAliasOptions = new CreateAnonymousAliasOptions(); // CreateAnonymousAliasOptions | createAnonymousAliasOptions
    try {
      Alias result = apiInstance.createAnonymousAlias(createAnonymousAliasOptions);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AliasControllerApi#createAnonymousAlias");
      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
createAnonymousAliasOptions	CreateAnonymousAliasOptions	createAnonymousAliasOptions

# Return type

Alias

# Authorization

API_KEY

# HTTP request headers

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

# HTTP response details

Status code	Description	Response headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

# deleteAlias

deleteAlias(aliasId)

Delete an owned alias

# 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.AliasControllerApi;
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");
    AliasControllerApi apiInstance = new AliasControllerApi(defaultClient);
    UUID aliasId = new UUID(); // UUID | aliasId
    try {
      apiInstance.deleteAlias(aliasId);
    } catch (ApiException e) {
      System.err.println("Exception when calling AliasControllerApi#deleteAlias");
      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
aliasId	UUID	aliasId

# Return type

null (empty response body)

# Authorization

API_KEY

# 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	-

# getAlias

Alias getAlias(aliasId)

Get an email alias

Get an email alias by ID

# 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.AliasControllerApi;
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");
    AliasControllerApi apiInstance = new AliasControllerApi(defaultClient);
    UUID aliasId = new UUID(); // UUID | aliasId
    try {
      Alias result = apiInstance.getAlias(aliasId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AliasControllerApi#getAlias");
      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
aliasId	UUID	aliasId

# Return type

Alias

# Authorization

API_KEY

# HTTP request headers

Content-Type: Not defined
Accept: application/json

# HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

# getAliases

PageAlias getAliases(page, size, sort)

Get all email aliases

Get all email aliases in paginated form

# 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.AliasControllerApi;
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");
    AliasControllerApi apiInstance = new AliasControllerApi(defaultClient);
    Integer page = 0; // Integer | Optional page index in alias list pagination
    Integer size = 20; // Integer | Optional page size in alias list pagination
    String sort = "ASC"; // String | Optional createdAt sort direction ASC or DESC
    try {
      PageAlias result = apiInstance.getAliases(page, size, sort);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AliasControllerApi#getAliases");
      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
page	Integer	Optional page index in alias list pagination	[optional] [default to 0]
size	Integer	Optional page size in alias list pagination	[optional] [default to 20]
sort	String	Optional createdAt sort direction ASC or DESC	[optional] [default to ASC] [enum: ASC, DESC]

# Return type

PageAlias

# Authorization

API_KEY

# HTTP request headers

Content-Type: Not defined
Accept: application/json

# HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

# updateAlias

updateAlias(aliasId, createOwnedAliasOptions)

Update an owned alias

# 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.AliasControllerApi;
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");
    AliasControllerApi apiInstance = new AliasControllerApi(defaultClient);
    UUID aliasId = new UUID(); // UUID | aliasId
    CreateOwnedAliasOptions createOwnedAliasOptions = new CreateOwnedAliasOptions(); // CreateOwnedAliasOptions | createOwnedAliasOptions
    try {
      apiInstance.updateAlias(aliasId, createOwnedAliasOptions);
    } catch (ApiException e) {
      System.err.println("Exception when calling AliasControllerApi#updateAlias");
      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
aliasId	UUID	aliasId
createOwnedAliasOptions	CreateOwnedAliasOptions	createOwnedAliasOptions

# Return type

null (empty response body)

# Authorization

API_KEY

# HTTP request headers

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

# HTTP response details

Status code	Description	Response headers
201	Created	-
202	Accepted	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

# AliasControllerApi

# createAlias

# Example

# Parameters

# Return type

# Authorization

# HTTP request headers

# HTTP response details

# createAnonymousAlias

# Example

# Parameters

# Return type

# Authorization

# HTTP request headers

# HTTP response details

# deleteAlias

# Example

# Parameters

# Return type

# Authorization

# HTTP request headers

# HTTP response details

# getAlias

# Example

# Parameters

# Return type

# Authorization

# HTTP request headers

# HTTP response details

# getAliases

# Example

# Parameters

# Return type

# Authorization

# HTTP request headers

# HTTP response details

# updateAlias

# Example

# Parameters

# Return type

# Authorization

# HTTP request headers

# HTTP response details

Modern email APIs. Free for personal use.

About

Developers

Docs

Social