ben/matrix-email-bot/pipeline/head This commit looks good Details
|2 years ago|
|config||2 years ago|
|src||2 years ago|
|views||6 years ago|
|.dockerignore||2 years ago|
|.gitignore||2 years ago|
|Dockerfile||2 years ago|
|Jenkinsfile||2 years ago|
|LICENSE||2 years ago|
|README.md||2 years ago|
|package.json||2 years ago|
|post_message.js||2 years ago|
|tsconfig.json||2 years ago|
|yarn.lock||2 years ago|
A bot that posts messages to rooms when an email is received. Ideal for uses where a short message is desired in a chat room when a newsletter goes out.
Questions? Ask away in #email:t2bot.io
How to use (t2bot.io hosted version)
Note: Currently this is in the early stages of development and is therefore somewhat restricted in what is possible. Future enhancements are planned to make this easier to use and set up.
@email:t2bot.ioto your Matrix room.
- Get your room's internal ID (for instance,
@travis:t2l.io(via DM) to set the appropriate
allow_fromrule for your room. (This is a temporary step until #1 is implemented)
- Send an email to
<room id without !>_<domain>@email.t2bot.io(eg:
- See the message the bot posts (this may take a while depending on system load).
Subscribing to mailing lists
Please reach out to
@travis:t2l.io (via DM) to get your room mapped to a mailing list. In the future,
this will be better and require less involvement from humans.
Run your own
Note: Some experience with MX records is ideal.
The bot runs best on port 25 to receive all incoming mail to your server. The bot does not (currently) send mail out, but does process all inbound emails to try and get them to the proper room (letting them disappear if no room can be mapped).
- Set up an MX record to point to your domain. For example,
email.t2bot.io 10 vps3.t2l.io(
email.t2bot.iobeing the domain,
10the priority, and
vps3.t2l.iobeing the server's hostname)
- Optionally install
sudo apt-get install spamassassin spamc- be sure to enable them!
- Install nodejs and npm (v14+ preferred).
- Clone this repository and run
config/production.yamland configure accordingly.
- Set the environment variable
- Start using your bot!
There is also a Docker image available at
t2bot/matrix-email-bot - map your config to
Running with an existing mail server
TODO: Instructions on how to set up postfix
If mail is currently being managed for your domain, or you'd like to filter the incoming mail
in a more intelligent manner before it reaches the bot, set
The existing mail server will need to be configured to run an external program so mail can be
sent to the bot. Have the mail server run
node post_message.js in the bot's directory to post
a message from the standard input pipe. If the email is in file form, use the following syntax:
node post_message.js path/to/file.eml.
Subscribing to mailing lists
Some mailing lists require you to send an email in order to subscribe. This requires setting up a
mailserver (such as postfix) in send-only mode because the bot is handling incoming mail. After
setting up your mail server, use it to send an email to the list with the
From address being the
room you'd like to announce to. For example:
echo "Subscribe" | mail -s "Subscribe" firstname.lastname@example.org -aFrom:email@example.com
Migration from v1
The bot now stores everything under a single configurable
storagePath. The following should be moved there:
The bot also supports encryption now: it will create a device and such all on its own. It is recommended to log out of all access tokens for the bot and re-create one manually using a login script instead of getting an access token from a crypto-capable client.
For operational purposes, everything under the
storagePath should be backed up and persisted.