Package 

Class AliasControllerApi

    • Constructor Detail

      • AliasControllerApi

        AliasControllerApi(String xApiKey, String basePath)

    • Method Detail

      • 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

        Parameters:
        createAliasOptions - createAliasOptions

      • deleteAlias

         final Unit deleteAlias(UUID aliasId)

        Delete an email alias

        Parameters:
        aliasId - aliasId

      • getAlias

         final AliasDto getAlias(UUID aliasId)

        Get an email alias Get an email alias by ID

        Parameters:
        aliasId - aliasId

      • getAliasEmails

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

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

        Parameters:
        aliasId - aliasId
        before - Optional filter by sent before given date time (optional)
        page - Optional page index alias email list pagination (optional, default to 0)
        since - Optional filter by sent after given date time (optional)
        size - Optional page size alias email list pagination (optional, default to 20)
        sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

      • getAliasEmailsRequestConfig

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

        To obtain the request config of the operation getAliasEmails

        Parameters:
        aliasId - aliasId
        before - Optional filter by sent before given date time (optional)
        page - Optional page index alias email list pagination (optional, default to 0)
        since - Optional filter by sent after given date time (optional)
        size - Optional page size alias email list pagination (optional, default to 20)
        sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

      • getAliasThreads

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

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

        Parameters:
        aliasId - aliasId
        before - Optional filter by sent before given date time (optional)
        page - Optional page index in thread list pagination (optional, default to 0)
        since - Optional filter by sent after given date time (optional)
        size - Optional page size in thread list pagination (optional, default to 20)
        sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

      • getAliasThreadsRequestConfig

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

        To obtain the request config of the operation getAliasThreads

        Parameters:
        aliasId - aliasId
        before - Optional filter by sent before given date time (optional)
        page - Optional page index in thread list pagination (optional, default to 0)
        since - Optional filter by sent after given date time (optional)
        size - Optional page size in thread list pagination (optional, default to 20)
        sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

      • getAliases

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

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

        Parameters:
        before - Filter by created at before the given timestamp (optional)
        page - Optional page index in alias list pagination (optional, default to 0)
        since - Filter by created at after the given timestamp (optional)
        size - Optional page size in alias list pagination (optional, default to 20)
        sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

      • getAliasesRequestConfig

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

        To obtain the request config of the operation getAliases

        Parameters:
        before - Filter by created at before the given timestamp (optional)
        page - Optional page index in alias list pagination (optional, default to 0)
        since - Filter by created at after the given timestamp (optional)
        size - Optional page size in alias list pagination (optional, default to 20)
        sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

      • 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
        replyToAliasEmailOptions - replyToAliasEmailOptions

      • 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
        replyToAliasEmailOptions - replyToAliasEmailOptions

      • 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

        Parameters:
        aliasId - aliasId
        sendEmailOptions - Options for the email to be sent (optional)