remiges-smtp

SMTP client with file scraping capabilities

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Tutorial
5. FAQ
6. Roadmap
7. Contributing
8. License
9. Contact
10. Acknowledgments

Directory structure

/remiges-smtp
├── config                 # Location to be used to store
├── docker-compose.yml     # Docker Compose configuration for smtpclientd
├── Dockerfile.smtpclientd # Dockerfile that compiles the application
├── output                 # Location to be used to record output
├── README.md              # Default README.md
├── testdata               # Location to be used to hold data
└── doc                    # Document directory
  ├── FAQ.md               # Frequently Asked Questions
  ├── QUICKSTART.md        # QuickStart Guide
  ├── TUTORIAL.md          # Tutorial Document
  └── USAGE.md             # Document providing usage information

About The Project

Remiges SMTP is a powerful SMTP client that can:

• Read and process files from directories
• Format them as RFC-compliant emails
• Sign messages with DKIM
• Connect to mail servers and send emails
• Record results in CSV format

Built With

The following software were used to build this project and application:

• Bazel Bazel is used to build and run the application.
• Cobra
• Viper
• Zerolog
• mox

(back to top)

Getting Started

See QUICKSTART.md

(back to top)

Installation

1. Clone the repo

   git clone https://github.com/stlimtat/remiges-smtp.git

(back to top)

Usage

See USAGE.md

(back to top)

Tutorial

See TUTORIAL.md

(back to top)

FAQ

See FAQ.md

(back to top)

Roadmap

• Write initial smtp client
• Provide gen dkim tool that helps provide DNS TXT entry and config
• Update README to allow users to use

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

We welcome contributions! Please see our Contributing Guide for details.

(back to top)

License

Distributed under the MIT License. See LICENSE.MIT for more information.

(back to top)

Contact

Project Link: https://github.com/stlimtat/remiges-smtp

(back to top)

Acknowledgments

(back to top)