Module mailslurp::apis::alias_controller_api[][src]

Structs

CreateAliasParams

struct for passing parameters to the method create_alias

DeleteAliasParams

struct for passing parameters to the method delete_alias

GetAliasEmailsParams

struct for passing parameters to the method get_alias_emails

GetAliasParams

struct for passing parameters to the method get_alias

GetAliasThreadsParams

struct for passing parameters to the method get_alias_threads

GetAliasesParams

struct for passing parameters to the method get_aliases

ReplyToAliasEmailParams

struct for passing parameters to the method reply_to_alias_email

SendAliasEmailParams

struct for passing parameters to the method send_alias_email

UpdateAliasParams

struct for passing parameters to the method update_alias

Enums

CreateAliasError

struct for typed errors of method create_alias

DeleteAliasError

struct for typed errors of method delete_alias

GetAliasEmailsError

struct for typed errors of method get_alias_emails

GetAliasError

struct for typed errors of method get_alias

GetAliasThreadsError

struct for typed errors of method get_alias_threads

GetAliasesError

struct for typed errors of method get_aliases

ReplyToAliasEmailError

struct for typed errors of method reply_to_alias_email

SendAliasEmailError

struct for typed errors of method send_alias_email

UpdateAliasError

struct for typed errors of method update_alias

Functions

create_alias

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

delete_alias
get_alias

Get an email alias by ID

get_alias_emails

Get paginated emails for an alias by ID

get_alias_threads

Returns threads created for an email alias in paginated form

get_aliases

Get all email aliases in paginated form

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

send_alias_email

Send an email from an alias. Replies to the email will be forwarded to the alias masked email address

update_alias