# mailslurp_client.AliasControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
create_alias | POST /aliases | Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active. |
delete_alias | DELETE /aliases/{aliasId} | Delete an email alias |
get_alias | GET /aliases/{aliasId} | Get an email alias |
get_alias_emails | GET /aliases/{aliasId}/emails | Get emails for an alias |
get_alias_threads | GET /aliases/{aliasId}/threads | Get threads created for an alias |
get_aliases | GET /aliases | Get all email aliases you have created |
reply_to_alias_email | PUT /aliases/{aliasId}/emails/{emailId} | Reply to an email |
send_alias_email | POST /aliases/{aliasId}/emails | Send an email from an alias inbox |
update_alias | PUT /aliases/{aliasId} | Update an email alias |
# create_alias
AliasDto create_alias(create_alias_options)
Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
Email aliases use a MailSlurp randomly generated email address (or a custom domain inbox that you provide) to mask or proxy a real email address. Emails sent to the alias address will be forwarded to the hidden email address it was created for. If you want to send a reply use the threadId attached
# Example
- Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com",
api_key = {
'x-api-key': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mailslurp_client.AliasControllerApi(api_client)
create_alias_options = mailslurp_client.CreateAliasOptions() # CreateAliasOptions | createAliasOptions
try:
# Create an email alias. Must be verified by clicking link inside verification email that will be sent to the address. Once verified the alias will be active.
api_response = api_instance.create_alias(create_alias_options)
pprint(api_response)
except ApiException as e:
print("Exception when calling AliasControllerApi->create_alias: %s\n" % e)
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
create_alias_options | CreateAliasOptions | createAliasOptions |
# Return type
# Authorization
# 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 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# delete_alias
delete_alias(alias_id)
Delete an email alias
# Example
- Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com",
api_key = {
'x-api-key': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mailslurp_client.AliasControllerApi(api_client)
alias_id = 'alias_id_example' # str | aliasId
try:
# Delete an email alias
api_instance.delete_alias(alias_id)
except ApiException as e:
print("Exception when calling AliasControllerApi->delete_alias: %s\n" % e)
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
alias_id | str | aliasId |
# Return type
void (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 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# get_alias
AliasDto get_alias(alias_id)
Get an email alias
Get an email alias by ID
# Example
- Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com",
api_key = {
'x-api-key': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mailslurp_client.AliasControllerApi(api_client)
alias_id = 'alias_id_example' # str | aliasId
try:
# Get an email alias
api_response = api_instance.get_alias(alias_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling AliasControllerApi->get_alias: %s\n" % e)
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
alias_id | str | aliasId |
# Return type
# Authorization
# 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 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# get_alias_emails
PageEmailProjection get_alias_emails(alias_id, page=page, size=size, sort=sort)
Get emails for an alias
Get paginated emails for an alias by ID
# Example
- Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com",
api_key = {
'x-api-key': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mailslurp_client.AliasControllerApi(api_client)
alias_id = 'alias_id_example' # str | aliasId
page = 0 # int | Optional page index alias email list pagination (optional) (default to 0)
size = 20 # int | Optional page size alias email list pagination (optional) (default to 20)
sort = 'ASC' # str | Optional createdAt sort direction ASC or DESC (optional) (default to 'ASC')
try:
# Get emails for an alias
api_response = api_instance.get_alias_emails(alias_id, page=page, size=size, sort=sort)
pprint(api_response)
except ApiException as e:
print("Exception when calling AliasControllerApi->get_alias_emails: %s\n" % e)
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
alias_id | str | aliasId | |
page | int | Optional page index alias email list pagination | [optional] [default to 0] |
size | int | Optional page size alias email list pagination | [optional] [default to 20] |
sort | str | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
# Return type
# Authorization
# 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 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# get_alias_threads
PageThreadProjection get_alias_threads(alias_id, page=page, size=size, sort=sort)
Get threads created for an alias
Returns threads created for an email alias in paginated form
# Example
- Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com",
api_key = {
'x-api-key': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mailslurp_client.AliasControllerApi(api_client)
alias_id = 'alias_id_example' # str | aliasId
page = 0 # int | Optional page index in thread list pagination (optional) (default to 0)
size = 20 # int | Optional page size in thread list pagination (optional) (default to 20)
sort = 'ASC' # str | Optional createdAt sort direction ASC or DESC (optional) (default to 'ASC')
try:
# Get threads created for an alias
api_response = api_instance.get_alias_threads(alias_id, page=page, size=size, sort=sort)
pprint(api_response)
except ApiException as e:
print("Exception when calling AliasControllerApi->get_alias_threads: %s\n" % e)
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
alias_id | str | aliasId | |
page | int | Optional page index in thread list pagination | [optional] [default to 0] |
size | int | Optional page size in thread list pagination | [optional] [default to 20] |
sort | str | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
# Return type
# Authorization
# 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 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# get_aliases
PageAlias get_aliases(page=page, size=size, sort=sort)
Get all email aliases you have created
Get all email aliases in paginated form
# Example
- Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com",
api_key = {
'x-api-key': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mailslurp_client.AliasControllerApi(api_client)
page = 0 # int | Optional page index in alias list pagination (optional) (default to 0)
size = 20 # int | Optional page size in alias list pagination (optional) (default to 20)
sort = 'ASC' # str | Optional createdAt sort direction ASC or DESC (optional) (default to 'ASC')
try:
# Get all email aliases you have created
api_response = api_instance.get_aliases(page=page, size=size, sort=sort)
pprint(api_response)
except ApiException as e:
print("Exception when calling AliasControllerApi->get_aliases: %s\n" % e)
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | int | Optional page index in alias list pagination | [optional] [default to 0] |
size | int | Optional page size in alias list pagination | [optional] [default to 20] |
sort | str | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
# Return type
# Authorization
# 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 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# reply_to_alias_email
SentEmailDto reply_to_alias_email(alias_id, email_id, reply_to_alias_email_options)
Reply to an email
Send the reply to the email sender or reply-to and include same subject cc bcc etc. Reply to an email and the contents will be sent with the existing subject to the emails to
, cc
, and bcc
.
# Example
- Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com",
api_key = {
'x-api-key': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mailslurp_client.AliasControllerApi(api_client)
alias_id = 'alias_id_example' # str | ID of the alias that email belongs to
email_id = 'email_id_example' # str | ID of the email that should be replied to
reply_to_alias_email_options = mailslurp_client.ReplyToAliasEmailOptions() # ReplyToAliasEmailOptions | replyToAliasEmailOptions
try:
# Reply to an email
api_response = api_instance.reply_to_alias_email(alias_id, email_id, reply_to_alias_email_options)
pprint(api_response)
except ApiException as e:
print("Exception when calling AliasControllerApi->reply_to_alias_email: %s\n" % e)
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
alias_id | str | ID of the alias that email belongs to | |
email_id | str | ID of the email that should be replied to | |
reply_to_alias_email_options | ReplyToAliasEmailOptions | replyToAliasEmailOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# send_alias_email
SentEmailDto send_alias_email(alias_id, send_email_options=send_email_options)
Send an email from an alias inbox
Send an email from an alias. Replies to the email will be forwarded to the alias masked email address
# Example
- Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com",
api_key = {
'x-api-key': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mailslurp_client.AliasControllerApi(api_client)
alias_id = 'alias_id_example' # str | aliasId
send_email_options = mailslurp_client.SendEmailOptions() # SendEmailOptions | Options for the email to be sent (optional)
try:
# Send an email from an alias inbox
api_response = api_instance.send_alias_email(alias_id, send_email_options=send_email_options)
pprint(api_response)
except ApiException as e:
print("Exception when calling AliasControllerApi->send_alias_email: %s\n" % e)
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
alias_id | str | aliasId | |
send_email_options | SendEmailOptions | Options for the email to be sent | [optional] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
201 | Created | - |
401 | Unauthorized | - |
403 | Forbidden | - |
404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# update_alias
update_alias(alias_id, update_alias_options)
Update an email alias
# Example
- Api Key Authentication (API_KEY):
from __future__ import print_function
import time
import mailslurp_client
from mailslurp_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.mailslurp.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: API_KEY
configuration = mailslurp_client.Configuration(
host = "https://api.mailslurp.com",
api_key = {
'x-api-key': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'
# Enter a context with an instance of the API client
with mailslurp_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = mailslurp_client.AliasControllerApi(api_client)
alias_id = 'alias_id_example' # str | aliasId
update_alias_options = mailslurp_client.UpdateAliasOptions() # UpdateAliasOptions | updateAliasOptions
try:
# Update an email alias
api_instance.update_alias(alias_id, update_alias_options)
except ApiException as e:
print("Exception when calling AliasControllerApi->update_alias: %s\n" % e)
# Parameters
Name | Type | Description | Notes |
---|---|---|---|
alias_id | str | aliasId | |
update_alias_options | UpdateAliasOptions | updateAliasOptions |
# Return type
void (empty response body)
# Authorization
# 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 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]