Actualizar 'README.md'

This commit is contained in:
borekon 2024-02-02 10:19:27 +00:00
parent a1e3082d45
commit 478eeafb8f

View File

@ -2,7 +2,7 @@
A **self-hosted** disposable mailbox service (aka trash mail) :cloud: :envelope: 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 Forked from https://github.com/synox/disposable-mailbox (now an archived project)
----- -----
@ -15,21 +15,20 @@ A **self-hosted** disposable mailbox service (aka trash mail) :cloud: :envelop
* New Mail notification. Download and delete your emails. * New Mail notification. Download and delete your emails.
* Display emails as text or html with sanitization filter. * 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). * 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) * Only requires PHP 7.2 (tested on php 7.4) and [imap extension](http://php.net/manual/book.imap.php)
## Usage ## Usage
### Requirements ### Requirements
* webserver with php 7.2 * webserver with php 7.2/7.4
* php [imap extension](http://php.net/manual/book.imap.php) * php [imap extension](http://php.net/manual/book.imap.php) (`apt install php7.2-imap`)
* 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). * 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: ### Before you start :heavy_exclamation_mark:
* This is **Beta** software, [there are still unsolved problems](https://gitea.avc.cx/borekon/disposable-mailbox/issues). Contributions are welcome! :heart: * This is **Beta** software, there could be [unsolved problems](https://gitea.avc.cx/borekon/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). * 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 ### Installation