-
Notifications
You must be signed in to change notification settings - Fork 975
feat(gmail): add +read helper for clean text extraction #502
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dumko2001
wants to merge
12
commits into
googleworkspace:main
Choose a base branch
from
dumko2001:feature/issue-438-gmail-read
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+177
−1
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
fdd0429
feat: add gmail +read helper to extract plain text body (#438)
dumko2001 5398937
feat(gmail): improve +read helper with headers and JSON support (#438)
dumko2001 bb1a5db
feat(gmail): add +read helper for clean text extraction
dumko2001 6f8701f
chore: restore ratatui version to 0.30.0 and fix unused import
dumko2001 4db0c7b
feat(gmail): remove redundant --body-only flag and improve HTML fallb…
dumko2001 554e7a8
refactor: use hybrid check for gmail draft-only mode (ID + path fallb…
dumko2001 3afc9b3
feat(gmail): use writeln! for robust I/O handling in +read
dumko2001 0e3e439
feat(gmail): refine HTML fallback to handle whitespace-only bodies
dumko2001 470a8d7
feat(gmail): cleanup branch and focus strictly on +read helper
dumko2001 18033fb
security(gmail): sanitize terminal output to prevent injection attacks
dumko2001 a687653
refactor(gmail): use anyhow::Context for cleaner error handling in +read
dumko2001 7932abf
security(gmail): strip newlines from headers to prevent output spoofing
dumko2001 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@googleworkspace/cli": minor | ||
| --- | ||
|
|
||
| Add +read helper for extracting Gmail message body as plain text |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| use super::*; | ||
| use std::io::{self, Write}; | ||
|
|
||
| /// Handle the `+read` subcommand. | ||
| pub(super) async fn handle_read( | ||
| _doc: &crate::discovery::RestDescription, | ||
| matches: &ArgMatches, | ||
| ) -> Result<(), GwsError> { | ||
| let message_id = matches.get_one::<String>("id").unwrap(); | ||
|
|
||
| let dry_run = matches.get_flag("dry-run"); | ||
|
|
||
| let original = if dry_run { | ||
| OriginalMessage::dry_run_placeholder(message_id) | ||
| } else { | ||
| let t = auth::get_token(&[GMAIL_READONLY_SCOPE]) | ||
| .await | ||
| .map_err(|e| GwsError::Auth(format!("Gmail auth failed: {e}")))?; | ||
|
|
||
| let client = crate::client::build_client()?; | ||
| fetch_message_metadata(&client, &t, message_id).await? | ||
| }; | ||
|
|
||
| let format = matches.get_one::<String>("format").unwrap(); | ||
| let show_headers = matches.get_flag("headers"); | ||
| let use_html = matches.get_flag("html"); | ||
|
|
||
| let mut stdout = io::stdout().lock(); | ||
|
|
||
| if format == "json" { | ||
| let json_output = serde_json::to_string_pretty(&original) | ||
| .context("Failed to serialize message to JSON")?; | ||
| writeln!(stdout, "{}", json_output).context("Failed to write JSON output")?; | ||
| return Ok(()); | ||
| } | ||
|
|
||
| if show_headers { | ||
| let headers_to_show = [ | ||
| ("From", &original.from), | ||
| ("To", &original.to), | ||
| ("Cc", &original.cc), | ||
| ("Subject", &original.subject), | ||
| ("Date", &original.date), | ||
| ]; | ||
| for (name, value) in headers_to_show { | ||
| if value.is_empty() { | ||
| continue; | ||
| } | ||
| // Replace newlines to prevent header spoofing in the output, then sanitize. | ||
| let sanitized_value = sanitize_terminal_output(&value.replace(['\r', '\n'], " ")); | ||
| writeln!(stdout, "{}: {}", name, sanitized_value) | ||
| .with_context(|| format!("Failed to write '{name}' header"))?; | ||
| } | ||
| writeln!(stdout, "---").context("Failed to write header separator")?; | ||
| } | ||
|
|
||
| let body = if use_html { | ||
| original | ||
| .body_html | ||
| .as_deref() | ||
| .filter(|s| !s.trim().is_empty()) | ||
| .unwrap_or(&original.body_text) | ||
| } else { | ||
| &original.body_text | ||
| }; | ||
|
|
||
| writeln!(stdout, "{}", sanitize_terminal_output(body)) | ||
| .context("Failed to write message body")?; | ||
|
|
||
| Ok(()) | ||
| } | ||
dumko2001 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /// Sanitizes a string for terminal output by filtering out control characters | ||
| /// to prevent terminal injection attacks. Safe control characters like | ||
| /// newline, carriage return, and tab are preserved. | ||
| fn sanitize_terminal_output(s: &str) -> String { | ||
| s.chars() | ||
| .filter(|c| !c.is_control() || matches!(c, '\n' | '\r' | '\t')) | ||
| .collect() | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use super::*; | ||
|
|
||
| #[test] | ||
| fn test_sanitize_terminal_output() { | ||
| let malicious = "Subject: \x1b]0;MALICIOUS\x07Hello\nWorld\r\t"; | ||
| let sanitized = sanitize_terminal_output(malicious); | ||
| // ANSI escape sequences (control chars) should be removed | ||
| assert!(!sanitized.contains('\x1b')); | ||
| assert!(!sanitized.contains('\x07')); | ||
| // Whitespace and formatting should be preserved | ||
| assert!(sanitized.contains("Hello")); | ||
| assert!(sanitized.contains('\n')); | ||
| assert!(sanitized.contains('\r')); | ||
| assert!(sanitized.contains('\t')); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.