io_msgraph/v1/rest/users/messages/
list.rs

1//! List Microsoft Graph messages (`GET /me/messages` or
2//! `GET /me/mailFolders/{id}/messages`).
3//!
4//! <https://learn.microsoft.com/en-us/graph/api/user-list-messages>
5
6use alloc::{format, string::String, vec::Vec};
7
8use io_http::rfc6750::bearer::HttpAuthBearer;
9use log::{debug, trace};
10use serde::{Deserialize, Serialize};
11use url::Url;
12
13use crate::{
14    coroutine::*,
15    msgraph_try,
16    v1::{
17        query::to_query_pairs,
18        rest::users::messages::MsgraphMessage,
19        send::{MSGRAPH_API_BASE, MsgraphSend, MsgraphSendError, MsgraphSendOutput, user_path},
20    },
21};
22
23/// One page of messages (`value` plus the OData paging link).
24#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
25pub struct MsgraphMessagesListResponse {
26    /// The messages of the page.
27    #[serde(default)]
28    pub value: Vec<MsgraphMessage>,
29    /// The URL of the next page, when one exists.
30    #[serde(default, rename = "@odata.nextLink")]
31    pub next_link: Option<String>,
32}
33
34/// OData query parameters for listing messages.
35#[derive(Debug, Clone, Default, Serialize, Eq, PartialEq)]
36pub struct MsgraphMessagesListParams<'a> {
37    /// Maximum number of messages per page (`$top`).
38    #[serde(rename = "$top")]
39    pub top: Option<u32>,
40    /// Number of messages to skip (`$skip`).
41    #[serde(rename = "$skip")]
42    pub skip: Option<u32>,
43    /// Comma-separated properties to return (`$select`).
44    #[serde(rename = "$select")]
45    pub select: Option<&'a str>,
46    /// OData filter expression (`$filter`).
47    #[serde(rename = "$filter")]
48    pub filter: Option<&'a str>,
49    /// Navigation properties to expand (`$expand`), such as
50    /// `singleValueExtendedProperties($filter=id eq 'Integer 0x0E08')`.
51    #[serde(rename = "$expand")]
52    pub expand: Option<&'a str>,
53    /// Comma-separated sort properties (`$orderby`).
54    #[serde(rename = "$orderby")]
55    pub orderby: Option<&'a str>,
56    /// Whether the total count rides along the page (`$count`).
57    #[serde(rename = "$count")]
58    pub count: Option<bool>,
59    /// OData `$search` over the message collection (e.g. `"subject:foo"`
60    /// or a bare term); Graph wraps a bare term as a free-text search.
61    #[serde(rename = "$search")]
62    pub search: Option<&'a str>,
63}
64
65/// Lists the Microsoft Graph messages of a mailbox or mail folder.
66pub struct MsgraphMessagesList {
67    send: MsgraphSend<MsgraphMessagesListResponse>,
68}
69
70impl MsgraphMessagesList {
71    /// Lists messages in the whole mailbox, or in `folder` when given (a
72    /// folder id or a well-known name such as `inbox`).
73    pub fn new(
74        auth: &HttpAuthBearer,
75        user_id: &str,
76        folder: Option<&str>,
77        params: &MsgraphMessagesListParams,
78    ) -> Result<Self, MsgraphSendError> {
79        debug!("prepare microsoft graph messages listing");
80        trace!("folder: {folder:?}");
81        trace!("params: {params:?}");
82
83        let user = user_path(user_id);
84        let path = match folder {
85            Some(folder) => format!("{user}/mailFolders/{folder}/messages"),
86            None => format!("{user}/messages"),
87        };
88        let mut url = Url::parse(MSGRAPH_API_BASE)?.join(&path)?;
89        url.query_pairs_mut().extend_pairs(to_query_pairs(params));
90
91        let send = MsgraphSend::get(auth, url);
92
93        Ok(Self { send })
94    }
95
96    /// Asks Graph for at most `size` items per page
97    /// (`Prefer: odata.maxpagesize={size}`), see
98    /// [`MsgraphSend::max_page_size`]. Graph keeps no memory of it
99    /// across pages: chain it on every page request, the ones built
100    /// from an `@odata.nextLink` included.
101    pub fn max_page_size(mut self, size: u32) -> Self {
102        self.send = self.send.max_page_size(size);
103        self
104    }
105}
106
107impl MsgraphCoroutine for MsgraphMessagesList {
108    type Yield = MsgraphYield;
109    type Return = Result<MsgraphSendOutput<MsgraphMessagesListResponse>, MsgraphSendError>;
110
111    fn resume(&mut self, arg: Option<&[u8]>) -> MsgraphCoroutineState<Self::Yield, Self::Return> {
112        let out = msgraph_try!(&mut self.send, arg);
113        debug!("messages listed");
114        trace!("out: {out:?}");
115        MsgraphCoroutineState::Complete(Ok(out))
116    }
117}
io_msgraph/v1/rest/users/messages/list.rs

io_msgraph/v1/rest/users/messages/
list.rs
