Class InboxControllerApi

Hierarchy

Constructors

Properties

Methods

cancelScheduledJob cancelScheduledJobRaw createInbox createInboxRaw createInboxRuleset createInboxRulesetRaw createInboxWithDefaults createInboxWithDefaultsRaw createInboxWithOptions createInboxWithOptionsRaw deleteAllInboxEmails deleteAllInboxEmailsRaw deleteAllInboxes deleteAllInboxesByDescription deleteAllInboxesByDescriptionRaw deleteAllInboxesByName deleteAllInboxesByNameRaw deleteAllInboxesByTag deleteAllInboxesByTagRaw deleteAllInboxesRaw deleteInbox deleteInboxRaw doesInboxExist doesInboxExistRaw flushExpired flushExpiredRaw getAllInboxes getAllInboxesOffsetPaginated getAllInboxesOffsetPaginatedRaw getAllInboxesRaw getAllScheduledJobs getAllScheduledJobsRaw getDeliveryStatusesByInboxId getDeliveryStatusesByInboxIdRaw getEmails getEmailsRaw getImapAccess getImapAccessRaw getImapSmtpAccess getImapSmtpAccessEnv getImapSmtpAccessEnvRaw getImapSmtpAccessRaw getImapSmtpAccessServers getImapSmtpAccessServersRaw getInbox getInboxByEmailAddress getInboxByEmailAddressRaw getInboxByName getInboxByNameRaw getInboxCount getInboxCountRaw getInboxEmailCount getInboxEmailCountRaw getInboxEmailsPaginated getInboxEmailsPaginatedRaw getInboxIds getInboxIdsRaw getInboxRaw getInboxSentEmails getInboxSentEmailsRaw getInboxTags getInboxTagsRaw getInboxes getInboxesRaw getLatestEmailInInbox getLatestEmailInInboxRaw getOrganizationInboxes getOrganizationInboxesRaw getScheduledJob getScheduledJobRaw getScheduledJobsByInboxId getScheduledJobsByInboxIdRaw getSmtpAccess getSmtpAccessRaw listInboxRulesets listInboxRulesetsRaw listInboxTrackingPixels listInboxTrackingPixelsRaw request searchInboxes searchInboxesRaw sendEmail sendEmailAndConfirm sendEmailAndConfirmRaw sendEmailRaw sendEmailWithQueue sendEmailWithQueueRaw sendSmtpEnvelope sendSmtpEnvelopeRaw sendTestEmail sendTestEmailRaw sendWithSchedule sendWithScheduleRaw setInboxFavourited setInboxFavouritedRaw updateInbox updateInboxRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

Properties

configuration: Configuration = ...

Methods

  • Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either SMTP or HTTP inboxes.

    Parameters

    Returns Promise<InboxDto>

  • Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either SMTP or HTTP inboxes.

    Parameters

    Returns Promise<ApiResponse<InboxDto>>

  • Create an inbox with default options. Uses MailSlurp domain pool address and is private.

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<InboxDto>

  • Create an inbox with default options. Uses MailSlurp domain pool address and is private.

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<ApiResponse<InboxDto>>

  • Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients. Create an inbox with options. Extended options for inbox creation.

    Parameters

    Returns Promise<InboxDto>

  • Deletes all emails in an inbox. Be careful as emails cannot be recovered Delete all emails in a given inboxes.

    Parameters

    Returns Promise<void>

  • Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. Delete all inboxes

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<void>

  • Permanently delete all inboxes and associated email addresses. This will also delete all emails within the inboxes. Be careful as inboxes cannot be recovered once deleted. Note: deleting inboxes will not impact your usage limits. Monthly inbox creation limits are based on how many inboxes were created in the last 30 days, not how many inboxes you currently have. Delete all inboxes

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<ApiResponse<void>>

  • Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. Delete inbox

    Parameters

    Returns Promise<void>

  • Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request. Delete inbox

    Parameters

    Returns Promise<ApiResponse<void>>

  • List inboxes in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results. List All Inboxes Paginated

    Parameters

    Returns Promise<PageInboxProjection>

  • List inboxes in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results. List All Inboxes Offset Paginated

    Parameters

    Returns Promise<PageInboxProjection>

  • List inboxes in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results. List All Inboxes Offset Paginated

    Parameters

    Returns Promise<ApiResponse<PageInboxProjection>>

  • List inboxes in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results. List All Inboxes Paginated

    Parameters

    Returns Promise<ApiResponse<PageInboxProjection>>

  • List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the minCount parameter. The server will retry the inbox database until the minCount is satisfied or the retryTimeout is reached Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.

    Parameters

    Returns Promise<EmailPreview[]>

  • List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the minCount parameter. The server will retry the inbox database until the minCount is satisfied or the retryTimeout is reached Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.

    Parameters

    Returns Promise<ApiResponse<EmailPreview[]>>

  • Returns an inbox's properties, including its email address and ID. Get Inbox. Returns properties of an inbox.

    Parameters

    Returns Promise<InboxDto>

  • Get total inbox count

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<CountDto>

  • Get all inbox tags Get inbox tags

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<string[]>

  • Get all inbox tags Get inbox tags

    Parameters

    • Optional initOverrides: RequestInit

    Returns Promise<ApiResponse<string[]>>

  • List the inboxes you have created. Note use of the more advanced getAllInboxes is recommended and allows paginated access using a limit and sort parameter. List Inboxes and email addresses

    Parameters

    Returns Promise<InboxDto[]>

  • List organization inboxes in paginated form. These are inboxes created with allowTeamAccess flag enabled. Organization inboxes are readOnly for non-admin users. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). List Organization Inboxes Paginated

    Parameters

    Returns Promise<PageOrganizationInboxProjection>

  • Search inboxes and return in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results. Search all inboxes and return matching inboxes

    Parameters

    Returns Promise<PageInboxProjection>

  • Search inboxes and return in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results. Search all inboxes and return matching inboxes

    Parameters

    Returns Promise<ApiResponse<PageInboxProjection>>

  • Send an email from an inbox's email address. The request body should contain the SendEmailOptions that include recipients, attachments, body etc. See SendEmailOptions for all available properties. Note the inboxId refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method sendEmailAndConfirm. Send Email

    Parameters

    Returns Promise<void>

  • Sister method for standard sendEmail method with the benefit of returning a SentEmail entity confirming the successful sending of the email with a link to the sent object created for it. Send email and return sent confirmation

    Parameters

    Returns Promise<SentEmailDto>

  • Send an email from an inbox's email address. The request body should contain the SendEmailOptions that include recipients, attachments, body etc. See SendEmailOptions for all available properties. Note the inboxId refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method sendEmailAndConfirm. Send Email

    Parameters

    Returns Promise<ApiResponse<void>>

  • Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. Send email with queue

    Parameters

    Returns Promise<void>

  • Send an email using a queue. Will place the email onto a queue that will then be processed and sent. Use this queue method to enable any failed email sending to be recovered. This will prevent lost emails when sending if your account encounters a block or payment issue. Send email with queue

    Parameters

    Returns Promise<ApiResponse<void>>

  • Send an inbox a test email to test email receiving is working Send a test email to inbox

    Parameters

    Returns Promise<void>