Struct mailslurp::models::wait_for_conditions::WaitForConditions [−][src]
pub struct WaitForConditions {
pub before: Option<String>,
pub count: Option<i32>,
pub count_type: Option<CountType>,
pub delay_timeout: Option<i64>,
pub inbox_id: String,
pub matches: Option<Vec<MatchOption>>,
pub since: Option<String>,
pub sort_direction: Option<SortDirection>,
pub timeout: i64,
pub unread_only: Option<bool>,
}
Expand description
WaitForConditions : Conditions that a waitForXEmails
endpoint operates on. The methods wait until given conditions are met or a timeout is reached. If the conditions are met without needing to wait the results will be returned immediately. Can include unreadOnly
to ignore already read emails that were returned in an API call or viewing in the dashboard. Can also include matches for emails containing from
, subject
, hasAttachments
etc.
Fields
before: Option<String>
ISO Date Time latest time of email to consider. Filter for matching emails that were received before this date
count: Option<i32>
Number of results that should match conditions. Either exactly or at least this amount based on the countType
. If count condition is not met and the timeout has not been reached the waitFor
method will retry the operation.
count_type: Option<CountType>
How should the found count be compared to the expected count.
delay_timeout: Option<i64>
Max time in milliseconds to wait between retries if a timeout
is specified.
inbox_id: String
ID of inbox to search within and apply conditions to. Essentially filtering the emails found to give a count.
matches: Option<Vec<MatchOption>>
Conditions that should be matched for an email to qualify for results. Each condition will be applied in order to each email within an inbox to filter a result list of matching emails you are waiting for.
since: Option<String>
ISO Date Time earliest time of email to consider. Filter for matching emails that were received after this date
sort_direction: Option<SortDirection>
Direction to sort matching emails by created time
timeout: i64
Max time in milliseconds to retry the waitFor
operation until conditions are met.
unread_only: Option<bool>
Apply conditions only to unread emails. All emails begin with read=false
. An email is marked read=true
when an EmailDto
representation of it has been returned to the user at least once. For example you have called getEmail
or waitForLatestEmail
etc., or you have viewed the email in the dashboard.
Implementations
Conditions that a waitForXEmails
endpoint operates on. The methods wait until given conditions are met or a timeout is reached. If the conditions are met without needing to wait the results will be returned immediately. Can include unreadOnly
to ignore already read emails that were returned in an API call or viewing in the dashboard. Can also include matches for emails containing from
, subject
, hasAttachments
etc.
Trait Implementations
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for WaitForConditions
impl Send for WaitForConditions
impl Sync for WaitForConditions
impl Unpin for WaitForConditions
impl UnwindSafe for WaitForConditions
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more