Wait for or return the first email that matches provided MatchOptions array
Perform a search of emails in an inbox with the given patterns. If a result if found then return or else retry the search until a result is found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the MatchOptions object for options. An example payload is { matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController getEmailContentMatch method.
Request
- Base URL: https://api.mailslurp.com
- URL: https://api.mailslurp.com/waitForMatchingFirstEmail
- Auth: API key in header x-api-key
Query parameters
Id of the inbox we are matching an email for
Max milliseconds to wait
Optional filter for unread only
Filter for emails that were received after the given timestamp
Filter for emails that were received before the given timestamp
Sort direction
Max milliseconds delay between calls
Request body
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.