Mailcatlon API README

This Mailcatlon API serves as a backend for managing mailboxes, and messages.

Root Endpoint

    Route: /
    Description: Displays the API version and available routes.
    Like:

{
    "V1": "API operates under version .../v1",
    "status": 200
}

Version 1 (v1)

User Routes:

    Route: /v1/user
    Method: GET
    Description: Get details of the Admin.
    Like:

{
    "name": "John Doe",
    "email": "john@example.com"
}

Brand Routes:

    Route: /v1/brand
    Method: POST
    Description: You'll receive a list of accessible brands..
    Like:

{
    "info": "Proceed by appending the brand ID, like so: .../brand/1",
    "status": 200
}

Brand/{brand_id} Routes:

    Route: /v1/brand/{brand_id}
    Method: POST
    Description: You'll receive a list of accessible mailboxes.. then.../brand/x/mailbox/1/.
    Like:

{
    "info": "Proceed by appending the Mailbox ID, like so .../brand/x/mailbox/1/",
    "mailboxes for this brand": {
        "1": "Mailbox A",
        "2": "Mailbox B"
    },
    "status": 200
}

Mailbox Routes:

    Route: /v1/brand/{brand_id}/mailbox
    Method: POST
    Description: Append the mailbox ID to continue, like so: .../1/.
    Like:

{
    "info": "Append the mailbox ID to continue, like so: .../1/",
    "mailboxes for this brand": {
        "1": "Mailbox A",
        "2": "Mailbox B"
    },
    "status": 200
}

Message Routes:

    Route: /v1/brand/{brand_id}/mailbox/{mailbox_id}
    Method: POST
    Description: Use the prefix message/create to initiate message creation.
    Like:

{
    "info": "Use the prefix message/create to initiate message creation",
    "status": 200
}

   Route: /v1/brand/{brand_id}/mailbox/{mailbox_id}/message
   Method: POST
   Description: Provides message creation parameters.
   Like:

{
    "mail": {
        "to": "required",
        "subject": "required",
        "message": "required",
        "in_replay_to": "optional: The Mail Message_id"
    },
    "status": 200
}

Conclusion:

This concludes the documentation of the Mailcatlon API. For any queries or assistance, please contact the development team.