MailSlurpWaitForControllerApiAll URIs are relative to https://api.mailslurp.comMethodHTTP requestDescriptionWaitForPost /waitForWait for an email to match the provided filter conditions such as subject contains keyword.WaitForEmailCountGet /waitForEmailCountWait for and return count number of emails. Hold connection until inbox count matches expected or timeout occursWaitForLatestEmailGet /waitForLatestEmailFetch inbox’s latest email or if empty wait for an email to arriveWaitForMatchingEmailPost /waitForMatchingEmailsWait or return list of emails that match simple matching patternsWaitForMatchingFirstEmailPost /waitForMatchingFirstEmailWait for or return the first email that matches provided MatchOptions arrayWaitForNthEmailGet /waitForNthEmailWait for or fetch the email with a given in the inbox specified. IF indx doesn’t exist waits for it to exist or timeout to occur.WaitFor[]EmailPreview WaitFor(ctx, optional)Wait for an email to match the provided filter conditions such as subject contains keyword.Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already metRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*WaitForOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a WaitForOpts structNameTypeDescriptionNoteswaitForConditionsoptional.Interface of WaitForConditionsConditions to apply to emails that you are waiting forReturn type**[]EmailPreview**AuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]WaitForEmailCount[]EmailPreview WaitForEmailCount(ctx, optional)Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occursIf inbox contains count or more emails at time of request then return count worth of emails. If not wait until the count is reached and return those or return an error if timeout is exceeded.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*WaitForEmailCountOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a WaitForEmailCountOpts structNameTypeDescriptionNotescountoptional.Int32Number of emails to wait for. Must be greater that 1inboxIdoptional.Interface of stringId of the inbox we are fetching emails fromtimeoutoptional.Int64Max milliseconds to waitunreadOnlyoptional.BoolOptional filter for unread only[default to false]Return type**[]EmailPreview**AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]WaitForLatestEmailEmail WaitForLatestEmail(ctx, optional)Fetch inbox’s latest email or if empty wait for an email to arriveWill return either the last received email or wait for an email to arrive and return that. If you need to wait for an email for a non-empty inbox set unreadOnly=true or see the other receive methods such as waitForNthEmail or waitForEmailCount.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*WaitForLatestEmailOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a WaitForLatestEmailOpts structNameTypeDescriptionNotesinboxIdoptional.Interface of stringId of the inbox we are fetching emails fromtimeoutoptional.Int64Max milliseconds to waitunreadOnlyoptional.BoolOptional filter for unread only.[default to false]Return typeEmailAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]WaitForMatchingEmail[]EmailPreview WaitForMatchingEmail(ctx, matchOptions, optional)Wait or return list of emails that match simple matching patternsPerform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are 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.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.matchOptionsMatchOptionsmatchOptionsoptional*WaitForMatchingEmailOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a WaitForMatchingEmailOpts structNameTypeDescriptionNotescount | optional.Int32| Number of emails to wait for. Must be greater that 1 | inboxId | optional.Interface of string| Id of the inbox we are fetching emails from | timeout | optional.Int64| Max milliseconds to wait | unreadOnly | optional.Bool| Optional filter for unread only | [default to false]Return type**[]EmailPreview**AuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]WaitForMatchingFirstEmailEmail WaitForMatchingFirstEmail(ctx, matchOptions, optional)Wait for or return the first email that matches provided MatchOptions arrayPerform 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.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.matchOptionsMatchOptionsmatchOptionsoptional*WaitForMatchingFirstEmailOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a WaitForMatchingFirstEmailOpts structNameTypeDescriptionNotesinboxId | optional.Interface of string| Id of the inbox we are matching an email for | timeout | optional.Int64| Max milliseconds to wait | unreadOnly | optional.Bool| Optional filter for unread only | [default to false]Return typeEmailAuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]WaitForNthEmailEmail WaitForNthEmail(ctx, optional)Wait for or fetch the email with a given in the inbox specified. IF indx doesn’t exist waits for it to exist or timeout to occur.If nth email is already present in inbox then return it. If not hold the connection open until timeout expires or the nth email is received and returned.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*WaitForNthEmailOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a WaitForNthEmailOpts structNameTypeDescriptionNotesinboxIdoptional.Interface of stringId of the inbox you are fetching emails from****optional.Int32Zero based of the email to wait for. If an inbox has 1 email already and you want to wait for the 2nd email pass =1[default to 0]timeoutoptional.Int64Max milliseconds to wait for the nth email if not already presentunreadOnlyoptional.BoolOptional filter for unread only[default to false]Return typeEmailAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]
MailSlurp