@@ -11,6 +11,20 @@ Bridge email to other messaging services.
11
11
12
12
[ ![ Screenshot] ( https://static.gurnain.com/github/smtpbridge/demo-small.png )] ( https://static.gurnain.com/github/smtpbridge/demo.png )
13
13
14
+ # Features
15
+
16
+ - Envelopes that contain subject, from, to, text, html, and attachments of an email
17
+ - Endpoints for sending envelopes
18
+ - Rules for matching envelopes
19
+ - SMTP server that creates envelopes
20
+ - HTTP server
21
+ - Create, view, and delete envelopes
22
+ - View and test endpoints
23
+ - Create, view, update, and delete rules
24
+ - Authentication for HTTP and SMTP servers
25
+ - Retention policy for deleting old envelopes
26
+ - Healthcheck for monitoring
27
+
14
28
# Use Cases
15
29
16
30
- Pictures from IP cameras
@@ -27,6 +41,12 @@ It is recommended to delete `smtpbridge_data` on every minor release and also ch
27
41
smtpbridge
28
42
```
29
43
44
+ ## Show Help
45
+
46
+ ```
47
+ smtpbridge -help
48
+ ```
49
+
30
50
## Show Version
31
51
32
52
```
@@ -93,7 +113,7 @@ rules:
93
113
debug: false
94
114
95
115
# Used by HTTP, ...
96
- time_format: 12h # ( 12h, 24h)
116
+ time_format: 12h # [ 12h, 24h]
97
117
98
118
# Directory for storing data
99
119
data_directory: smtpbridge_data
@@ -105,51 +125,51 @@ python_executable: python3
105
125
# You can use a third party service such as healthchecks.io
106
126
healthcheck:
107
127
# URL to fetch, empty means health checking is disabled
108
- url: "" # ( https://hc-ping.com/cb8bcf81-d3c4-4c98-85a6-734c3b7ddb2b, ...)
128
+ url: "" # [ https://hc-ping.com/cb8bcf81-d3c4-4c98-85a6-734c3b7ddb2b, ...]
109
129
110
130
# Interval between each fetch
111
- interval: 5m # ( 5m, 5h45m, ...)
131
+ interval: 5m # [ 5m, 5h45m, ...]
112
132
113
133
# Run on startup
114
134
startup: false
115
135
116
136
# Retention policy will delete resources that pass the configured policy
117
137
retention:
118
138
# Envelopes in database
119
- envelope_count: # ( 0, 100, 250, ...)
120
- envelope_age: # ( 5m, 5h45m, ...)
139
+ envelope_count: # [ 0, 100, 250, ...]
140
+ envelope_age: # [ 5m, 5h45m, ...]
121
141
122
142
# Attachment files in file store
123
- attachment_size: # ( 100 MB, 1 GB, ...)
143
+ attachment_size: # [ 100 MB, 1 GB, ...]
124
144
125
145
# Traces in database
126
- trace_age: 168h # 7 days ( 5m, 5h45m, ...)
146
+ trace_age: 168h # 7 days [ 5m, 5h45m, ...]
127
147
128
148
# HTTP server
129
149
http:
130
150
disable: false
131
- host: "" # ( 127.0.0.1, ...)
151
+ host: "" # [ 127.0.0.1, ...]
132
152
port: 8080
133
153
134
154
# Authentication is disabled if both username and password are empty
135
155
username: ""
136
156
password: ""
137
157
138
158
# Public URL
139
- url: "" # ( http://127.0.0.1:8080, ...)
159
+ url: "" # [ http://127.0.0.1:8080, ...]
140
160
141
161
# SMTP server
142
162
smtp:
143
163
disable: false
144
- host: "" # ( 127.0.0.1, ...)
164
+ host: "" # [ 127.0.0.1, ...]
145
165
port: 1025
146
166
147
167
# Authentication is disabled if both username and password are empty
148
168
username: ""
149
169
password: ""
150
170
151
171
# Maximum payload size
152
- max_payload_size: 25 MB
172
+ max_payload_size: 25 MB # [100 MB, 1 GB, ...]
153
173
154
174
# Endpoints for envelopes
155
175
endpoints:
0 commit comments