Skip to content

vasusharma7/BashBird

 
 

Repository files navigation

BashBird

Easy to use terminal based email client.

GitHub top language Made by GitHub

About the project   |    Features   |    Getting started   |    Built with   |    Acknowledgements   |   

Layout

👨🏻‍💻 About The Project

BashBird is a terminal based email client that lets you send and view emails from terminal. The app is written in python3 and uses curses library for frontend and socket programming under the hood to connect IMAP (to receive emails) and SMTP (to send emails) servers.

🌟 Features

  • Complete terminal based experience
  • Support for gmail, outlook and coep email account
  • Authenticate securely using SSL and STARTTLS
  • Send emails to multiple recipients.
  • Add multiple attachments (pdf, zip, images supported)
  • Multiple mailboxes
  • View emails by selecting mailbox
  • Delete emails
  • Download email attachments

💻 Getting Started

Prerequisites:

  1. Python3
  2. Linux

Installing:

  1. Install all the required dependencies:
    pip3 install -r requirements.txt

Usage:

  1. Start using the app:
    python3 bashbird.py

Instructions:

  1. Use the app in maximize window mode for optimal experience
  2. Check that IMAP is enabled for your gmail account
  3. Follow login instructions page to login using your gmail account

The app was tested on python version 3.8 and linux environment

🚀 Built With

  1. Curses: terminal handling module for python
  2. python3

📝 Acknowledgements

  1. IMAP: RFC3501
  2. SMTP: RFC821, RFC2487, RFC2554

About

Easy to use terminal-based email client

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%