{"id":25936081,"url":"https://github.com/jojiiofficial/matrix-emailbridge","last_synced_at":"2025-03-04T01:50:05.944Z","repository":{"id":36650930,"uuid":"203856271","full_name":"JojiiOfficial/Matrix-EmailBridge","owner":"JojiiOfficial","description":"A bridge written in Golang to receive and write emails in matrix","archived":false,"fork":false,"pushed_at":"2023-06-08T18:07:00.000Z","size":122,"stargazers_count":122,"open_issues_count":23,"forks_count":14,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-03T21:33:57.338Z","etag":null,"topics":["bot","bridge","email","imap","matrix","smtp"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JojiiOfficial.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-08-22T19:04:09.000Z","updated_at":"2024-10-29T20:25:14.000Z","dependencies_parsed_at":"2024-01-15T09:05:38.797Z","dependency_job_id":"398979f8-baa6-498b-89d3-f0f2117db2d9","html_url":"https://github.com/JojiiOfficial/Matrix-EmailBridge","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JojiiOfficial%2FMatrix-EmailBridge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JojiiOfficial%2FMatrix-EmailBridge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JojiiOfficial%2FMatrix-EmailBridge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JojiiOfficial%2FMatrix-EmailBridge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JojiiOfficial","download_url":"https://codeload.github.com/JojiiOfficial/Matrix-EmailBridge/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241768273,"owners_count":20017129,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","bridge","email","imap","matrix","smtp"],"created_at":"2025-03-04T01:50:05.072Z","updated_at":"2025-03-04T01:50:05.841Z","avatar_url":"https://github.com/JojiiOfficial.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Matrix-EmailBridge\nA Matrix-bridge to allow you receiving and sending emails in Matrix. You can have multiple email accounts and write emails to one or multiple recipients.\n\n## Installation\n### Compile method\n```\ngit clone https://github.com/JojiiOfficial/Matrix-EmailBridge\ncd Matrix-EmailBridge/main\ngo get -v -u\ngo build -o emailbridge\n./emailbridge\n```\nThe last command executes the bridge once to create the probably missing config file.\u003cbr\u003e\nContinue: --\u003e [Configure](https://github.com/JojiiOfficial/Matrix-EmailBridge#Get-started)\n\n### Docker method\nDockerHub: https://hub.docker.com/r/jojii/matrix_email_bridge\u003cbr\u003e\u003cbr\u003e\nRun \n```bash\ndocker pull jojii/matrix_email_bridge\n```\nto pull the image. Then create a container by running\n```bash\ndocker run -d \\\n--restart unless-stopped \\\n-v `pwd`/data:/app/data \\\n--name email_bridge \\\njojii/matrix_email_bridge\n```\n\u003cbr\u003e\nThis will create and start a new Docker Container and create a new dir called 'data' in the current directory. In this folder data.db, cfg.json and the logs will be stored.\u003cbr\u003e\n\nAfter [configuring the bridge](https://github.com/JojiiOfficial/Matrix-EmailBridge#Get-started) you have to run\n```bash\ndocker start email_bridge\n```\nto start the docker container again.\n\u003cbr\u003e\n`\nNote: 'localhost' as 'matrixserver' (in cfg.json) wouldn't work because of dockers own network. You have to specify the internal IP address of the matrix-synapse server!\n`\n\n# Get started\n1. Create a bot user.\n2. Get an access token to your Matrix-Server: \n```bash\ncurl -XPOST -d '{\"type\":\"m.login.password\", \"user\":\"@mailBotUsername:your-domain.com\", \"password\":\"mailbotPassword\"}' \"https://matrix.your-domain.com/_matrix/client/r0/login\"\n```\n3. Adjust the config file (cfg.json) to make it work with your matrix server:\n```JSON\n{\n  \"allowed_servers\": [\n    \"your-base-domain.com\"\n  ],\n  \"defaultmailcheckinterval\": 30,\n  \"htmldefault\": false,\n  \"markdownenabledbydefault\": true,\n  \"matrixaccesstoken\": \"access-token-from-step-3\",\n  \"matrixserver\": \"matrix.full-matrix-server-domain.com\",\n  \"matrixuserid\": \"@mailBotUsername:your-base-domain.com\"\n}\n```\n4. Invite your bot into a private room, it will join automatically.\u003cbr\u003e\n\nIf everything is set up correctly, you can bridge the room by typing \u003ccode\u003e!login\u003c/code\u003e. Then you just have to follow the instructions. The command \u003ccode\u003e!help\u003c/code\u003e shows a list with available commands.\u003cbr\u003e\nCreating new private rooms with the bridge lets you add multiple email accounts.\u003cbr\u003e\n\n\n## Note\nNote: you should change the permissions of the \u003ccode\u003ecfg.json\u003c/code\u003e and \u003ccode\u003edata.db\u003c/code\u003e to \u003cb\u003e640\u003c/b\u003e or \u003cb\u003e660\u003c/b\u003e because they contain sensitive data.\n\n## Features\n- [X]  Receiving Email with IMAPs\n- [X]  Use custom IMAPs Server and port\n- [X]  Use the bridge with multiple email addresses\n- [X]  Use the bridge with multiple user\n- [X]  Ignore SSL certs if required\n- [X]  Detailed error codes/logging \n- [X]  Use custom mailbox instead of INBOX\n- [X]  Sending emails (to one or multiple participants)\n- [X]  Use markdown (automatically translated to HTML) for writing emails (optional)\n- [X]  Viewing HTML messages (as good as your matrix-client supports html)\n- [X]  Attaching files sent into the bridged room\n- [X]  Emailaddress blocklist (Ignore emails from given emailaddress)\n\n## TODO\n\n- [ ]  System to send passwords not in plaintext\n- [ ]  Add more header (CC/Bcc)\n- [ ]  Update the installerscript\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjojiiofficial%2Fmatrix-emailbridge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjojiiofficial%2Fmatrix-emailbridge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjojiiofficial%2Fmatrix-emailbridge/lists"}