Log in

gws-gmail-read

Vercel
All-time installs
37.6K

Gmail: Read a message and extract its body or headers.

Other options

Summary

Extract message body and headers from Gmail using message IDs.

  • Reads individual Gmail messages by ID and returns body content in plain text or HTML format
  • Optionally includes message headers (From, To, Subject, Date) in output
  • Supports multiple output formats (text, json) and automatically converts HTML-only messages to plain text
  • Handles multipart messages and base64 decoding; includes dry-run mode for testing requests

Raw SKILL.md

1,400 bytes
---
name: gws-gmail-read
description: "Gmail: Read a message and extract its body or headers."
metadata:
  version: 0.22.5
  openclaw:
    category: "productivity"
    requires:
      bins:
        - gws
    cliHelp: "gws gmail +read --help"
---

# gmail +read

> **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it.

Read a message and extract its body or headers

## Usage

```bash
gws gmail +read --id <ID>
```

## Flags

| Flag | Required | Default | Description |
|------|----------|---------|-------------|
| `--id` | ✓ | — | The Gmail message ID to read |
| `--headers` | — | — | Include headers (From, To, Subject, Date) in the output |
| `--format` | — | text | Output format (text, json) |
| `--html` | — | — | Return HTML body instead of plain text |
| `--dry-run` | — | — | Show the request that would be sent without executing it |

## Examples

```bash
gws gmail +read --id 18f1a2b3c4d
gws gmail +read --id 18f1a2b3c4d --headers
gws gmail +read --id 18f1a2b3c4d --format json | jq '.body'
```

## Tips

- Converts HTML-only messages to plain text automatically.
- Handles multipart/alternative and base64 decoding.

## See Also

- [gws-shared](../gws-shared/SKILL.md) — Global flags and auth
- [gws-gmail](../gws-gmail/SKILL.md) — All send, read, and manage email commands

Security audits

SnykWARN
SocketPASS
Gen Agent Trust HubPASS