Skip to main content

io_gmail/v1/rest/messages/
get.rs

1//! Get a Gmail message (`users.messages.get`).
2//!
3//! <https://developers.google.com/gmail/api/reference/rest/v1/users.messages/get>
4
5use alloc::format;
6
7use io_http::rfc6750::bearer::HttpAuthBearer;
8use log::{debug, trace};
9use serde_variant::to_variant_name;
10use url::Url;
11
12use crate::{
13    coroutine::*,
14    gmail_try,
15    v1::rest::messages::{GmailMessage, GmailMessageFormat},
16    v1::send::{GMAIL_API_BASE, GmailSend, GmailSendError, GmailSendOutput},
17};
18
19/// Gmail REST message retrieval, wrapping a `GmailMessage` response.
20pub struct GmailMessageGet {
21    send: GmailSend<GmailMessage>,
22}
23
24impl GmailMessageGet {
25    /// Builds the `users.messages.get` request for the given message id.
26    ///
27    /// `metadata_headers` filters the returned headers, and only
28    /// applies when the format is [`GmailMessageFormat::Metadata`].
29    pub fn new(
30        auth: &HttpAuthBearer,
31        user_id: &str,
32        id: &str,
33        format: GmailMessageFormat,
34        metadata_headers: &[&str],
35    ) -> Result<Self, GmailSendError> {
36        debug!("prepare gmail message retrieval");
37        trace!("id: {id:?}");
38
39        let mut url =
40            Url::parse(GMAIL_API_BASE)?.join(&format!("users/{user_id}/messages/{id}"))?;
41
42        {
43            let mut query = url.query_pairs_mut();
44            query.append_pair("format", to_variant_name(&format).unwrap_or_default());
45
46            if matches!(format, GmailMessageFormat::Metadata) {
47                for header in metadata_headers {
48                    query.append_pair("metadataHeaders", header);
49                }
50            }
51        }
52
53        let send = GmailSend::get(auth, url);
54
55        Ok(Self { send })
56    }
57}
58
59impl GmailCoroutine for GmailMessageGet {
60    type Yield = GmailYield;
61    type Return = Result<GmailSendOutput<GmailMessage>, GmailSendError>;
62
63    fn resume(&mut self, arg: Option<&[u8]>) -> GmailCoroutineState<Self::Yield, Self::Return> {
64        let out = gmail_try!(&mut self.send, arg);
65        debug!("message retrieved");
66        trace!("out: {out:?}");
67        GmailCoroutineState::Complete(Ok(out))
68    }
69}