Struct MessageQueryParams 

pub struct MessageQueryParams {

    pub subject: Option<String>,
    pub from: Option<String>,
    pub to: Option<String>,
    pub cc: Option<String>,
    pub bcc: Option<String>,
    pub any_email: Option<String>,
    pub thread_id: Option<String>,
    pub unread: Option<bool>,
    pub starred: Option<bool>,
    pub has_attachment: Option<bool>,
    pub received_before: Option<i64>,
    pub received_after: Option<i64>,
    pub in_: Option<String>,
    pub limit: Option<u32>,
    pub page_token: Option<String>,
    pub query_imap: Option<String>,
}

Query parameters for listing messages.

Example

let params = MessageQueryParams::builder()
    .subject("invoice")
    .unread(true)
    .limit(50)
    .build();

Fields

subject: Option<String>

Filter by subject (substring match).

from: Option<String>

Filter by sender email.

to: Option<String>

Filter by recipient email (to field).

cc: Option<String>

Filter by CC recipient email.

bcc: Option<String>

Filter by BCC recipient email.

any_email: Option<String>

Filter by any email (to, from, cc, bcc).

thread_id: Option<String>

Filter by thread ID.

unread: Option<bool>

Filter by unread status.

starred: Option<bool>

Filter by starred status.

has_attachment: Option<bool>

Filter by messages with attachments.

received_before: Option<i64>

Filter messages received before this timestamp.

received_after: Option<i64>

Filter messages received after this timestamp.

in_: Option<String>

Filter by folder ID.

limit: Option<u32>

Maximum number of results to return.

page_token: Option<String>

Page token for pagination.

query_imap: Option<String>

IMAP-specific search query.

Uses IMAP SEARCH syntax. Only works with IMAP providers.

Example

use nylas_types::MessageQueryParams;

let params = MessageQueryParams::builder()
    .query_imap("FROM \"sender@example.com\" SUBJECT \"invoice\"")
    .build();

Implementations

impl MessageQueryParams

pub fn builder() -> MessageQueryParamsBuilder

Create a new builder for message query parameters.

Trait Implementations

impl Clone for MessageQueryParams

fn clone(&self) -> MessageQueryParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageQueryParams

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

Formats the value using the given formatter.

impl Default for MessageQueryParams

fn default() -> MessageQueryParams

Returns the “default value” for a type.

impl Eq for MessageQueryParams

impl PartialEq for MessageQueryParams

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MessageQueryParams

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 MessageQueryParams