self-hosted disposable email service (php) using catch-all and imap

1 Vetvy

nipos 9c75289df7 Change links to new maintainer		4 rokov pred
docs	d835806a28 move images to docs/	5 rokov pred
src	9c75289df7 Change links to new maintainer	4 rokov pred
.gitignore	60c2f6d537 ignore .php_cs.cache	5 rokov pred
.php_cs.dist	11b9216a0d fixed config	5 rokov pred
CHANGELOG.md	9c75289df7 Change links to new maintainer	4 rokov pred
CONTRIBUTING.md	e6c59280e3 update standards	5 rokov pred
LICENSE.txt	e92a92d16b License: GPL-3.0	7 rokov pred
README.md	9c75289df7 Change links to new maintainer	4 rokov pred
app.json	3ae1681486 Updates for Heroku (#68)	6 rokov pred
composer.json	a564214373 renamed backend-libs to vendor	5 rokov pred
composer.lock	d93bbe0a7d Bump php-imap/php-imap from 3.0.28 to 3.0.30 (#113)	5 rokov pred

disposable-mailbox

A self-hosted disposable mailbox service (aka trash mail) :cloud: :envelope:

Forked from synox/disposable-mailbox

Demo: LinuxPizza

Features

Anonymous usage, generate random email addresses.
New Mail notification. Download and delete your emails.
Display emails as text or html with sanitization filter.
Display emails based on one catch-all imap mailbox.
Only requires PHP >=7.2 and imap extension

Usage

Requirements

webserver with php >=7.2
php imap extension
IMAP account and a domain with catch-all configuration. (all emails go to one mailbox).

Before you start :heavy_exclamation_mark:

Subscribe to this repository to be notified about issues and bugfixes.
This is Beta software, there are still unsolved problems. Contributions are welcome! :heart:
License: GPL-3.0. You can modify this application and run it anywhere, charge money and show advertisement. Any forks or repacked distribution must follow the GPL-3.0 license.
A link to https://notabug.org/nipos/disposable-mailbox in the footer is appreciated.

Installation

Disposable-mailbox can be installed by copying the src directory to a webserver.

assure the imap extension is installed. The following command should not print any errors:
```
<?php print imap_base64("SU1BUCBleHRlbnNpb24gc2VlbXMgdG8gYmUgaW5zdGFsbGVkLiA="); ?>
```
download a release or clone this repository
copy the files in the src directory to your web server (not the whole repo!).
rename config.sample.php to config.php and apply the imap settings. Move config.php to a safe location in a parent directory outside the public_html, so it is not reachable through the browser.
open it in your browser, check your php error log for messages.

Build it yourself

The src directory contains all required files. If you want to update the php dependencies, you can update them yourself. You must have composer installed.

Install php dependecies:

composer update

Troubleshooting

IMAP Server has invalid certificate: You might have to add novalidate-cert to the IMAP settings. See flags on http://php.net/manual/en/function.imap-open.php.
Error 500, Internal error: Check your error log file. Add to config.php:

ini_set('display_errors', 1); ini_set('display_startup_errors', 1); error_reporting(E_ALL);

Testing on MacOs

brew install php
brew tap kabel/php-ext
brew install kabel/php-ext/php-imap
php -S localhost:8000 -t src

Credit :thumbsup:

This could not be possible without...

README.md