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

Uploaded Source

Built Distribution

matterdelta-1.0.0-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for matterdelta-1.0.0.tar.gz
Algorithm Hash digest
SHA256 13cbdbf4ea49dbd12909110f80837a042e508ce4f36e406cb20d858d52f89f3a
MD5 01546f95c118b82a852826cdcb3751ac
BLAKE2b-256 5699137c86ca2cae44cd21758ef949711dd6bf0a8c8e4691bec6a5d21275b6ca

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: matterdelta-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 31.3 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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 10cd6cfb7acf8a6ab2c866bcb09dabd55f1929c2cd06245d920bada798e07c09
MD5 4b91a79fbec06d179fe01c79a2d53ddd
BLAKE2b-256 bae3e15c92bd75eecc14c90f4cb7405ba683fed67952d1b29ea2f3e020c0d852

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