updated readme and small cleanup
This commit is contained in:
parent
fac68fe552
commit
dcc188990a
10
README.md
10
README.md
|
@ -35,6 +35,16 @@
|
|||
- 100% file based, no database needed
|
||||
- Can be used as Email Honeypot
|
||||
|
||||
# General API calls and functions
|
||||
|
||||
| Endpoint | Explanation | Example output |
|
||||
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|
|
||||
| /rss/`[email-address]` | Renders RSS XML for rss clients to render emails | [![](https://pictshare.net/ysu5qp.png)](https://pictshare.net/ysu5qp.png) |
|
||||
| /api/raw/`[email-address]/[id]` | Returns the raw email of the address. Warning: Output can be as large as the email itself so might be up to 20mb for mails with large attachments | [![](https://pictshare.net/pkb49p.png)](https://pictshare.net/pkb49p.png) |
|
||||
| /api/attachment`[email-address]/[attachment-id]` | Returns the attachment with the correct mime type as header | |
|
||||
| /api/delete/`[email-address]/[id]` | Deletes a specific email message and their attachments | |
|
||||
| /api/deleteaccount/`[email-address]`| Deletes all messages and attachments of this email account | |
|
||||
|
||||
# JSON API
|
||||
|
||||
| Endpoint | Explanation | Example output |
|
||||
|
|
|
@ -32,7 +32,6 @@ class OpenTrashmailBackend{
|
|||
return $this->deleteMail($_REQUEST['email']?:$this->url[2],$_REQUEST['id']?:$this->url[3]);
|
||||
case 'random':
|
||||
$addr = generateRandomEmail();
|
||||
//add header HX-Redirect
|
||||
return $this->listAccount($addr);
|
||||
case 'deleteaccount':
|
||||
return $this->deleteAccount($_REQUEST['email']?:$this->url[2]);
|
||||
|
|
Loading…
Reference in a new issue