Constructor Detail

• MissedEmailControllerApi

  MissedEmailControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• getAllMissedEmails

   final PageMissedEmailProjection getAllMissedEmails(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId)

  Get all MissedEmails in paginated format

  Parameters:

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

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

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

  searchFilter - Optional search filter (optional)

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

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

  inboxId - Optional inbox ID filter (optional)

• getAllMissedEmailsRequestConfig

   final RequestConfig getAllMissedEmailsRequestConfig(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId)

  To obtain the request config of the operation getAllMissedEmails

  Parameters:

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

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

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

  searchFilter - Optional search filter (optional)

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

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

  inboxId - Optional inbox ID filter (optional)

• getAllUnknownMissedEmails

   final PageUnknownMissedEmailProjection getAllUnknownMissedEmails(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId)

  Get all unknown missed emails in paginated format Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox.

  Parameters:

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

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

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

  searchFilter - Optional search filter (optional)

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

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

  inboxId - Optional inbox ID filter (optional)

• getAllUnknownMissedEmailsRequestConfig

   final RequestConfig getAllUnknownMissedEmailsRequestConfig(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, UUID inboxId)

  To obtain the request config of the operation getAllUnknownMissedEmails

  Parameters:

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

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

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

  searchFilter - Optional search filter (optional)

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

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

  inboxId - Optional inbox ID filter (optional)

• getMissedEmail

   final MissedEmail getMissedEmail(UUID missedEmailId)

  Get MissedEmail List emails that were missed due to plan limits.

• getMissedEmailRequestConfig

   final RequestConfig getMissedEmailRequestConfig(UUID missedEmailId)

  To obtain the request config of the operation getMissedEmail

• restoreMissedEmails

   final Unit restoreMissedEmails()

  Restore missed emails If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method.

• restoreMissedEmailsRequestConfig

   final RequestConfig restoreMissedEmailsRequestConfig()

  To obtain the request config of the operation restoreMissedEmails

• waitForNthMissedEmail

   final MissedEmail waitForNthMissedEmail(Integer index, UUID inboxId, Long timeout, OffsetDateTime since, OffsetDateTime before)

  Wait for Nth missed email Wait for 0 based index missed email

  Parameters:

  index - Zero based index of the email to wait for.

  inboxId - Optional inbox ID filter (optional)

  timeout - Optional timeout milliseconds (optional)

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

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

• waitForNthMissedEmailRequestConfig

   final RequestConfig waitForNthMissedEmailRequestConfig(Integer index, UUID inboxId, Long timeout, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation waitForNthMissedEmail

  Parameters:

  index - Zero based index of the email to wait for.

  inboxId - Optional inbox ID filter (optional)

  timeout - Optional timeout milliseconds (optional)

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

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