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.3.0.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

matterdelta-1.3.0-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: matterdelta-1.3.0.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for matterdelta-1.3.0.tar.gz
Algorithm Hash digest
SHA256 9c42dfe609a601e9d1f3863e16f9b162f53c12e4b442ffa3c2bbaff561fe9b7a
MD5 d89d1180832d9a8aa4dbe8f5ab05d7d9
BLAKE2b-256 9b17dd661683fca61e71f83586a7bdc832551c29e28d5d2e482a1ff0db483fff

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: matterdelta-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for matterdelta-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6a1609844e3a26afaee1e037a13da7483c562187732a58b4e678e923002cf394
MD5 69b3827a5bba855498eaef2f92770fb3
BLAKE2b-256 f7e68a772561e81899e425ae5b8212b5ad4fc7fad034a12f8f34f77cd2dfeb8a

See more details on using hashes here.

Provenance

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