\MissedEmailControllerApi
All URIs are relative to https://api.mailslurp.com
| Method | HTTP request | Description |
|---|---|---|
| get_all_missed_emails | get /missed-emails | Get all MissedEmails in paginated format |
| get_all_unknown_missed_emails | get /missed-emails/unknown | Get all unknown missed emails in paginated format |
| get_missed_email | get /missed-emails/{missedEmailId} | Get MissedEmail |
| restore_missed_emails | post /missed-emails/restore | Restore missed emails |
| wait_for_nth_missed_email | get /missed-emails/waitForNthMissedEmail | Wait for Nth missed email |
get_all_missed_emails
crate::models::PageMissedEmailProjection get_all_missed_emails(page, size, sort, search_filter, since, before, inbox_id) Get all MissedEmails in paginated format
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| page | Option<i32> | Optional page in list pagination | [default to 0] | |
| size | Option<i32> | Optional page size in list pagination | [default to 20] | |
| sort | Option<String> | Optional createdAt sort direction ASC or DESC | [default to ASC] | |
| search_filter | Option<String> | Optional search filter | ||
| since | Option<String> | Filter by created at after the given timestamp | ||
| before | Option<String> | Filter by created at before the given timestamp | ||
| inbox_id | Option<String> | Optional inbox ID filter |
Return type
crate::models::PageMissedEmailProjection
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
get_all_unknown_missed_emails
crate::models::PageUnknownMissedEmailProjection get_all_unknown_missed_emails(page, size, sort, search_filter, since, before, inbox_id) 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
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| page | Option<i32> | Optional page in list pagination | [default to 0] | |
| size | Option<i32> | Optional page size in list pagination | [default to 20] | |
| sort | Option<String> | Optional createdAt sort direction ASC or DESC | [default to ASC] | |
| search_filter | Option<String> | Optional search filter | ||
| since | Option<String> | Filter by created at after the given timestamp | ||
| before | Option<String> | Filter by created at before the given timestamp | ||
| inbox_id | Option<String> | Optional inbox ID filter |
Return type
crate::models::PageUnknownMissedEmailProjection
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
get_missed_email
crate::models::MissedEmailDto get_missed_email(missed_email_id) Get MissedEmail
List emails that were missed due to plan limits.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| missed_email_id | String | [required] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
restore_missed_emails
restore_missed_emails() 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.
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
wait_for_nth_missed_email
crate::models::MissedEmailDto wait_for_nth_missed_email(, inbox_id, timeout, since, before) Wait for Nth missed email
Wait for 0 based missed email
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| **** | i32 | Zero based of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass =1 | [required] | |
| inbox_id | Option<String> | Optional inbox ID filter | ||
| timeout | Option<i64> | Optional timeout milliseconds | ||
| since | Option<String> | Filter by created at after the given timestamp | ||
| before | Option<String> | Filter by created at before the given timestamp |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]