Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhanya-abhirami/gomail
A simple client to send and receive emails.
https://github.com/dhanya-abhirami/gomail
dotenv go-gin golang jwt kafka middleware mongodb postman-collection restful-api swagger-ui
Last synced: 12 days ago
JSON representation
A simple client to send and receive emails.
- Host: GitHub
- URL: https://github.com/dhanya-abhirami/gomail
- Owner: Dhanya-Abhirami
- Created: 2022-03-24T18:34:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-17T07:54:12.000Z (over 2 years ago)
- Last Synced: 2025-01-25T17:15:21.902Z (12 days ago)
- Topics: dotenv, go-gin, golang, jwt, kafka, middleware, mongodb, postman-collection, restful-api, swagger-ui
- Language: Go
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GoMail
A simple client to send and receive emails.
## Backend
* Golang with gin
* MongoDB (remote DB based in mLab)
* Kafka
## Setting up
```bash
cd email-client/src
make build
make run
```
## File Structure
```
Model - For modelling entities
Routes - Controller
Handler - Service
Middleware - interceptor
Helper - Utils
```
## Requirements
### Fetch Inbox
The user should be able to fetch their inbox emails. The task is to create an endpoint “localhost:8080/user/mail/inbox” to fetch the inbox.
a. Choose appropriate HTTP methods (GET,POST,PUT,DELETE) to hit this URL.
b. There should be a key-value pair of “Authorization: ” & if it's incorrect or not present, the API should throw a Bad Request Exception with 401 Unauthorized code.
The username can be identified from the JWT_TOKEN.
c. In case the user name exists in the database we should fetch the inbox details sorted by date (descending order of date), as a response with appropriate HTTP status.
### Send Email API
The user should be able to send an email to another user.The task is to create an endpoint localhost:8080/user/mail/send to send an email to a user
a. Choose appropriate HTTP methods (GET,POST,PUT,DELETE) to hit this URL.
b. The user needs to provide the details of the email like (sender email address, list of receiver’s email address, subject line, email body) in the request body.
Basic validation on the attributes of the email needs to be performed with the following rules :
• Receiver Email address: It should be a valid email ID format
• Subject: It should be a minimum of 2 characters and a maximum of 100 characters
• Email Body: It should be a minimum of 10 chars and a maximum of 1500 characters
• Date: It should be sent as the current date
c. In case a user provides wrong input, they should get a message saying “Invalid Details” with the appropriate HTTP status.
d. In case the user provides the right set of inputs, the data should get stored in the database and we should get a response with a message “ Email sent successfully” with appropriate HTTP status.
### Fetch Outbox
The task is to create an endpoint “localhost:8080/user/mail/outbox” to fetch the outbox of a user.
a. Choose appropriate HTTP methods (GET, POST, PUT, DELETE) to hit this URL.
b. There should be a key-value pair of “Authorization: ” & if it's incorrect or not present, the API should throw a Bad Request Exception with 401 Unauthorized code.
c. The username of the user can be identified from the JWT_TOKEN.
d. In case the user name exists in the database we should fetch the outbox details sorted by date (descending order of date), as a response with appropriate HTTP status.