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#[serde(rename_all = "camelCase")]
25pub struct GmailForwardingAddressesListResponse {
26    /// Forwarding addresses of the Gmail account.
27    #[serde(default)]
28    pub forwarding_addresses: Vec<GmailForwardingAddress>,
29}
30
31/// I/O-free coroutine listing the forwarding addresses of a Gmail
32/// account (`users.settings.forwardingAddresses.list`).
33pub struct GmailForwardingAddressesList {
34    send: GmailSend<GmailForwardingAddressesListResponse>,
35}
36
37impl GmailForwardingAddressesList {
38    /// Builds the `users.settings.forwardingAddresses.list` request for
39    /// the given user.
40    pub fn new(auth: &HttpAuthBearer, user_id: &str) -> Result<Self, GmailSendError> {
41        debug!("prepare gmail forwarding addresses listing");
42        trace!("user_id: {user_id:?}");
43
44        let url = Url::parse(GMAIL_API_BASE)?
45            .join(&format!("users/{user_id}/settings/forwardingAddresses"))?;
46        let send = GmailSend::get(auth, url);
47
48        Ok(Self { send })
49    }
50}
51
52impl GmailCoroutine for GmailForwardingAddressesList {
53    type Yield = GmailYield;
54    type Return = Result<GmailSendOutput<GmailForwardingAddressesListResponse>, GmailSendError>;
55
56    fn resume(&mut self, arg: Option<&[u8]>) -> GmailCoroutineState<Self::Yield, Self::Return> {
57        let out = gmail_try!(&mut self.send, arg);
58        debug!("forwarding addresses listed");
59        trace!("out: {out:?}");
60        GmailCoroutineState::Complete(Ok(out))
61    }
62}