Skip to main content

io_gmail/v1/rest/settings/forwarding_addresses/
list.rs

1//! List the Gmail forwarding addresses
2//! (`users.settings.forwardingAddresses.list`).
3//!
4//! <https://developers.google.com/gmail/api/reference/rest/v1/users.settings.forwardingAddresses/list>
5
6use alloc::{format, 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    gmail_try,
16    v1::{
17        rest::settings::forwarding_addresses::GmailForwardingAddress,
18        send::{GMAIL_API_BASE, GmailSend, GmailSendError, GmailSendOutput},
19    },
20};
21
22/// Response wrapping the forwarding addresses of a Gmail account.
23#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
24#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
25#[serde(rename_all = "camelCase")]
26pub struct GmailForwardingAddressesListResponse {
27    /// Forwarding addresses of the Gmail account.
28    #[serde(default)]
29    pub forwarding_addresses: Vec<GmailForwardingAddress>,
30}
31
32/// I/O-free coroutine listing the forwarding addresses of a Gmail
33/// account (`users.settings.forwardingAddresses.list`).
34pub struct GmailForwardingAddressesList {
35    send: GmailSend<GmailForwardingAddressesListResponse>,
36}
37
38impl GmailForwardingAddressesList {
39    /// Builds the `users.settings.forwardingAddresses.list` request for
40    /// the given user.
41    pub fn new(auth: &HttpAuthBearer, user_id: &str) -> Result<Self, GmailSendError> {
42        debug!("prepare gmail forwarding addresses listing");
43        trace!("user_id: {user_id:?}");
44
45        let url = Url::parse(GMAIL_API_BASE)?
46            .join(&format!("users/{user_id}/settings/forwardingAddresses"))?;
47        let send = GmailSend::get(auth, url);
48
49        Ok(Self { send })
50    }
51}
52
53impl GmailCoroutine for GmailForwardingAddressesList {
54    type Yield = GmailYield;
55    type Return = Result<GmailSendOutput<GmailForwardingAddressesListResponse>, GmailSendError>;
56
57    fn resume(&mut self, arg: Option<&[u8]>) -> GmailCoroutineState<Self::Yield, Self::Return> {
58        let out = gmail_try!(&mut self.send, arg);
59        debug!("forwarding addresses listed");
60        trace!("out: {out:?}");
61        GmailCoroutineState::Complete(Ok(out))
62    }
63}