https://github.com/jcomo/smtpd-java

A server implementing the SMTP protocol
https://github.com/jcomo/smtpd-java

Last synced: 2 months ago
JSON representation

A server implementing the SMTP protocol

• Host: GitHub
• URL: https://github.com/jcomo/smtpd-java
• Owner: jcomo
• Created: 2015-12-29T20:02:22.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-30T04:01:25.000Z (about 9 years ago)
• Last Synced: 2023-08-05T21:05:38.221Z (over 1 year ago)
• Language: Java
• Size: 50.8 KB
• Stars: 8
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# smtpd ![](https://travis-ci.org/jcomo/smtpd.svg?branch=master)

A server implementing the SMTP protocol.

The server is useful for debugging at the moment.

In its current state, the server is only useful for development and debugging.

There is support for sending messages to stdout and to individual files on disk.

Auth and TLS support have not been implemented yet.

### Usage

Download the [pre-release jar](https://github.com/jcomo/smtpd/releases/download/0.1/smtpd.jar).

```

java -jar smtpd.jar

```

To test it, you can point your mail client (such as Apple mail) to the address it is running on, or you can interact with it via telnet.

A example SMTP interaction [from RFC 821](http://www.freesoft.org/CIE/RFC/821/31.htm) can be used.

### Configuration

A properties file can be specified as the first positional argument to the program. Available configuration values are

| Key                       | Default                     | Description                                                                   |

| ------------------------- | --------------------------- | ----------------------------------------------------------------------------- |

| `server.port`             | 8025                        | Port to run the server on                                                     |

| `server.hostname`         | contents of `/etc/hostname` | Hostname of the mail server                                                   |

| `server.shutdown.timeout` | 5                           | Time in seconds to wait for threads to finish before shutting down forcefully |

| `pool.connections.core`   | 0                           | Number of unused threads to keep in the server thread pool                    |

| `pool.connections.max`    | 1024                        | Max number of simultaneous connections to handle                              |

| `pool.idle.timeout`       | 60                          | Time in seconds until idle threads are destroyed                              |

| `mailer.type`             | `debug`                     | The type of Mailer to use for sending mail. See Mailer types below            |

| `mailer.file.directory`   | `/tmp/mail`                 | The directory to use for mail when using the file Mailer                      |

#### Mailer types

The value of `mailer.type` can be either `debug` or `file`. The debug mailer will "send" messages to stdout and the file mailer will write

all messages to unique files in the specified directory.

#### Configuring at Runtime

To override this configuration with runtime values, you can use command line properties. All configuration values can be overridden

by suppling the properties with the `smtpd.` prefix. For example, to override the port at runtime:

```

java -Dsmtpd.server.port=5025 -jar smtpd.jar

```