https://github.com/yynet2022/mailorca
A lightweight SMTP server and web interface for development (Django, etc.) / 開発環境（Django等）向けの軽量SMTPサーバー兼Webインターフェースツール
https://github.com/yynet2022/mailorca
development-tools django email-testing fastapi flask mailhog-alternative python smtp-server
Last synced: 6 months ago
JSON representation
A lightweight SMTP server and web interface for development (Django, etc.) / 開発環境（Django等）向けの軽量SMTPサーバー兼Webインターフェースツール
- Host: GitHub
- URL: https://github.com/yynet2022/mailorca
- Owner: yynet2022
- License: mit
- Created: 2025-12-31T04:11:27.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-01-04T02:26:29.000Z (6 months ago)
- Last Synced: 2026-01-06T03:00:22.552Z (6 months ago)
- Topics: development-tools, django, email-testing, fastapi, flask, mailhog-alternative, python, smtp-server
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MailOrca 🐋
MailOrca is a lightweight SMTP server and Web interface tool designed for development environments.
It was created for developers who want to complete tasks like MailHog using only the Python ecosystem.
It is perfect for testing email sending locally when developing Web applications such as Django or Flask.
## Features
* **Python Native**: Works with Python 3.9+ only. It can be introduced with just `pip` in environments without Go or Docker.
* **Web UI**: You can instantly check received emails in your browser. Switching between HTML/Text parts and downloading raw `.eml` files is also possible.
* **Simple SMTP Server**: An asynchronous SMTP server based on `aiosmtpd` receives emails from your application.
* **Configurable**: Port numbers and display items can be flexibly configured via `config.json`.
* **REST API**: A JSON API is also provided for accessing email data.
## Requirements
* Python 3.9 or higher
## Installation
1. Clone the repository.
```bash
git clone https://github.com/yynet2022/mailorca.git
cd mailorca
```
2. Install dependencies.
```bash
pip install -r requirements.txt
```
## Usage
### Startup
Start the server with the following command:
```bash
python runserver.py
```
You can also override settings with command-line arguments or environment variables.
```bash
# Show help
python runserver.py --help
# Example starting with changed port numbers
python runserver.py --smtp-port 2025 --http-port 8080
# Start with detailed logging (-v 1: INFO, -v 2: DEBUG)
python runserver.py -v 2
```
#### Configuration via Environment Variables
It is also possible to configure using environment variables instead of arguments (using the prefix `MAILORCA_`).
* `MAILORCA_SMTP_PORT=2025`
* `MAILORCA_HTTP_PORT=8080`
By default, it listens on the following ports:
* **SMTP Server**: `127.0.0.1:1025`
* Set your application's email sending configuration (Host/Port) to this.
* **Web UI**: `http://127.0.0.1:8025`
* Access via browser to check received emails.
### Configuration
You can change settings by editing `config.json`.
```json
{
"smtp": {
"host": "127.0.0.1",
"port": 1025
},
"http": {
"host": "127.0.0.1",
"port": 8025
},
"max_history": 100,
"ui": {
"list_columns": ["Date", "Subject", "To", "From"],
"detail_headers": ["From", "To", "Cc", "Subject", "Date", "Message-ID"]
}
}
```
* `smtp`, `http`: Specify host and port. Specify `"0.0.0.0"` to allow access from outside.
* `max_history`: Maximum number of emails to keep in memory. Older emails are deleted when this limit is exceeded.
* `ui`: You can customize header items displayed in the Web UI list and detail screens.
## License
This software is released under the [MIT License](LICENSE).
---
# MailOrca 🐋 (日本語)
MailOrca は、開発環境向けの軽量な SMTP サーバー兼 Web インターフェースツールです。
MailHog のようなツールを Python エコシステムだけで完結させたい開発者のために作られました。
Django や Flask などの Web アプリケーション開発時に、ローカルでメール送信テストを行うのに最適です。
## 特徴
* **Python Native**: Python 3.9+ だけで動作します。Go や Docker がない環境でも `pip` だけで導入可能です。
* **Web UI**: 受信したメールをブラウザで即座に確認できます。HTML/Text パートの切り替えや、生の `.eml` ダウンロードも可能です。
* **Simple SMTP Server**: `aiosmtpd` をベースにした非同期 SMTP サーバーが、アプリケーションからのメールを受け取ります。
* **Configurable**: ポート番号や表示項目は `config.json` で柔軟に設定可能です。
* **REST API**: メールデータにアクセスするための JSON API も提供しています。
## 動作要件
* Python 3.9 以上
## インストール
1. リポジトリをクローンします。
```bash
git clone https://github.com/yynet2022/mailorca.git
cd mailorca
```
2. 依存パッケージをインストールします。
```bash
pip install -r requirements.txt
```
## 使い方
### 起動
以下のコマンドでサーバーを起動します。
```bash
python runserver.py
```
コマンドライン引数や環境変数で設定を上書きすることも可能です。
```bash
# ヘルプを表示
python runserver.py --help
# ポート番号を変更して起動する例
python runserver.py --smtp-port 2025 --http-port 8080
# 詳細なログを出力して起動 (-v 1: INFO, -v 2: DEBUG)
python runserver.py -v 2
```
#### 環境変数による設定
引数の代わりに環境変数で設定することも可能です（プレフィックス `MAILORCA_` を使用）。
* `MAILORCA_SMTP_PORT=2025`
* `MAILORCA_HTTP_PORT=8080`
デフォルトでは以下のポートで待機します。
* **SMTP Server**: `127.0.0.1:1025`
* 開発中のアプリケーションのメール送信設定（Host/Port）をここに合わせます。
* **Web UI**: `http://127.0.0.1:8025`
* ブラウザでアクセスして受信メールを確認します。
### 設定
`config.json` を編集することで設定を変更できます。
```json
{
"smtp": {
"host": "127.0.0.1",
"port": 1025
},
"http": {
"host": "127.0.0.1",
"port": 8025
},
"max_history": 100,
"ui": {
"list_columns": ["Date", "Subject", "To", "From"],
"detail_headers": ["From", "To", "Cc", "Subject", "Date", "Message-ID"]
}
}
```
* `smtp`, `http`: ホストとポートを指定します。外部からアクセスさせる場合は `"0.0.0.0"` を指定してください。
* `max_history`: メモリ上に保持するメールの最大件数です。これを超えると古いものから削除されます。
* `ui`: Web UI の一覧や詳細画面に表示するヘッダー項目をカスタマイズできます。
## ライセンス
本ソフトウェアは [MIT License](LICENSE) の下で公開されています。