107 lines
2.9 KiB
Markdown
107 lines
2.9 KiB
Markdown
---
|
|
allowed-tools: Bash, Read, Write, Edit
|
|
argument-hint: [resource] [method] [flags]
|
|
description: Gmail: Send, read, and manage email.
|
|
---
|
|
|
|
# Google Workspace Gmail
|
|
|
|
Execute Google Workspace Gmail operations: $ARGUMENTS
|
|
|
|
## Prerequisites
|
|
|
|
- Google Workspace CLI (`gws`) must be installed
|
|
- Authentication configured: Run `gws auth status` to verify
|
|
- Review `gws gmail --help` for all available commands
|
|
|
|
## Available Resources and Methods
|
|
|
|
# gmail (v1)
|
|
|
|
> **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it.
|
|
|
|
```bash
|
|
gws gmail <resource> <method> [flags]
|
|
```
|
|
|
|
## Helper Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| [`+send`](../gws-gmail-send/SKILL.md) | Send an email |
|
|
| [`+triage`](../gws-gmail-triage/SKILL.md) | Show unread inbox summary (sender, subject, date) |
|
|
| [`+watch`](../gws-gmail-watch/SKILL.md) | Watch for new emails and stream them as NDJSON |
|
|
|
|
## API Resources
|
|
|
|
### users
|
|
|
|
- `getProfile` — Gets the current user's Gmail profile.
|
|
- `stop` — Stop receiving push notifications for the given user mailbox.
|
|
- `watch` — Set up or update a push notification watch on the given user mailbox.
|
|
- `drafts` — Operations on the 'drafts' resource
|
|
- `history` — Operations on the 'history' resource
|
|
- `labels` — Operations on the 'labels' resource
|
|
- `messages` — Operations on the 'messages' resource
|
|
- `settings` — Operations on the 'settings' resource
|
|
- `threads` — Operations on the 'threads' resource
|
|
|
|
## Discovering Commands
|
|
|
|
Before calling any API method, inspect it:
|
|
|
|
```bash
|
|
# Browse resources and methods
|
|
gws gmail --help
|
|
|
|
# Inspect a method's required params, types, and defaults
|
|
gws schema gmail.<resource>.<method>
|
|
```
|
|
|
|
Use `gws schema` output to build your `--params` and `--json` flags.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# List available resources and methods
|
|
gws gmail --help
|
|
|
|
# Inspect method schema before calling
|
|
gws schema gmail.<resource>.<method>
|
|
|
|
# Execute command with arguments
|
|
gws gmail $ARGUMENTS
|
|
```
|
|
|
|
## Task
|
|
|
|
Execute the requested Gmail operation: $ARGUMENTS
|
|
|
|
1. **Verify Prerequisites**
|
|
- Check `gws` is installed: `gws --version`
|
|
- Verify authentication: `gws auth status`
|
|
- Review available commands: `gws gmail --help`
|
|
|
|
2. **Inspect Method Schema**
|
|
- Before calling any method, inspect its parameters
|
|
- Use `gws schema` to understand required fields
|
|
- Review parameter types and constraints
|
|
|
|
3. **Execute Operation**
|
|
- Build command with appropriate flags
|
|
- Use `--params` for query/path parameters
|
|
- Use `--json` for request body
|
|
- Handle pagination with `--max-results` or `--page-token`
|
|
|
|
4. **Error Handling**
|
|
- Check command output for errors
|
|
- Review API quotas and rate limits
|
|
- Handle authentication issues
|
|
- Retry transient failures
|
|
|
|
---
|
|
|
|
**License**: Apache License 2.0
|
|
**Source**: [Google Workspace CLI](https://github.com/googleworkspace/cli)
|
|
**Original Skill**: `gws-gmail`
|