Struct mailslurp::models::wait_for_conditions::WaitForConditions

pub struct WaitForConditions {
    pub count: Option<i32>,
    pub count_type: Option<CountType>,
    pub inbox_id: Option<String>,
    pub matches: Option<Vec<MatchOption>>,
    pub sort_direction: Option<SortDirection>,
    pub timeout: Option<i64>,
    pub unread_only: Option<bool>,
}

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

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.

inbox_id: Option<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.

sort_direction: Option<SortDirection>

Direction to sort matching emails by created time

timeout: Option<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

impl WaitForConditions

pub fn new() -> 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.

Trait Implementations

impl Clone for WaitForConditions

fn clone(&self) -> WaitForConditions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WaitForConditions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WaitForConditions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<WaitForConditions> for WaitForConditions

fn eq(&self, other: &WaitForConditions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WaitForConditions) -> bool

This method tests for !=.

impl Serialize for WaitForConditions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WaitForConditions