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(ctx, createOwnedAliasOptions)
Create an email alias
Create an email alias belonging to a user ID. To create anonymous aliases use the createAnonymousAlias method.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createOwnedAliasOptions | CreateOwnedAliasOptions | createOwnedAliasOptions |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Alias CreateAnonymousAlias(ctx, createAnonymousAliasOptions)
Create an anonymous email alias
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createAnonymousAliasOptions | CreateAnonymousAliasOptions | createAnonymousAliasOptions |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteAlias(ctx, aliasId)
Delete an owned alias
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| aliasId | string | aliasId |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Alias GetAlias(ctx, aliasId)
Get an email alias
Get an email alias by ID
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| aliasId | string | aliasId |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PageAlias GetAliases(ctx, optional)
Get all email aliases
Get all email aliases in paginated form
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetAliasesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetAliasesOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| page | optional.Int32 | Optional page index in alias list pagination | [default to 0] |
| size | optional.Int32 | Optional page size in alias list pagination | [default to 20] |
| sort | optional.String | Optional createdAt sort direction ASC or DESC | [default to ASC] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateAlias(ctx, aliasId, createOwnedAliasOptions)
Update an owned alias
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| aliasId | string | aliasId | |
| createOwnedAliasOptions | CreateOwnedAliasOptions | createOwnedAliasOptions |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]