Skip to main content

Mastodon/DeltaChat bridge

Project description

Mastodon Bridge

Latest Release CI Code style: black

A Mastodon ↔️ Chatmail bridge.

Install

To install run:

pip install chatmail2mastodon

Configuration

To configure the bot:

chatmail2mastodon init dcaccount:nine.testrun.org

(Optional) To customize the bot name, avatar and status/signature:

chatmail2mastodon config selfavatar "/path/to/avatar.png"
chatmail2mastodon config displayname "My Bot"
chatmail2mastodon config selfstatus "Hi, I am a bot!"

Finally you can start the bot with:

chatmail2mastodon serve

To see the available options, run in the command line:

chatmail2mastodon --help

User Guide

To log in with OAuth, send a message to the bot:

/login mastodon.social

replace "mastodon.social" with your instance, the bot will reply with an URL that you should open to grant access to your account, copy the code you will receive and send it to the bot.

To log in with your user and password directly(not recommended):

/login mastodon.social me@example.com myPassw0rd

Once you log in, A "Home" and "Notifications" chats will appear, in the Home chat you will receive your Home timeline and any message you send there will be published on Mastodon. In the Notifications chat you will receive all the notifications for your account.

If someone sends you a direct message in a private 1:1 conversation, it will be shown as a new chat where you can chat in private with that person, to start a private chat with some Mastodon user, send:

/dm friend@example.com

and the chat with "friend@example.com" will pop up.

To logout from your account:

/logout

For more info and all the available commands(follow, block, mute, etc), send this message to the bot:

/help

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chatmail2mastodon-0.9.0-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

Details for the file chatmail2mastodon-0.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for chatmail2mastodon-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 865bd4f47e26ce48b530e9cc7a65980e9be2a58d2482af2980503b83b0eedaf5
MD5 75dbd1322f3f0ef7ffe09e0dd5e77a50
BLAKE2b-256 a0ac6bf487fce03e7acc0332e135932e44aa45c3c4d2dcaa2399766e864473c5

See more details on using hashes here.

Supported by

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