Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

README.md

Temporary Email CLI Tool

A command-line interface tool for managing temporary email addresses using the TempMail.so API. This tool allows you to create disposable email inboxes, receive emails, and manage your temporary email addresses all from the command line.

Features

  • Create temporary email inboxes with custom names and domains
  • List available email domains
  • Manage multiple inboxes
  • View and read received emails
  • Delete inboxes and individual emails
  • Configurable inbox lifespan
  • Secure API key storage

Prerequisites

  • Bash shell
  • curl
  • RapidAPI key for TempMail.so API
  • Authentication token

Installation

  1. Clone this repository:
git clone https://github.com/TempMailAPI/Temp-Mail-API.git
cd cli
  1. Make the script executable:
chmod +x tempmail
  1. Configure your API credentials:
./tempmail config <your-rapidapi-key> <your-auth-token>

Usage

Available Commands

./tempmail config <rapidapi-key> <auth-token>  # Configure API key
./tempmail domains                             # Show available domains
./tempmail create <name> <domain> [lifespan]   # Create new inbox
./tempmail list                                # List all inboxes
./tempmail delete-inbox <inbox-id>             # Delete inbox
./tempmail list-mails <inbox-id>               # List emails in inbox
./tempmail read-mail <inbox-id> <mail-id>      # Read email content
./tempmail delete-mail <inbox-id> <mail-id>    # Delete email
./tempmail help                                # Show help message

Examples

  1. List available domains:
./tempmail domains
  1. Create a new inbox:
./tempmail create myinbox example.com
  1. List all emails in an inbox:
./tempmail list-mails your-inbox-id

Security

  • API credentials are stored in ~/.tempmail_config
  • The configuration file permissions are set to 600 (readable only by the owner)
  • API requests are made over HTTPS

Contributing

Feel free to submit issues and enhancement requests!

License

This project is licensed under the MIT License - see the LICENSE file for details.