io-gmail 0.2.1

Google Gmail REST API client library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! List the Gmail threads (`users.threads.list`).
//!
//! <https://developers.google.com/gmail/api/reference/rest/v1/users.threads/list>

use alloc::{format, string::String, vec::Vec};

use io_http::rfc6750::bearer::HttpAuthBearer;
use log::{debug, trace};
use serde::{Deserialize, Serialize};
use url::Url;

use crate::{
    coroutine::*,
    gmail_try,
    v1::{
        query::{is_false, to_query_pairs},
        rest::threads::GmailThreadSummary,
        send::{GMAIL_API_BASE, GmailSend, GmailSendError, GmailSendOutput},
    },
};

/// Query parameters for listing threads (`users.threads.list`).
#[derive(Debug, Clone, Default, Serialize, Eq, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct GmailThreadsListParams<'a> {
    /// Search query filtering threads, using the Gmail search box syntax.
    pub q: Option<&'a str>,
    /// Label ids that returned threads must all carry.
    pub label_ids: &'a [String],
    /// Maximum number of threads to return per page.
    pub max_results: Option<u32>,
    /// Page token from a previous listing response.
    pub page_token: Option<&'a str>,
    /// Whether to include threads from SPAM and TRASH.
    #[serde(skip_serializing_if = "is_false")]
    pub include_spam_trash: bool,
}

/// Gmail REST thread listing response (one page of thread summaries).
#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct GmailThreadsListResponse {
    /// Thread summaries of the current page.
    #[serde(default)]
    pub threads: Vec<GmailThreadSummary>,
    /// Token to fetch the next page, absent on the last page.
    #[serde(default)]
    pub next_page_token: Option<String>,
    /// Estimated total number of results.
    #[serde(default)]
    pub result_size_estimate: Option<u64>,
}

/// Gmail REST thread listing, wrapping a page of thread summaries.
pub struct GmailThreadsList {
    send: GmailSend<GmailThreadsListResponse>,
}

impl GmailThreadsList {
    /// Builds the `users.threads.list` request from the given query
    /// parameters; `user_id` is the mailbox owner (usually `me`).
    pub fn new(
        auth: &HttpAuthBearer,
        user_id: &str,
        params: &GmailThreadsListParams,
    ) -> Result<Self, GmailSendError> {
        debug!("prepare gmail threads listing");
        trace!("params: {params:?}");

        let mut url = Url::parse(GMAIL_API_BASE)?.join(&format!("users/{user_id}/threads"))?;
        url.query_pairs_mut().extend_pairs(to_query_pairs(params));

        let send = GmailSend::get(auth, url);

        Ok(Self { send })
    }
}

impl GmailCoroutine for GmailThreadsList {
    type Yield = GmailYield;
    type Return = Result<GmailSendOutput<GmailThreadsListResponse>, GmailSendError>;

    fn resume(&mut self, arg: Option<&[u8]>) -> GmailCoroutineState<Self::Yield, Self::Return> {
        let out = gmail_try!(&mut self.send, arg);
        debug!("threads listed");
        trace!("out: {out:?}");
        GmailCoroutineState::Complete(Ok(out))
    }
}