mms2mail/README.md

84 lines
2.5 KiB
Markdown
Raw Normal View History

2021-04-30 15:15:32 +00:00
# mms2mail
2021-05-11 14:52:27 +00:00
Mail bridge for mmsd.
2021-05-11 14:52:27 +00:00
mms2mail:
* convert incoming mms from mmsd to mail and store it in unix mbox.
* provide a smtp server converting mail to mms with mmsd.
By default:
* store mails in the current user mbox (```/var/mail/$USER```)
* in case the mbox is locked by another process the output could be found in ```$HOME/.mms/failsafembox```
* listen on localhost port 2525 for mail
2021-05-01 06:43:13 +00:00
2021-05-01 07:53:32 +00:00
## installation
2021-05-01 06:43:13 +00:00
### dependency
2021-05-01 06:43:13 +00:00
- python3
2021-05-11 14:52:27 +00:00
- python3-aiosmtpd
- python-messaging (pip install python-messaging)
2021-05-01 07:53:32 +00:00
### setup
2021-05-11 14:52:27 +00:00
Install the dependency and mms2mail (on debian based distribution):
2021-05-01 07:53:32 +00:00
```
2021-05-10 08:30:37 +00:00
sudo apt-get install python3
2021-05-11 14:52:27 +00:00
sudo apt-get install python3-aiosmtpd
pip install --user python-messaging
2021-05-01 07:53:32 +00:00
mkdir -p ~/.local/bin
cp mms2mail ~/.local/bin
```
To enable the daemon mode in systemd user :
```
mkdir -p ~/.config/systemd/user
cp mms2mail.service ~/.config/systemd/user/
systemctl --user daemon-reload
systemctl --user enable mms2mail
systemctl --user start mms2mail
```
2021-05-01 06:43:13 +00:00
2021-05-01 07:53:32 +00:00
### config
An optional configuration file can be put in the home folder : ```$HOME/.mms/modemmanager/mms2mail.ini```. The default value are :
2021-05-01 06:43:13 +00:00
```
[mail]
2021-05-01 07:53:32 +00:00
mailbox = /var/mail/$USER ; the mailbox where mms are appended
user = $USER ; the user account specified as recipient
domain = $HOSTNAME ; the domain part appended to phone number and user
attach_mms = false ; whether to attach the full mms binary file
2021-05-11 14:52:27 +00:00
[smtp]
hostname = localhost
port = 2525
2021-05-01 06:43:13 +00:00
```
2021-05-01 07:53:32 +00:00
## usage
2021-05-11 14:52:27 +00:00
### reference
```
2021-05-11 14:52:27 +00:00
mms2mail [-h] [-d | -f FILES [FILES ...]] [--disable-smtp] [--disable-mms-delivery] [--delete] [--force-read] [--force-unlock] [-l {critical,error,warning,info,debug}]
2021-05-01 07:53:32 +00:00
optional arguments:
-h, --help show this help message and exit
2021-05-11 14:52:27 +00:00
-d, --daemon start in daemon mode
-f FILES [FILES ...], --file FILES [FILES ...]
2021-05-11 14:52:27 +00:00
Start in batch mode, parse specified mms files
--disable-smtp
--disable-mms-delivery
--delete Ask mmsd to delete the converted MMS
--force-read Force conversion even if MMS is marked as read
2021-05-11 14:52:27 +00:00
--force-unlock BEWARE COULD LEAD TO WHOLE MBOX CORRUPTION Force unlocking the mbox after a few minutes /!\
2021-05-10 08:30:37 +00:00
-l {critical,error,warning,info,debug}, --logging {critical,error,warning,info,debug}
Define the logger output level
2021-05-11 14:52:27 +00:00
```
### Using with Mutt :
To be able to send mms with mutt you need it to be built with SMTP support.
And and the following line in your ```$HOME/.muttrc```:
```
set smtp_url = "smtp://localhost:2525"
set ssl_starttls = no
set ssl_force_tls = no
```