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

Uploaded Source

Built Distribution

matterdelta-1.2.0-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for matterdelta-1.2.0.tar.gz
Algorithm Hash digest
SHA256 0c081f462001bf0305c0412405511774aa534676cba43a803f70ee29cc5382a5
MD5 d810cb64c230b080b4afea32db5ca2e9
BLAKE2b-256 cfbaf2ef74937bdb250950cbf934dcbae88f22bdc1055f1466471d6ba0d7804b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: matterdelta-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.7 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e207c2e03317a16aff851b9259bbe5aacadc7317817d24e019a4104b25e7747
MD5 87f876e6b1a68232777ed50853a59cf5
BLAKE2b-256 2976429eb1c6f5ad47fa4587f129a27be15de3262d82e420256d14010be8b590

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