Skip to main content

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

Metadata

Release files for chatmail2mastodon 0.9.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for chatmail2mastodon 0.9.1
File Interpreter ABI Platform
chatmail2mastodon-0.9.1-py3-none-any.whl Python 3 none any Details

Release files / chatmail2mastodon-0.9.1-py3-none-any.whl

Download URL chatmail2mastodon-0.9.1-py3-none-any.whl
Size 25.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0b68f5e38b99236e0271e6d85a7ed693d0098655a3f48711ea97b4f0341b1f46
BLAKE2b-256 checksum
How to use checksums
cd65b4a9546210aa60606362f3ccba8e9e887c85426915212e18c2d696d37764
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.3

Release history Release notifications | RSS feed

This release

0.9.1 This release

1 release file

0.9.0

1 release file

0.8.1

1 release file

0.8.0

1 release file

0.7.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page