Skip to main content

Bots

Bots can make your Matrix live esier. Especially when you have a room with many users in it. Bots can observe the conversations and filter bad word or ban users for using such.

Bots auf frei.chat

Name Description Version
@postmoogle:frei.chat An Email to Matrix bridge. 1 room = 1 mailbox. v0.9.12
@bot.maubot:frei.chat
A bot with multiple plugins.
v0.4.2

Postmoogle

This bot can send and receive emails for specific email addresses of the frei.chat domain. It is not possible to define custom domains at the moment.

Bot limitations

The sender address must follow the pattern USERNAME[SUFFIX]@frei.chat. Each user's email address must begin with the username. There is no limitation in the number of addresses per user.

Explanation of the email address:

The USERNAME value is always set to the username chosen by the user.
The value [SUFFIX] can be freely chosen by the user, provided it corresponds to the standard for email addresses.

Mail address examples:

USERNAME = Testuser

  • testuser@frei.chat
  • testuser**-1**@frei.chat
  • testuserhallo@frei.chat

Important information for new users

If you have just created your account, it may take up to an hour for your user to be enabled to receive and send email. This happens automatically on the hour.

How to use?

  1. Invite the bot into a new room (encryption supported).
  2. Use the command !pm help to show all commands.
  3. Use the command !pm mailbox USERNAME to assign the mail address USERNAME@frei.chat to the room.
    The room to mail address relation is 1:1!
  4. Now you can send and receive mails from that room.
  5. Repeat the steps to create other room with a mail address.

Maubot

A plugin-based Matrix bot system written in Python.

Project page: https://github.com/maubot/maubot

How to use?

Create an unencrypted room and invite @bot.maubot:frei.chat.

Plugins

This bot offers the following plugins. If you miss a plugin you can ask in the support channel for installation.
All plugins hat their own command. You can list all plugin command by sending !help into the chat the bot is participating in.

Plugin name
Command
Description
Link to plugin
Dice
!roll
A maubot that rolls dice. Has built-in calculator. v1.1.0
Gitlab
!gitlab
A GitLab client and webhook receiver for maubot.v0.2.1
Github
!github
A GitHub client and webhook receiver for maubot.v0.1.2
Help
!help
Simple plugin to add a help command for maubot. v0.2.0
Karma
!karma
A maubot that tracks the karma of users. v1.0.1
RSS
!rss
A maubot that posts RSS feed updates to Matrix.v0.3.2
Translate
!translate
A maubot to translate words using Google Translate (DeepL is planned too) v0.1.0