Class WaitForControllerApi

Hierarchy

Constructors

Properties

configuration: Configuration = ...

Methods

  • Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met Wait for an email to match the provided filter conditions such as subject contains keyword.

    Parameters

    • requestParameters: WaitForRequest
    • Optional initOverrides: RequestInit

    Returns Promise<EmailPreview[]>

  • If 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. Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs

    Parameters

    Returns Promise<EmailPreview[]>

  • If 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. Wait for and return count number of emails. Hold connection until inbox count matches expected or timeout occurs

    Parameters

    Returns Promise<ApiResponse<EmailPreview[]>>

  • Will 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. Fetch inbox's latest email or if empty wait for an email to arrive

    Parameters

    Returns Promise<Email>

  • Will 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. Fetch inbox's latest email or if empty wait for an email to arrive

    Parameters

    Returns Promise<ApiResponse<Email>>

  • Wait until a phone number meets given conditions or return immediately if already met Wait for the latest SMS message to match the provided filter conditions such as body contains keyword.

    Parameters

    Returns Promise<SmsDto>

  • Perform 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. Wait or return list of emails that match simple matching patterns

    Parameters

    Returns Promise<EmailPreview[]>

  • Perform 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. Wait or return list of emails that match simple matching patterns

    Parameters

    Returns Promise<ApiResponse<EmailPreview[]>>

  • 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. Wait for or return the first email that matches provided MatchOptions array

    Parameters

    Returns Promise<Email>

  • 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. Wait for or return the first email that matches provided MatchOptions array

    Parameters

    Returns Promise<ApiResponse<Email>>

  • 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. Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur.

    Parameters

    Returns Promise<Email>

  • 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. Wait for or fetch the email with a given index in the inbox specified. If index doesn't exist waits for it to exist or timeout to occur.

    Parameters

    Returns Promise<ApiResponse<Email>>

  • Generic waitFor method that will wait until an inbox meets given conditions or return immediately if already met Wait for an email to match the provided filter conditions such as subject contains keyword.

    Parameters

    • requestParameters: WaitForRequest
    • Optional initOverrides: RequestInit

    Returns Promise<ApiResponse<EmailPreview[]>>

  • Generic waitFor method that will wait until a phone number meets given conditions or return immediately if already met Wait for an SMS message to match the provided filter conditions such as body contains keyword.

    Parameters

    Returns Promise<SmsPreview[]>

  • Generic waitFor method that will wait until a phone number meets given conditions or return immediately if already met Wait for an SMS message to match the provided filter conditions such as body contains keyword.

    Parameters

    Returns Promise<ApiResponse<SmsPreview[]>>