Defineware
Games · Tools · Merch

Mailman

No request selected

application/json

      
    

  

  

How to Use Mailman

Mailman is a lightweight API testing and request-building tool designed to help developers quickly send HTTP requests, inspect responses, and organize API workflows. Similar to other API clients, Mailman allows you to build requests, store them in collections, and test APIs directly from your browser.

1. Create or Select a Collection

Collections allow you to organize multiple API requests into logical groups. Click "+ Collection" in the sidebar to create a new one, then add requests inside that collection for easier management.

2. Add a Request

Click "+ Request" to create a new API request. Give it a name and assign it to the collection you want to keep it in. This helps keep your API testing workflow organized.

3. Configure the Request

Select the appropriate HTTP method such as GET, POST, PUT, PATCH, or DELETE. Then enter the API endpoint URL in the request field.

4. Add Authentication (Optional)

If the API requires authentication, choose an auth method such as Bearer Token or Basic Auth. Enter the required credentials in the fields that appear.

5. Set Headers

Headers allow you to provide additional request information such as Content-Type, authorization tokens, or custom API headers. Enter a key and value and click Add to include it in the request.

6. Define the Request Body

For POST, PUT, or PATCH requests you may need to include data in the body. Mailman supports multiple formats including:

Select the format from the dropdown and enter your data in the editor.

7. Use Environments

Environments allow you to store variables such as API keys, base URLs, or tokens. Use variables inside requests using the syntax {{variable}}. This makes it easy to switch between development, staging, and production APIs.

8. Send the Request

Click the Send button to execute the API request. The response will appear below showing the returned data, status, and response time.

9. View and Format Responses

Mailman automatically detects response types and lets you view them in multiple modes:

10. Generate Code

Mailman can generate code snippets for your requests. Select the desired language such as cURL, PHP (cURL), or .NET HttpClient, then click Generate. This allows you to quickly copy working API code into your application.

Benefits of Using Mailman

Fast API Testing

Quickly send HTTP requests and inspect responses without writing temporary scripts. Mailman provides a streamlined interface for testing endpoints during development.

Organized API Workflows

With collections and saved requests, you can keep your API testing structured and easily revisit important endpoints.

Environment Variables

Environments allow you to store reusable variables like API keys or base URLs, making it easy to switch between development and production systems.

Multiple Body Formats

Mailman supports various request body formats including JSON, XML, HTML, and raw text, giving you flexibility when working with different APIs.

Instant Code Generation

Automatically generate working API request code in popular formats such as cURL, PHP, and .NET. This saves time and reduces the chance of mistakes when integrating APIs into your applications.

Readable Response Viewer

Responses can be viewed in formatted JSON, rendered HTML, or raw output, making debugging and data inspection easier.

Import and Export Support

Easily import or export collections and environment files to share with team members or migrate between systems.

Lightweight and Browser-Based

Mailman runs directly in the browser without requiring heavy installations, making it fast, portable, and convenient for everyday API testing.