# \AliasControllerApi
All URIs are relative to https://api.mailslurp.com
| Method | HTTP request | Description |
|---|---|---|
| create_alias | Post /aliases | Create an email alias |
| create_anonymous_alias | Post /aliases/anonymous | Create an anonymous email alias |
| delete_alias | Delete /aliases/{aliasId} | Delete an owned alias |
| get_alias | Get /aliases/{aliasId} | Get an email alias |
| get_aliases | Get /aliases | Get all email aliases |
| update_alias | Put /aliases/{aliasId} | Update an owned alias |
# create_alias
create_alias(create_owned_alias_options) 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 | Required | Notes |
|---|---|---|---|---|
| create_owned_alias_options | CreateOwnedAliasOptions | createOwnedAliasOptions | [required] |
# Return type
(empty response body)
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# create_anonymous_alias
crate::models::Alias create_anonymous_alias(create_anonymous_alias_options) Create an anonymous email alias
# Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| create_anonymous_alias_options | CreateAnonymousAliasOptions | createAnonymousAliasOptions | [required] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# delete_alias
delete_alias(alias_id) Delete an owned alias
# Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| alias_id | String | aliasId | [required] |
# Return type
(empty response body)
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# get_alias
crate::models::Alias get_alias(alias_id) Get an email alias
Get an email alias by ID
# Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| alias_id | String | aliasId | [required] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# get_aliases
crate::models::PageAlias get_aliases(page, size, sort) Get all email aliases
Get all email aliases in paginated form
# Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| page | Option<i32> | Optional page index in alias list pagination | [default to 0] | |
| size | Option<i32> | Optional page size in alias list pagination | [default to 20] | |
| sort | Option<String> | Optional createdAt sort direction ASC or DESC | [default to ASC] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# update_alias
update_alias(alias_id, create_owned_alias_options) Update an owned alias
# Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| alias_id | String | aliasId | [required] | |
| create_owned_alias_options | CreateOwnedAliasOptions | createOwnedAliasOptions | [required] |
# Return type
(empty response body)
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
