Rumsan Hulaak is an open-source, disposable email service designed to handle email reception on port 25. It is similar to Mailinator service. It comes with a robust REST API to manage email inboxes, making it ideal for testing and temporary email needs. With Hulaak, developers can seamlessly manage disposable email accounts and interact with inboxes via a simple API.
- Receive emails on port 25.
- Disposable email inboxes for testing and temporary use.
- Easy to manage email inboxes through a REST API.
- Manage domains and settings for email handling.
- Node.js
-
Clone the repository:
git clone https://github.com/rumsan/hulaak.git
-
Navigate to the project directory:
cd hulaak -
Install dependencies:
pnpm install
-
Set up environment variables: Create a
.envfile to configure the SMTP and database settings.Example
.envfile:PORT=3523 DATABASE_URL=file:../.data/db/hulaak.db
Run npx nx serve hulaak to start the development server.
Run npx nx build hulaak to build the application. The build artifacts are stored in the output directory (e.g. dist/ or build/), ready to be deployed.
We welcome contributions! Please follow these steps to contribute:
- Fork the repository.
- Create a feature branch (
git checkout -b feature/your-feature). - Commit your changes (
git commit -m 'Add your feature'). - Push to the branch (
git push origin feature/your-feature). - Open a pull request.
This project is licensed under the MIT License. See the LICENSE file for more details.