Constructor Detail

• AliasControllerApi

  AliasControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• createAlias

   final AliasDto createAlias(CreateAliasOptions createAliasOptions)

  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

• createAliasRequestConfig

   final RequestConfig createAliasRequestConfig(CreateAliasOptions createAliasOptions)

  To obtain the request config of the operation createAlias

• deleteAlias

   final Unit deleteAlias(UUID aliasId)

  Delete an email alias

• deleteAliasRequestConfig

   final RequestConfig deleteAliasRequestConfig(UUID aliasId)

  To obtain the request config of the operation deleteAlias

• getAlias

   final AliasDto getAlias(UUID aliasId)

  Get an email alias Get an email alias by ID

• getAliasRequestConfig

   final RequestConfig getAliasRequestConfig(UUID aliasId)

  To obtain the request config of the operation getAlias

• getAliasEmails

   final PageEmailProjection getAliasEmails(UUID aliasId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  Get emails for an alias Get paginated emails for an alias by ID

  Parameters:

  page - Optional page index alias email list pagination (optional, default to 0)

  size - Optional page size alias email list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Optional filter by sent after given date time (optional)

  before - Optional filter by sent before given date time (optional)

• getAliasEmailsRequestConfig

   final RequestConfig getAliasEmailsRequestConfig(UUID aliasId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getAliasEmails

  Parameters:

  page - Optional page index alias email list pagination (optional, default to 0)

  size - Optional page size alias email list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Optional filter by sent after given date time (optional)

  before - Optional filter by sent before given date time (optional)

• getAliasThreads

   final PageThreadProjection getAliasThreads(UUID aliasId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  Get threads created for an alias Returns threads created for an email alias in paginated form

  Parameters:

  page - Optional page index in thread list pagination (optional, default to 0)

  size - Optional page size in thread list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Optional filter by sent after given date time (optional)

  before - Optional filter by sent before given date time (optional)

• getAliasThreadsRequestConfig

   final RequestConfig getAliasThreadsRequestConfig(UUID aliasId, Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getAliasThreads

  Parameters:

  page - Optional page index in thread list pagination (optional, default to 0)

  size - Optional page size in thread list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Optional filter by sent after given date time (optional)

  before - Optional filter by sent before given date time (optional)

• getAliases

   final PageAlias getAliases(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  Get all email aliases you have created Get all email aliases in paginated form

  Parameters:

  page - Optional page index in alias list pagination (optional, default to 0)

  size - Optional page size in alias list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getAliasesRequestConfig

   final RequestConfig getAliasesRequestConfig(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getAliases

  Parameters:

  page - Optional page index in alias list pagination (optional, default to 0)

  size - Optional page size in alias list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• replyToAliasEmail

   final SentEmailDto replyToAliasEmail(UUID aliasId, UUID emailId, ReplyToAliasEmailOptions replyToAliasEmailOptions)

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

  Parameters:

  aliasId - ID of the alias that email belongs to

  emailId - ID of the email that should be replied to

• replyToAliasEmailRequestConfig

   final RequestConfig replyToAliasEmailRequestConfig(UUID aliasId, UUID emailId, ReplyToAliasEmailOptions replyToAliasEmailOptions)

  To obtain the request config of the operation replyToAliasEmail

  Parameters:

  aliasId - ID of the alias that email belongs to

  emailId - ID of the email that should be replied to

• sendAliasEmail

   final SentEmailDto sendAliasEmail(UUID aliasId, SendEmailOptions sendEmailOptions)

  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

• sendAliasEmailRequestConfig

   final RequestConfig sendAliasEmailRequestConfig(UUID aliasId, SendEmailOptions sendEmailOptions)

  To obtain the request config of the operation sendAliasEmail

• updateAlias

   final AliasDto updateAlias(UUID aliasId, UpdateAliasOptions updateAliasOptions)

  Update an email alias

• updateAliasRequestConfig

   final RequestConfig updateAliasRequestConfig(UUID aliasId, UpdateAliasOptions updateAliasOptions)

  To obtain the request config of the operation updateAlias