Mailtrap Documentation

Official documentation for Mailtrap — Email Delivery Platform for individuals and businesses to test, send, and control email infrastructure in one place.

Live docs: docs.mailtrap.io

Repository Structure

This repository contains three documentation spaces:

Directory	Description
documentation/	Product documentation — setup guides, features, email sending, sandbox testing
api-docs/	API reference — endpoints, SDKs, authentication, code examples
guides-and-tips/	How-to guides — DNS setup, integrations, migration guides

Technology

Documentation is built with GitBook and synced via GitBook's GitHub integration.

Contributing

We welcome contributions to improve our documentation.

Making Changes

1. Fork this repository
2. Create a branch for your changes
3. Make your edits following the formatting guidelines below
4. Submit a pull request

Formatting Guidelines

• Use YAML frontmatter for page titles and descriptions
• Follow GitBook markdown syntax for special blocks (hints, tabs, code)
• Place images in the .gitbook/assets/ directory within the relevant space
• Update SUMMARY.md when adding new pages

Local Preview

Changes are previewed through GitBook's integration. For immediate feedback, you can view rendered markdown in any markdown editor.

Resources

• Mailtrap Website
• Mailtrap Blog
• API Documentation

License

This documentation is licensed under CC BY-SA 4.0.