synox / disposable-mailbox

self-hosted disposable email service (php) using catch-all and imap
GNU General Public License v3.0
390 stars 147 forks source link
disposable-email email-client imap imap-client php temporary-email trashmail

disposable-mailbox

Join the chat at https://gitter.im/synox/disposable-mailbox

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


Screenshot

Features

Usage

Requirements

Before you start :heavy_exclamation_mark:

Installation

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

  1. assure the imap extension is installed. The following command should not print any errors:

    <?php print imap_base64("SU1BUCBleHRlbnNpb24gc2VlbXMgdG8gYmUgaW5zdGFsbGVkLiA="); ?>
  2. download a release 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 installed.

Install php dependecies:

composer update

Troubleshooting

Testing on MacOs

Credit :thumbsup:

This could not be possible without...