Skip to content

Update README.md file (Siddharth Pradeep / thirt33n / Mail-Checker Project) #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ndleah merged 1 commit into from
Feb 14, 2023
+27 −16
Merged

Update README.md file (Siddharth Pradeep / thirt33n / Mail-Checker Project) #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 27 additions & 16 deletions Mail_Checker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,43 +1,54 @@
# Mail Checker
<!--Please do not remove this part-->
![Star Badge](https://img.shields.io/static/v1?label=%F0%9F%8C%9F&message=If%20Useful&style=style=flat&color=BC4E99)
![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)

# Script Title

Mail Checker Application

Mail-Checker is a python script that lets you read your gmail subjects from particular gmail accounts directly from the terminal without having to login each time!
<!--An image is an illustration for your project, the tip here is using your sense of humour as much as you can :D

# Prerequisites

Before you try to execute this script make sure you allow less secure app access in your google account
You can copy paste my markdown photo insert as following:
<p align="center">
<img src="your-source-is-here" width=40% height=40%>
-->

To allow less secure apps click [here to go to your google account]( https://myaccount.google.com/lesssecureapps ). Allowing this does not compromise the security of your account! It only gives permission for applications such as this one to remotely check your emails.
## 🛠️ Description
<!--Remove the below lines and add yours -->
Mail-Checker is a python script that lets you read your gmail subjects from particular gmail accounts directly from the terminal without having to login each time!

## ⚙️ Languages or Frameworks Used
<!--Remove the below lines and add yours -->

We only require 'imaplib' python library to run this, this package is built-in to python, just import and use it!

import imaplib

I have attached a requirements.txt file that will install the neccessary python library needed for this script, in case if it turns out to be missing in your system.Run the command given below in the shell to install the requirements!
I have attached a requirements.txt file that will install the neccessary python library needed for this script, in case if it turns out to be missing in your system. Run the command given below in the shell to install the requirements!

pip install -r requirements.txt


Once you do this your script should be ready to use, make sure to add your account credentials and make other personalizations.

# Running the code
## 🌟 How to run
<!--Remove the below lines and add yours -->
Before you try to execute this script make sure you allow less secure app access in your google account

To allow less secure apps click [here to go to your google account]( https://myaccount.google.com/lesssecureapps ). Allowing this does not compromise the security of your account! It only gives permission for applications such as this one to remotely check your emails.

Run the code the same way you would run any python code ie, such as in text editors or IDEs like VSCode and view your outputs in your terminal window.

It should look something like this!

<p align="center">
## 📺 Demo

<img src="https://cdn.dribbble.com/users/10478669/screenshots/17309470/media/7bf794ce3bbba78c4fa8c5cbd0234cc7.png?compress=1&resize=800x600&vertical=top">

</p>

And thats it!


## 🤖 Author
<!--Remove the below lines and add yours -->
Name: Siddharth Pradeep

## Author
Git User Name: thirt33n

Siddharth Pradeep :)
Git URL: https://github.com/thirt33n