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.
Use Cases
- Receive motion/AI detection from IP cameras
- Receive notifications from Linux servers such as unattended updates
Endpoints
The following endpoints for messages have been implemented.
- Telegram
Configuration
Configuration file is located at ~/.smtpbridge.yml.
# Simple configuration
bridges:
- name: test bridge
endpoints:
- test endpoint # Match a name in the endpoints list
endpoints:
- name: test endpoint
type: telegram
config:
token: 2222222222222222222222
chat_id: 111111111111111111111
# Full configuration
database: # Database to store past messages
type: bolt # Needs to be 'bolt' to be enabled, Default ''
db: /tmp/smtpbridge.db # Default '$HOME/.smtpbridge/smtpbridge.db'
attachments: /tmp/attachments # Default '$HOME/.smtpbridge/attachments'
size: 2147483648 # Max size of attachments directory in bytes, Default 2147483648 (2 GiB)
http: # HTTP server that shows past messages
enable: true # Enable http server, default 'false'
host: "127.0.0.1" # Host to listen on, default ''
port: 9000 # Port to listen on, default 8080
smtp: # SMTP server that receives emails
host: "127.0.0.1" # Host to listen on, default ''
port: 1025 # Port to listen on, default 1025
size: 26214400 # Max allowed size of email in bytes, default 26214400 (25 MiB)
auth: true # Enable auth, default 'false'
username: user # Default ''
password: 12345678 # Default ''
bridges: # Bridges modify and check if messages should be sent to endpoints
- name: test bridge
filters:
- to: foo@example.com # Filter based on to address
to_regex: "foo" # To regex takes priority over to, must be surrounded by quotation marks
from: bar@example.com # Filter based on from address
from_regex: "bar" # From regex takes priority over from, must be surrounded by quotation marks
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 # Match a name in the endpoints list
endpoints: # Endpoints send messages to messaging services such as Telegram
- name: test endpoint
type: telegram
config:
token: 2222222222222222222222
chat_id: 111111111111111111111
- name: mock endpoint
type: mock # This endpoints prints out the message to console
Usage
smtpbridge server
Todo
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.
Source Files
Directories