README

Join Telegram

68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f666f6c6c6f772f6d616e6f6d69746568712e7376673f7374796c653d736f6369616c

Intelligent email and sms security system that protects inboxes from spam and cyber threats. Perform email & sms grouping, notifications and other interesting features.

Loved the project? Please consider donating to help it improve!

Your email and sms inbox is your bank account and identity. You should keep your inboxes safe by all means because it could leak all your confidential informations to hackers or compromise all your accounts linked to the email or phone number.

Eye-mail does not read or disclose your messages to anyone as you are in charge. Your privacy is protected. If you are using the backup feature, all your messages are encrypted using your offline private key before transfering to the backup cloud

Todo Features:

Inspects outgoing and incoming mails for cyber attacks
Blocks vulnerable messages and quarantine them for inspections
Inspect mail attachments and blocks vulnerable files
Provides useful insights on total blocked, total allowed on daily, weekly and yearly bases
Group messages based on their categories types
Inspect spam inbox for false positive messages and send them to main inbox
Sends all mail notifications through push, sms, whatsapp and telegram [You can also implement your own notification module]
Blocks all phishing links and messages
Add recaptrics (recaptcha) for blocking bots
Add holiday days off (breaktime) - During this days messages will not be allowed entry if enabled
Add custom filters for allowing specific types of messages only
Clean inboxes from unwanted messages and junks
Block illegal mail trackings [privacy protections]
Add encrypted vaults - [Keep highly confidential informations encrypted in your email vault and only decrypt it back with your offline keys.]
Proactively monitor your email address and phone number for malicious use or compromise and notify you immediately via your communication module
Add integrity check on all messages for alteration detections
Backup all your email inboxes and sms - Default backup service is [Pangea, AWS and Digitalocean]
Easily export all or some of your emails to spreadsheets, pdf or image

Installing Eye-mail

Stage 1

Before you can use or install Eye-mail, make sure you have this softwares installed on your system and configure it for production use.

Softwares	Version	Installation
MongoDB	Latest	MongoDB
RabbitMQ	Latest	RabbitMQ
Redis	Latest	Redis
Clam Antivirus	Latest	Clamav

Stage 2

You must choose a version that fits the requirements of your project. The differences between the requirements for the available versions of Eye-mail are briefly highlighted below.

	PHP	Support
Eye-mail 1.0 and newer	8.1.0	✔️ Active

Note: Eye-mail 1.0.x works on PHP equal or greater than 8.1.

Once you have the prerequisites installed, install Eye-mail through

git clone https://github.com/mitmelon/eye-mail

Open the Config and configure settings such as;

MongoDB connection query
Redis connection
RabbitMQ connection
Clamav connection
Set environment to => production
Security Variables
System Variables
Backup Variables

Commercial Support

If your company requires support for a new feature or technical support, Contact Manomite to inquire about commercial support options.

Using Eye-mail in Your Project

Check out the documentation. Eye-mail API is designed for simplicity.

Please note that Eye-mail contain the update module which automatically updates Eye-mail packages and modules when its available. You can deactivate this settings from the config or from API.

Changelog

All notable changes to this project will be documented here.

Contribute

Contributions are always welcome!

License

MIT License

mitmelon / eye-mail

Maintainers

Details