2023-04-03 20:36:43 +03:00
|
|
|
# mailpot - WIP mailing list manager
|
|
|
|
|
|
|
|
Rendered rustdoc of `core` crate: <https://meli.github.io/mailpot/docs/mailpot/>
|
2020-08-15 22:10:49 +03:00
|
|
|
|
2023-04-05 10:41:38 +03:00
|
|
|
CLI manpage: [`mpot.1`](./docs/mpot.1) [Rendered](https://git.meli.delivery/meli/mailpot/src/branch/main/docs/mpot.1)
|
|
|
|
|
2020-08-15 22:10:49 +03:00
|
|
|
Crates:
|
|
|
|
|
2023-04-03 20:36:43 +03:00
|
|
|
- `core` the library
|
2020-08-15 22:10:49 +03:00
|
|
|
- `cli` a command line tool to manage lists
|
2023-04-03 20:36:43 +03:00
|
|
|
- `archive-http` static web archive generation or with a dynamic http server
|
2020-08-15 22:10:49 +03:00
|
|
|
- `rest-http` a REST http server to manage lists
|
|
|
|
|
|
|
|
## Project goals
|
|
|
|
|
|
|
|
- easy setup
|
|
|
|
- extensible through Rust API as a library
|
|
|
|
- extensible through HTTP REST API as an HTTP server, with webhooks
|
|
|
|
- basic management through CLI
|
2023-04-03 20:36:43 +03:00
|
|
|
- optional lightweight web archiver
|
|
|
|
- useful for both newsletters, discussions, article comments
|
2020-08-15 22:10:49 +03:00
|
|
|
|
|
|
|
## Initial setup
|
|
|
|
|
2023-04-03 20:36:43 +03:00
|
|
|
Create a configuration file and a database:
|
2020-08-15 22:10:49 +03:00
|
|
|
|
|
|
|
```shell
|
|
|
|
$ mkdir -p /home/user/.config/mailpot
|
2023-04-03 20:36:43 +03:00
|
|
|
$ export MPOT_CONFIG=/home/user/.config/mailpot/config.toml
|
|
|
|
$ cargo run --bin mpot -- sample-config > "$MPOT_CONFIG"
|
|
|
|
$ # edit config and set database path e.g. "/home/user/.local/share/mailpot/mpot.db"
|
|
|
|
$ cargo run --bin mpot -- -c "$MPOT_CONFIG" db-location
|
2020-08-15 22:10:49 +03:00
|
|
|
/home/user/.local/share/mailpot/mpot.db
|
|
|
|
```
|
|
|
|
|
2023-04-03 20:36:43 +03:00
|
|
|
This creates the database file in the configuration file as if you executed the following:
|
2020-08-15 22:10:49 +03:00
|
|
|
|
|
|
|
```shell
|
|
|
|
$ sqlite3 /home/user/.local/share/mailpot/mpot.db < ./core/src/schema.sql
|
|
|
|
```
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
```text
|
|
|
|
% mpot help
|
|
|
|
mailpot 0.1.0
|
|
|
|
mini mailing list manager
|
|
|
|
|
|
|
|
USAGE:
|
|
|
|
mpot [FLAGS] [OPTIONS] <SUBCOMMAND>
|
|
|
|
|
|
|
|
FLAGS:
|
|
|
|
-d, --debug Activate debug mode
|
|
|
|
-h, --help Prints help information
|
|
|
|
-V, --version Prints version information
|
|
|
|
|
|
|
|
OPTIONS:
|
|
|
|
-c, --config <config> Set config file
|
|
|
|
|
|
|
|
SUBCOMMANDS:
|
|
|
|
create-list Create new list
|
|
|
|
db-location Prints database filesystem location
|
|
|
|
help Prints this message or the help of the given subcommand(s)
|
|
|
|
list Mailing list management
|
|
|
|
list-lists Lists all registered mailing lists
|
|
|
|
post Post message from STDIN to list
|
|
|
|
```
|
|
|
|
|
|
|
|
### Receiving mail
|
|
|
|
|
|
|
|
```shell
|
|
|
|
$ cat list-request.eml | cargo run --bin mpot -- -vvvvvv post --dry-run
|
|
|
|
```
|
|
|
|
|
|
|
|
<details><summary>output</summary>
|
|
|
|
|
|
|
|
```shell
|
|
|
|
TRACE - Received envelope to post: Envelope {
|
|
|
|
Subject: "unsubscribe",
|
|
|
|
Date: "Tue, 04 Aug 2020 14:10:13 +0300",
|
|
|
|
From: [
|
|
|
|
Address::Mailbox {
|
|
|
|
display_name: "Mxxxx Pxxxxxxxxxxxx",
|
|
|
|
address_spec: "exxxxx@localhost",
|
|
|
|
},
|
|
|
|
],
|
|
|
|
To: [
|
|
|
|
Address::Mailbox {
|
|
|
|
display_name: "",
|
|
|
|
address_spec: "test-announce+request@localhost",
|
|
|
|
},
|
|
|
|
],
|
|
|
|
Message-ID: "<ejduu.fddf8sgen4j7@localhost>",
|
|
|
|
In-Reply-To: None,
|
|
|
|
References: None,
|
|
|
|
Hash: 12581897380059220314,
|
|
|
|
}
|
|
|
|
TRACE - unsubscribe action for addresses [Address::Mailbox { display_name: "Mxxxx Pxxxxxxxxxxxx", address_spec: "exxxxx@localhost" }] in list [#2 test-announce] test announcements <test-announce@localhost>
|
|
|
|
TRACE - Is post related to list [#1 test] Test list <test@localhost>? false
|
|
|
|
```
|
|
|
|
</details>
|
|
|
|
|
|
|
|
```shell
|
|
|
|
$ cat list-post.eml | cargo run --bin mpot -- -vvvvvv post --dry-run
|
|
|
|
```
|
|
|
|
|
|
|
|
<details><summary>output</summary>
|
|
|
|
|
|
|
|
```shell
|
|
|
|
TRACE - Received envelope to post: Envelope {
|
|
|
|
Subject: "[test-announce] new test releases",
|
|
|
|
Date: "Tue, 04 Aug 2020 14:10:13 +0300",
|
|
|
|
From: [
|
|
|
|
Address::Mailbox {
|
|
|
|
display_name: "Mxxxx Pxxxxxxxxxxxx",
|
|
|
|
address_spec: "exxxxx@localhost",
|
|
|
|
},
|
|
|
|
],
|
|
|
|
To: [
|
|
|
|
Address::Mailbox {
|
|
|
|
display_name: "",
|
|
|
|
address_spec: "test-announce@localhost",
|
|
|
|
},
|
|
|
|
],
|
|
|
|
Message-ID: "<ejduu.sddf8sgen4j7@localhost>",
|
|
|
|
In-Reply-To: None,
|
|
|
|
References: None,
|
|
|
|
Hash: 10220641455578979007,
|
|
|
|
}
|
|
|
|
TRACE - Is post related to list [#1 test] Test list <test@localhost>? false
|
|
|
|
TRACE - Is post related to list [#2 test-announce] test announcements <test-announce@localhost>? true
|
|
|
|
TRACE - Examining list "test announcements" <test-announce@localhost>
|
2023-04-13 22:25:20 +03:00
|
|
|
TRACE - List subscriptions [
|
|
|
|
ListSubscription {
|
2020-08-15 22:10:49 +03:00
|
|
|
list: 2,
|
|
|
|
address: "exxxxx@localhost",
|
|
|
|
name: None,
|
|
|
|
digest: false,
|
|
|
|
hide_address: false,
|
|
|
|
receive_duplicates: false,
|
|
|
|
receive_own_posts: true,
|
|
|
|
receive_confirmation: true,
|
|
|
|
enabled: true,
|
|
|
|
},
|
|
|
|
]
|
|
|
|
TRACE - Running FixCRLF filter
|
|
|
|
TRACE - Running PostRightsCheck filter
|
|
|
|
TRACE - Running AddListHeaders filter
|
|
|
|
TRACE - Running FinalizeRecipients filter
|
2023-04-13 22:25:20 +03:00
|
|
|
TRACE - examining subscription ListSubscription { list: 2, address: "exxxxx@localhost", name: None, digest: false, hide_address: false, receive_duplicates: false, receive_own_posts: true, receive_confirmation: true, enabled: true }
|
|
|
|
TRACE - subscription is submitter
|
|
|
|
TRACE - subscription gets copy
|
2020-08-15 22:10:49 +03:00
|
|
|
TRACE - result Ok(
|
|
|
|
Post {
|
|
|
|
list: MailingList {
|
|
|
|
pk: 2,
|
|
|
|
name: "test announcements",
|
|
|
|
id: "test-announce",
|
|
|
|
address: "test-announce@localhost",
|
|
|
|
description: None,
|
|
|
|
archive_url: None,
|
|
|
|
},
|
|
|
|
from: Address::Mailbox {
|
|
|
|
display_name: "Mxxxx Pxxxxxxxxxxxx",
|
|
|
|
address_spec: "exxxxx@localhost",
|
|
|
|
},
|
2023-04-13 22:25:20 +03:00
|
|
|
subscriptions: 1,
|
2020-08-15 22:10:49 +03:00
|
|
|
bytes: 851,
|
|
|
|
policy: None,
|
|
|
|
to: [
|
|
|
|
Address::Mailbox {
|
|
|
|
display_name: "",
|
|
|
|
address_spec: "test-announce@localhost",
|
|
|
|
},
|
|
|
|
],
|
|
|
|
action: Accept {
|
|
|
|
recipients: [
|
|
|
|
Address::Mailbox {
|
|
|
|
display_name: "",
|
|
|
|
address_spec: "exxxxx@localhost",
|
|
|
|
},
|
|
|
|
],
|
|
|
|
digests: [],
|
|
|
|
},
|
|
|
|
},
|
|
|
|
)
|
|
|
|
```
|
|
|
|
</details>
|
2023-04-03 20:36:43 +03:00
|
|
|
|
|
|
|
## Using `mailpot` as a library
|
|
|
|
|
|
|
|
```rust
|
|
|
|
use mailpot::{models::*, *};
|
|
|
|
use tempfile::TempDir;
|
|
|
|
|
|
|
|
let tmp_dir = TempDir::new().unwrap();
|
|
|
|
let db_path = tmp_dir.path().join("mpot.db");
|
|
|
|
let config = Configuration {
|
|
|
|
send_mail: SendMail::ShellCommand("/usr/bin/false".to_string()),
|
|
|
|
db_path: db_path.clone(),
|
|
|
|
data_path: tmp_dir.path().to_path_buf(),
|
|
|
|
};
|
|
|
|
let db = Connection::open_or_create_db(config)?.trusted();
|
|
|
|
|
|
|
|
// Create a new mailing list
|
|
|
|
let list_pk = db.create_list(MailingList {
|
|
|
|
pk: 0,
|
|
|
|
name: "foobar chat".into(),
|
|
|
|
id: "foo-chat".into(),
|
|
|
|
address: "foo-chat@example.com".into(),
|
|
|
|
description: None,
|
|
|
|
archive_url: None,
|
|
|
|
})?.pk;
|
|
|
|
|
|
|
|
db.set_list_policy(
|
|
|
|
PostPolicy {
|
|
|
|
pk: 0,
|
|
|
|
list: list_pk,
|
|
|
|
announce_only: false,
|
2023-04-13 22:25:20 +03:00
|
|
|
subscription_only: true,
|
2023-04-03 20:36:43 +03:00
|
|
|
approval_needed: false,
|
2023-04-05 10:41:38 +03:00
|
|
|
open: false,
|
2023-04-03 20:36:43 +03:00
|
|
|
custom: false,
|
|
|
|
},
|
|
|
|
)?;
|
|
|
|
|
2023-04-13 22:25:20 +03:00
|
|
|
// Drop privileges; we can only process new e-mail and modify subscriptions from now on.
|
2023-04-04 13:58:22 +03:00
|
|
|
let mut db = db.untrusted();
|
2023-04-03 20:36:43 +03:00
|
|
|
|
2023-04-13 22:25:20 +03:00
|
|
|
assert_eq!(db.list_subscriptions(list_pk)?.len(), 0);
|
2023-04-03 20:36:43 +03:00
|
|
|
assert_eq!(db.list_posts(list_pk, None)?.len(), 0);
|
|
|
|
|
|
|
|
// Process a subscription request e-mail
|
|
|
|
let subscribe_bytes = b"From: Name <user@example.com>
|
|
|
|
To: <foo-chat+subscribe@example.com>
|
|
|
|
Subject: subscribe
|
|
|
|
Date: Thu, 29 Oct 2020 13:58:16 +0000
|
|
|
|
Message-ID: <1@example.com>
|
|
|
|
|
|
|
|
";
|
|
|
|
let envelope = melib::Envelope::from_bytes(subscribe_bytes, None)?;
|
|
|
|
db.post(&envelope, subscribe_bytes, /* dry_run */ false)?;
|
|
|
|
|
2023-04-13 22:25:20 +03:00
|
|
|
assert_eq!(db.list_subscriptions(list_pk)?.len(), 1);
|
2023-04-03 20:36:43 +03:00
|
|
|
assert_eq!(db.list_posts(list_pk, None)?.len(), 0);
|
|
|
|
|
|
|
|
// Process a post
|
|
|
|
let post_bytes = b"From: Name <user@example.com>
|
|
|
|
To: <foo-chat@example.com>
|
|
|
|
Subject: my first post
|
|
|
|
Date: Thu, 29 Oct 2020 14:01:09 +0000
|
|
|
|
Message-ID: <2@example.com>
|
|
|
|
|
|
|
|
Hello
|
|
|
|
";
|
|
|
|
let envelope =
|
|
|
|
melib::Envelope::from_bytes(post_bytes, None).expect("Could not parse message");
|
|
|
|
db.post(&envelope, post_bytes, /* dry_run */ false)?;
|
|
|
|
|
2023-04-13 22:25:20 +03:00
|
|
|
assert_eq!(db.list_subscriptions(list_pk)?.len(), 1);
|
2023-04-03 20:36:43 +03:00
|
|
|
assert_eq!(db.list_posts(list_pk, None)?.len(), 1);
|
|
|
|
# Ok::<(), Error>(())
|
|
|
|
```
|