https://github.com/purplesyringa/ZeroMailProxy

SMTP/POP3 protocol for ZeroMail
https://github.com/purplesyringa/ZeroMailProxy

mail p2p pop3 smtp zeromail zeronet

Last synced: 3 months ago
JSON representation

SMTP/POP3 protocol for ZeroMail

• Host: GitHub
• URL: https://github.com/purplesyringa/ZeroMailProxy
• Owner: purplesyringa
• Created: 2018-01-01T09:11:29.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-10T18:13:40.000Z (over 7 years ago)
• Last Synced: 2024-10-24T16:50:06.245Z (7 months ago)
• Topics: mail, p2p, pop3, smtp, zeromail, zeronet
• Language: Python
• Homepage:
• Size: 378 KB
• Stars: 12
• Watchers: 6
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ZeroMailProxy

A fast, lightweight server for [ZeroMail](https://github.com/HelloZeroNet/ZeroMail), written in Python.

## TODO

1. Usable command line client

2. ~~Start POP3 and SMTP server in one process~~

3. ~~HTML/Markdown not handled~~

4. ~~Support HELO and VRFY~~

5. ~~SMTP server~~

6. ~~May be problems with multipart~~

7. ~~Command-line client~~

8. ~~Publish changes~~

9. ~~Automatically create secrets~~

10. ~~Sign changes~~

11. ~~Send message not only to yourself~~

12. ~~POP3 server~~

## Installation and usage

Linux:

```bash

$ git clone https://github.com/imachug/ZeroMailProxy

$ cd ZeroMailProxy

$ vi config.py

$ pip install -r requirements.txt

$ sudo python start_server.py # Run local POP3 and SMTP servers

```

Windows:

```

> git clone https://github.com/imachug/ZeroMailProxy

> cd ZeroMailProxy

> notepad config.py

> pip install -r requirements.txt

> python start_server.py # Run local POP3 and SMTP servers

```

## Local servers

POP3 and SMTP servers are ready out-of-box. To use them, configure your mail client to use `localhost:110` with login `local` and password `local` for POP3 and `localhost:587` with the same login/password for SMTP.

## Example for Windows Mail client

1. Run POP3 server

2. Run Windows Mail  

![Windows Mail](images/winmail/1.png)  

3. Press *Accounts* and then *+ Add account*

4. Scroll to very bottom and choose *Advanced setup*  

![Advanced setup](images/winmail/2.png)  

5. Choose *Internet email*  

![Internet email](images/winmail/3.png)  

6. Set:  

![1](images/winmail/4.png)  

    - *Email address* to `@zeroid.bit`

    - *User name* to `local`

    - *Password* to `local`

    - *Account name* to anything you want  

![2](images/winmail/5.png)  

    - *Send your messages using this name* to `local`

    - *Incoming email server* to `localhost`

    - *Account type* to `POP3`

    - *Outgoing (SMTP) email server* to `localhost`  

![3](images/winmail/6.png)  

    - Uncheck *Require SSL for incoming email*

    - Uncheck *Require SSL for outgoing email*

7. Press *Sign in*

8. Press *Done*  

![Done](images/winmail/7.png)

9. Wait until your mail is synchronized

## Example for ThunderBird

1. Run POP3 server

2. Run SMTP server

3. Open ThunderBird  

![ThunderBird](images/thunderbird/1.png)  

4. Open *Menu* -> *Options* -> *Account Settings*  

![ThunderBird](images/thunderbird/2.png)  

5. Press *Account Actions* -> *Add Mail Account...*  

![ThunderBird](images/thunderbird/3.png)  

6. Set *Your name* to anything you want, *Email address* to `@zeroid.bit`, *Password* to `local` and press `Continue`  

![ThunderBird](images/thunderbird/4.png)  

7. ThunderBird will try to configure everything manually - stop that by pressing *Manual config*

8. Set:

    - *Incoming* to `POP3 | localhost | 110 | None | Normal password`

    - *Outgoing* to `SMTP | localhost | 587 | None | Normal password`

    - *Username* to `local | local`  

![ThunderBird](images/thunderbird/5.png)  

9. Press *Re-test* and then *Done*

10. Accept warning  

![ThunderBird](images/thunderbird/6.png)  

11. Close menu and press *Get messages*

## Command-line client

1. Run `python send.py`

2. Type subject and body

3. Set recipient (make sure you ZeroMail'ed them before)

4. Wait for signing and publishing

Or run `python main.py` to read mail.

### Example session

```bash

$ python send.py

ZeroID: 1Cy3ntkN2GN9MH6EaW6eHpi4YoRS2nK5Di

Private key: 5KVc********************************************AjX

Subject:Test

Body: (empty line finishes)

Testing!

Recipient (e.g. gitcenter):gitcenter

$

```

## Using public/private key not from `users.json`

If you don't want to let ZeroMailProxy read your `users.json`, you can pass `:` as login and `` as password.

You can get your `` by visiting `zeroid.bit`, opening sidebar and searching for `UNIQUE ADDRESS`.

You can get your `` by visiting `ZeroNet/data/1MaiL5gfBM1cyb4a8e3iiL8L5gXmoAJu27/data/users//data.json` and searching for `"publickey": ""`.

You can get your `` by visiting `ZeroNet/data/users.json`, searching for `"1MaiL5gfBM1cyb4a8e3iiL8L5gXmoAJu27": {` and `"encrypt_privatekey_...": ""`.