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

# 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

# createAnonymousAlias

Alias createAnonymousAlias(createAnonymousAliasOptions)

Create an anonymous email alias

# Parameters

Name Type Description Notes
createAnonymousAliasOptions CreateAnonymousAliasOptions createAnonymousAliasOptions

# Return type

Alias

# Authorization

API_KEY

# HTTP request headers

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

# deleteAlias

deleteAlias(aliasId)

Delete an owned alias

# Parameters

Name Type Description Notes
aliasId UUID aliasId [default to null]

# Return type

null (empty response body)

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

# getAlias

Alias getAlias(aliasId)

Get an email alias

Get an email alias by ID

# Parameters

Name Type Description Notes
aliasId UUID aliasId [default to null]

# Return type

Alias

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

# getAliases

PageAlias getAliases(page, size, sort)

Get all email aliases

Get all email aliases in paginated form

# 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

# updateAlias

updateAlias(aliasId, createOwnedAliasOptions)

Update an owned alias

# Parameters

Name Type Description Notes
aliasId UUID aliasId [default to null]
createOwnedAliasOptions CreateOwnedAliasOptions createOwnedAliasOptions

# Return type

null (empty response body)

# Authorization

API_KEY

# HTTP request headers

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