Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/synox/disposable-mailbox
self-hosted disposable email service (php) using catch-all and imap
https://github.com/synox/disposable-mailbox
disposable-email email-client imap imap-client php temporary-email trashmail
Last synced: about 1 month ago
JSON representation
self-hosted disposable email service (php) using catch-all and imap
- Host: GitHub
- URL: https://github.com/synox/disposable-mailbox
- Owner: synox
- License: gpl-3.0
- Archived: true
- Created: 2016-07-02T21:06:09.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-03-27T20:44:17.000Z (over 3 years ago)
- Last Synced: 2024-08-02T12:43:06.769Z (4 months ago)
- Topics: disposable-email, email-client, imap, imap-client, php, temporary-email, trashmail
- Language: PHP
- Homepage:
- Size: 3.78 MB
- Stars: 391
- Watchers: 27
- Forks: 147
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-starred - synox/disposable-mailbox - self-hosted disposable email service (php) using catch-all and imap (php)
README
# disposable-mailbox
[](https://gitter.im/synox/disposable-mailbox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
A **self-hosted** disposable mailbox service (aka trash mail) :cloud: :envelope:
**PHP is not your thing? You should try the more efficient NodeJs version:** https://github.com/synox/void-mail
-----
## 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](https://www.google.ch/search?q=how+to+setup+catch-all+imap+mailbox).
* Only requires PHP >=7.2 and [imap extension](http://php.net/manual/book.imap.php)
## Usage
### Requirements
* webserver with php >=7.2
* php [imap extension](http://php.net/manual/book.imap.php)
* IMAP account and a domain with [catch-all configuration](https://www.google.ch/search?q=how+to+setup+catch-all+imap+mailbox). (all emails go to one mailbox).
### Before you start :heavy_exclamation_mark:
* Subscribe to [](https://gitter.im/synox/disposable-mailbox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) to be notified about issues and bugfixes.
* This is **Beta** software, [there are still unsolved problems](https://github.com/synox/disposable-mailbox/issues). 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](https://opensource.org/licenses/GPL-3.0).
* A link to https://github.com/synox/disposable-mailbox in the footer is appreciated.
### Installation
Disposable-mailbox can be installed by copying the src directory to a webserver.
1. assure the [imap extension](http://php.net/manual/book.imap.php) is installed. The following command should not print any errors:
2. download a [release](https://github.com/synox/disposable-mailbox/releases) or clone this repository
3. copy the files in the `src` directory to your web server (not the whole repo!).
4. 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.
5. 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](https://getcomposer.org/download/) 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...
* https://github.com/barbushin/php-imap, https://github.com/gnugat-legacy/PronounceableWord, http://htmlpurifier.org/,
* https://github.com/turbolinks/turbolinks, http://tobiasahlin.com/spinkit/