eml2md 0.1.0

Convert EML files to Markdown
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

# eml2md

A fast, lightweight command-line tool to convert EML (email) files to Markdown format.

## Features

- **EML Parsing**: Parse standard EML files including headers (From, To, CC, Date, Subject) and body content
- **Multiple Formats**: Support for `simple` (plain text) and `html` output formats
- **Attachment Handling**: Embed inline images as base64 data URIs in the output
- **Clean Output**: Email metadata formatted as Markdown tables for easy reading

## Installation

### From Source

Requires [Rust](https://www.rust-lang.org/tools/install) (2024 edition).

```bash
git clone https://github.com/hydai/eml2md.git
cd eml2md
cargo build --release
```

The binary will be available at `target/release/eml2md`.

## Usage

```bash
eml2md -i <input.eml> -o <output.md> [-f <format>]
```

### Options

| Option | Description | Required | Default |
|--------|-------------|----------|---------|
| `-i, --input` | Input EML file path | Yes | - |
| `-o, --output` | Output Markdown file path | Yes | - |
| `-f, --format` | Output format (`simple` or `html`) | No | `simple` |

### Example

```bash
# Convert email to markdown
eml2md -i email.eml -o email.md

# Use HTML format
eml2md -i email.eml -o email.md -f html
```

### Output Format

The generated Markdown includes a metadata table and the email body:

```markdown
|||
|---|---|
|From|John Doe <john@example.com>|
|To|Jane Doe <jane@example.com>|
|CC||
|Date|2024-01-01 12:00:00|
|Subject|Meeting Notes|

Hello,

This is the email body content...
```

## Development

### Prerequisites

- Rust (2024 edition)
- Cargo

### Building

```bash
# Development build
cargo build

# Release build
cargo build --release
```

### Code Quality

```bash
# Run all checks
make all

# Individual checks
make lint     # Format check (cargo fmt --all --check)
make clippy   # Linter (cargo clippy --all-targets --all-features)
make build    # Build project
```

### Testing

```bash
cargo test
```

## Project Structure

```
eml2md/
├── src/
│   ├── main.rs          # CLI entry point
│   ├── lib.rs           # Library exports
│   ├── eml.rs           # EML parsing (Email, Header, Body, Attachment)
│   ├── content_type.rs  # MIME type parsing
│   └── formatter/
│       ├── mod.rs       # Formatter trait and factory
│       └── simple.rs    # SimpleFormatter & SimpleHtmlFormatter
├── tests/
│   └── example/         # Example EML files for testing
├── Cargo.toml
└── Makefile
```

## Dependencies

| Crate | Purpose |
|-------|---------|
| [clap](https://crates.io/crates/clap) | Command-line argument parsing |
| [mail-parser](https://crates.io/crates/mail-parser) | EML/MIME message parsing |
| [chrono](https://crates.io/crates/chrono) | Date/time handling |
| [base64](https://crates.io/crates/base64) | Base64 encoding for attachments |
| [anyhow](https://crates.io/crates/anyhow) | Error handling |
| [thiserror](https://crates.io/crates/thiserror) | Custom error types |

## License

Apache-2.0

## Author

[hydai](https://github.com/hydai)