ParthShirole / email_tui

📧 email tui

---

Description

A terminal-based email client.

Simple, basic and straight-forward.

Created under Eklavya Mentorship Program 2021, SRA, VJTI.

---

Table of Contents

• Description
• About This Project
• Getting Started
• References/Notes
• Contributors
• Acknowledgements

About This Project

sample snaps/recording

Project Structure

What is a TUI

In computing, text-based user interfaces (TUI) is a retronym describing a type of user interface (UI) common as an early form of human–computer interaction, before the advent of graphical user interfaces (GUIs). Like GUIs, they may use the entire screen area and accept mouse and other inputs. They may also use color and often structure the display using special graphical characters. The modern context of use is usually a terminal emulator.

To read more about tui, click here.

What is Email

Electronic mail (email or e-mail) is a method of exchanging messages ("mail") between people using electronic devices.

Email operates across computer networks, primarily the Internet. Today's email systems are based on a store-and-forward model. Email servers accept, forward, deliver, and store messages. Neither the users nor their computers are required to be online simultaneously; they need to connect, typically to a mail server or a webmail interface to send or receive messages or download it.

Technologies/Libraries Used

• FTXUI

  (A simple C++ library for terminal based user interface.)

  link

• VMime

  (A library offering all the features to build a complete mail client.)

  link

Protocol/URL(s) used

• For Sending Mail

  • protocol used : SMTP
  • url : smtp://smtp.gmail.com

• For Fetching Mail

  • protocol used : IMAP
  • url : imap://username:[e-mail]:993

---

Getting Started

Prerequisites

FTXUI

git clone https://github.com/ArthurSonzogni/FTXUI    

Vmime

git clone https://github.com/kisli/vmime    

CMake

sudo apt-get install cmake

OR

Refer https://cmake.org/

TOML++

git clone https://github.com/marzer/tomlplusplus

Refer https://marzer.github.io/tomlplusplus/

---

Installation

1. Clone this repo

git clone https://github.com/ParthShirole/email_tui

Usage

1. First update your account credentials in config.toml

mkdir build
cd build
cmake ..
make -j8
./ftxuistarter

---

References/Notes

Refer documentation folder. link

Project Report link

---

Contributors

Shreyas Atre - @satacker

Kunal Wadhwa - @kwadhwa539

Parth Shirole - @parthshirole

---

Acknowledgements

• Special thanks to @ArthurSonzogni for his amazing UI library FTXUI
• Creators and contributors of Vmime Library
• SRA and Team (duh)

---

Back To The Top