smtpbridge

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 26, 2021 License: MIT Imports: 1 Imported by: 0

README

smtpbridge

SMTP server that bridges email to other types of messaging services.

It only accepts attachments that are image/png or image/jpeg.

Do not expose this to the Internet, this is only intended to be used on your local network.

Senders

List of example senders.

  • Motion/AI detection from IP Cameras
  • Notifcations Linux servers such as unattended updates

Endpoints

The following message endpoints have been implemented.

  • Telegram

Configuration

Configuration file is located at ~/.smtpbridge.yml.

# Simple configuration
bridges:
  - name: test bridge
    endpoints:
      - test endpoint # Must match a name in the endpoints list

endpoints:
  - name: test endpoint
    type: telegram
    config:
      token: 2222222222222222222222
      chat_id: 111111111111111111111
# Full configuration
smtp:
  host: "" # Host to listen on
  port: 1025 # Port to listen on
  size: 26214400 # 25 MB, max allowed size of email in bytes

bridges:
  - name: test bridge
    email_to: foo@example.com # Filter based on to address
    email_from: bar@example.com # Filter based on from address
    only_text: false # When this is true, only the text of the email will be sent to endpoints
    only_attachments: false # When this is true, only the attachments of the email will be sent to endpoints
    endpoints:
      - test endpoint # Must match a name in the endpoints list

endpoints:
  - name: test endpoint
    type: telegram
    config:
      token: 2222222222222222222222
      chat_id: 111111111111111111111

Usage

smtpbridge server

Todo

  • SMTP authentication
  • Regex from and to addresses
  • Store past messages on filesystem
  • Web interface

Documentation

Overview

Copyright © 2021 ItsNotGoodName

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Directories

Path Synopsis
left
right

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL