Skip to content

Commit a7d3f2b

Browse files
author
jme
committed
Wrote a proper README, will add some licensing soon.
Also updated .gitignore.
1 parent f04891e commit a7d3f2b

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
config
22
package.json
3+
dbConfig

README

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
nuxMail
2+
-----
3+
4+
In here be some plugins (and docs :D) I've written to run my mail server. Submit an issue if you see one!
5+
6+
## Plugins
7+
8+
### Inbound
9+
10+
* jme.rcpt_to.aliases
11+
12+
* "This is a simple aliases plugin that allows chaining."
13+
14+
* jme.rcpt_to.disposable
15+
16+
* This is the plugin from the haraka plugin tutorial. A nice idea so I kept it.
17+
18+
* jme.rcpt_to.mailboxes
19+
20+
* This plugin allows you to specify exactly which user mailboxes you will accept mail for.
21+
22+
Because it manages users per domain, it has the benefit of managing which domains
23+
you accept mail to as well, so it should replace "rcpt_to.in_host_list" as the final plugin
24+
before the queue. They **DO NOT** work together.
25+
26+
This plugin is redundant if you push your mail directly to something like an IMAP server, since that will manage your users for you, but it's useful if you want to direct to, say, a ~/Maildir structure directly.
27+
28+
### Outbound
29+
30+
* jme.queue_outbound.accounts
31+
32+
* This plugin provides user authorisation for MAIL_FROM addresses.
33+
34+
An authenticated user can only send from addresses that are listed in the configuration.
35+
This works well in conjunction with rcpt_to alias plugins to ensure that users can only
36+
send email from the aliases that redirect to them, rather than any address they like.

0 commit comments

Comments
 (0)