feat(message): implement message listing functionality

- create `Message` struct to encapsulate Gmail API interaction
- add methods for setting max results, labels, and query parameters
- implement `run` method to retrieve and log message subjects
- use `google_gmail1` crate for Gmail API interaction
- add error handling for API calls
This commit is contained in:
Jeremiah Russell
2025-10-03 22:39:31 +01:00
committed by Jeremiah Russell
parent 227d7b2111
commit 24318768c8

205
src/message.rs Normal file
View File

@@ -0,0 +1,205 @@
use google_gmail1::{
Gmail,
api::ListMessagesResponse,
hyper_rustls::{HttpsConnector, HttpsConnectorBuilder},
hyper_util::{
client::legacy::{Client, connect::HttpConnector},
rt::TokioExecutor,
},
yup_oauth2::{ApplicationSecret, InstalledFlowAuthenticator, InstalledFlowReturnMethod},
};
use crate::{Credential, Error};
/// Default for the maximum number of results to return on a page
pub const DEFAULT_MAX_RESULTS: &str = "10";
/// Struct to capture configuration for List API call.
pub struct Message {
hub: Gmail<HttpsConnector<HttpConnector>>,
max_results: u32,
label_ids: Vec<String>,
query: String,
}
impl Message {
/// Create a new List struct and add the Gmail api connection.
pub async fn new(credential: &str) -> Result<Self, Error> {
let (config_dir, secret) = {
let config_dir = crate::utils::assure_config_dir_exists("~/.cull-gmail")?;
let secret: ApplicationSecret = Credential::load_json_file(credential).into();
(config_dir, secret)
};
let executor = TokioExecutor::new();
let connector = HttpsConnectorBuilder::new()
.with_native_roots()
.unwrap()
.https_or_http()
.enable_http1()
.build();
let client = Client::builder(executor.clone()).build(connector.clone());
let auth = InstalledFlowAuthenticator::with_client(
secret,
InstalledFlowReturnMethod::HTTPRedirect,
Client::builder(executor).build(connector),
)
.persist_tokens_to_disk(format!("{config_dir}/gmail1"))
.build()
.await
.unwrap();
Ok(Message {
hub: Gmail::new(client, auth),
max_results: DEFAULT_MAX_RESULTS.parse::<u32>().unwrap(),
label_ids: Vec::new(),
query: String::new(),
})
}
/// Set the maximum results
pub fn set_max_results(&mut self, value: u32) {
self.max_results = value;
}
/// Report the maximum results value
pub fn max_results(&self) -> u32 {
self.max_results
}
/// Add label to the labels collection
pub fn add_labels(&mut self, label_ids: &[String]) {
if !label_ids.is_empty() {
for id in label_ids {
self.label_ids.push(id.to_string())
}
}
}
/// Set the query string
pub fn set_query(&mut self, query: &str) {
self.query = query.to_string()
}
/// Run the Gmail api as configured
pub async fn run(&self, pages: u32) -> Result<(), Error> {
let log_estimate = |est: &Option<u32>| {
if let Some(estimate) = est {
log::debug!("Estimated {estimate} messages in total.");
} else {
log::debug!("Unknown number of messages found");
}
};
let list = self.get_messages(None).await?;
log_estimate(&list.result_size_estimate);
self.log_message_subjects(&list).await?;
match pages {
1 => {}
0 => {
let mut list = list;
let mut page = 1;
loop {
page += 1;
log::debug!("Processing page #{page}");
log_estimate(&list.result_size_estimate);
if list.next_page_token.is_none() {
break;
}
list = self.get_messages(list.next_page_token).await?;
self.log_message_subjects(&list).await?;
}
}
_ => {
let mut list = list;
for page in 2..=pages {
log::debug!("Processing page #{page}");
log_estimate(&list.result_size_estimate);
if list.next_page_token.is_none() {
break;
}
list = self.get_messages(list.next_page_token).await?;
self.log_message_subjects(&list).await?;
}
}
}
Ok(())
}
async fn get_messages(
&self,
next_page_token: Option<String>,
) -> Result<ListMessagesResponse, Error> {
let mut call = self
.hub
.users()
.messages_list("me")
.max_results(self.max_results);
// Add any labels specified
if !self.label_ids.is_empty() {
log::debug!("Setting labels for list: {:#?}", self.label_ids);
for id in self.label_ids.as_slice() {
call = call.add_label_ids(id);
}
}
// Add query
if !self.query.is_empty() {
log::debug!("Setting query string `{}`", self.query);
call = call.q(&self.query);
}
// Add a page token if it exists
if let Some(page_token) = next_page_token {
log::debug!("Setting token for next page.");
call = call.page_token(&page_token);
}
let (_response, list) = call.doit().await.map_err(Box::new)?;
Ok(list)
}
async fn log_message_subjects(&self, list: &ListMessagesResponse) -> Result<(), Error> {
if let Some(messages) = &list.messages {
for message in messages {
if let Some(id) = &message.id {
log::trace!("{id}");
let (_res, m) = self
.hub
.users()
.messages_get("me", id)
.add_scope("https://www.googleapis.com/auth/gmail.metadata")
.format("metadata")
.add_metadata_headers("subject")
.doit()
.await
.map_err(Box::new)?;
let mut subject = String::new();
if let Some(payload) = m.payload {
if let Some(headers) = payload.headers {
for header in headers {
if header.name.is_some()
&& header.name.unwrap() == "Subject"
&& header.value.is_some()
{
subject = header.value.unwrap();
break;
} else {
continue;
}
}
}
}
log::info!("{subject:?}");
}
}
}
Ok(())
}
}