API design

Sign Up API

Update User Details API

Endpoint: /api/v1/users/{userId}
Method: PUT
Headers: Authorization: Bearer <token>
Request Body (Example for updating profile):
{ "username": "newUsername", "email": "newEmail@example.com", "preferences": { "theme": "dark", "notifications": true }}
Response:
{ "message": "User details updated successfully"}

Send Email API

Endpoint: /api/v1/emails/send
Method: POST
Headers: Authorization: Bearer <token>
Request Body:
{ "to": ["recipient1@example.com", "recipient2@example.com"], "cc": ["cc@example.com"], "bcc": ["bcc@example.com"], "subject": "Subject of the email", "body": "Email body content", "attachments": ["base64_encoded_file_data"]}
Response:
{ "messageId": "uniqueMessageId", "status": "Email sent successfully"

Search Emails API

Endpoint: /api/v1/emails/search
Method: GET
Headers: Authorization: Bearer <token>
Query Parameters:
- query: String (e.g., subject:important)
- page: Integer (e.g., 1)
- size: Integer (e.g., 10)
Response:
{ "emails": [ { "messageId": "string", "from": "sender@example.com", "subject": "Subject", "summary": "Preview of the email body", "receivedAt": "timestamp" } ], "total": "integer", "page": "integer", "size": "integer"}