tmail

README

TMail

A terminal-based email client for Gmail.

Features

• Gmail Integration

  • Connect securely with application password
  • Read emails with a clean, navigable interface
  • Send emails with attachments
  • Reply to conversations

• Terminal UI

  • Intuitive keyboard-driven navigation
  • Email list with sender, subject, and date
  • Message view with formatted content
  • Composer with multiple recipient support

Quick Install

Run this in your terminal (macOS/Linux):

curl -sSf https://raw.githubusercontent.com/jacobbanks/tmail/main/install.sh | sh

First-time Setup

Before using tmail, you need a Gmail App Password.

1. Visit https://myaccount.google.com/security
2. Enable 2-Step Verification
3. Click on App Passwords, you may have to search for it in the search input at the top of the settings page.
4. Create an app password with your desired name.
5. Copy the 16-character password shown

# Setup User Credentials
tmail auth

You'll be prompted to enter:

1. Your Gmail address
2. An App Password (not your regular Gmail password)

🔑 Security Note: tmail stores credentials locally on your machine. For Gmail, you must create an App Password.

Reading Emails

# Read most recent emails
tmail read

Sending Emails

# Open the email composer
tmail send

# Quick send from command line
tmail simple-send --to user@example.com --subject "Hello" --body "This is a test email"

# Include attachments
tmail simple-send --to user@example.com --subject "With attachment" --body "See attached file" --attach path/to/file.pdf

Version Information

tmail version

Keyboard Shortcuts

Email List View

• j/k: Navigate down/up
• Enter: Open selected email
• q: Quit

Email Content View

• j/k: Scroll down/up
• Esc: Return to list view
• r: Reply to email
• q: Quit

Email Composer

• Tab: Navigate between fields
• Ctrl+N: Focus body content
• Ctrl+A: Add attachment
• Ctrl+S: Send email
• Ctrl+Q/C: Quit without sending

License

Distributed under the MIT License. See LICENSE for more information.

Documentation

Overview

tmail is a simple email client for the terminal