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

Uploaded Source

Built Distribution

matterdelta-1.4.0-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for matterdelta-1.4.0.tar.gz
Algorithm Hash digest
SHA256 87cbb57d36feae6558589d9e4f4cb62d48b5cd942c158022cc4f35aa746e84bf
MD5 6628721cffda9be4f95c44c0088cfd56
BLAKE2b-256 1b0a8f0ae26654c4823f7593dc27e562a5808ec775e4abca59fb6dc98e3b29d0

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for matterdelta-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d499bbf09038ecf352e4770dbc4500b32d5b45f46769da8bda8be6eb91b1b73
MD5 66323fc72b3da7293d7a2a7c9023f2b1
BLAKE2b-256 b4ee7aaef73337faa1d3c2597c6c85e339a6115b65062ff8463d6d3ae55eea23

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