Skip to main content

Matterbridge API plugin for Delta Chat

Project description

Matterdelta

Latest Release CI Code style: black

Matterdelta is a Matterbridge API plugin allowing to connect Delta Chat group chats to the various chat services supported by Matterbridge.

Install

pip install matterdelta

Usage

Configure the bot's Delta Chat account:

matterdelta init bot@example.com PASSWORD

You can run matterdelta init several times to add multiple different accounts to the bot so it can be reached in more than one email address.

The bot's display name, avatar and status/signature can also be tweaked:

matterdelta config selfavatar "/path/to/avatar.png"
matterdelta config displayname "Bridge Bot"
matterdelta config selfstatus "Hi, I am a Delta Chat bot"

To run the bot so it starts processing messages:

matterdelta serve

To see all available options run matterdelta --help

Example Configuration

matterbridge.toml

[api]
    [api.deltachat]
    BindAddress="127.0.0.1:4242"
    Token="MATTERBRIDGE_TOKEN"
    Buffer=1000
    RemoteNickFormat="{NICK}"

...

[[gateway]]
name="gateway1"
enable=true

    [[gateway.inout]]
    account="api.deltachat"
    channel="api"

    ...

Add these to your existing Matterbridge config to set up an API instance that Matterdelta can connect to.

config.json

{
  "gateways": [
    {"gateway": "gateway1", "accountId": 1, "chatId": 1234}
  ],
  "api": {
    "url": "http://127.0.0.1:4242",
    "token": "MATTERBRIDGE_TOKEN"
  },
  "quoteFormat": "{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE:.46})"
}

This file should be in Matterdelta's configuration directory, usually ~/.config/matterdelta/ in Linux-based systems.

To get the accountId and chatId of the chat you want to bridge, run the bot and add its address to your Delta Chat group, then send /id in the group, the bot will reply with the account and chat id, then edit the configuration file and restart the bot.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

matterdelta-1.6.1.tar.gz (19.3 kB view details)

Uploaded Source

Built Distribution

matterdelta-1.6.1-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file matterdelta-1.6.1.tar.gz.

File metadata

  • Download URL: matterdelta-1.6.1.tar.gz
  • Upload date:
  • Size: 19.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for matterdelta-1.6.1.tar.gz
Algorithm Hash digest
SHA256 3746c6518250d02fd69e45c9f03781fc68c5696bcc438e8915cea76a0912e36a
MD5 7284c9aeeb0afc2934f3e3aef5e78b3a
BLAKE2b-256 f48d085e06dc2cba82ee2d208c9bd5b6364a91426de2432d069ba54c94764a7b

See more details on using hashes here.

File details

Details for the file matterdelta-1.6.1-py3-none-any.whl.

File metadata

  • Download URL: matterdelta-1.6.1-py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for matterdelta-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e397346f2288b0e6887954d1656c3a9e5e5f4018d8079a2c378dc2c4ae4a699
MD5 f88166d17c641e34dc5ff0ddc4cb9949
BLAKE2b-256 a571bfbd6226e509de5bdf9685c633a226d60f4f4a71d2da21a7452b127fe8f4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page