ImapFlow Documentation

Official documentation for ImapFlow, a modern IMAP client library for Node.js.

This documentation site is built using Docusaurus, a modern static website generator.

Installation

npm install

Local Development

npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Serve

Test the production build locally:

npm run serve

Documentation Structure

docs/
├── intro.md                          # Introduction page
├── getting-started/
│   ├── installation.md               # Installation guide
│   └── quick-start.md                # Quick start guide
├── guides/
│   ├── basic-usage.md                # Basic concepts and usage
│   ├── configuration.md              # Configuration options
│   ├── fetching-messages.md          # Message fetching guide
│   └── mailbox-management.md         # Mailbox operations
├── api/
│   └── imapflow-client.md            # API reference
└── examples/
    └── fetching-messages.md          # Code examples

Contributing

To add new documentation:

1. Create a new markdown file in the appropriate directory
2. Add frontmatter with sidebar_position and other metadata
3. Update sidebars.ts if needed (or use autogenerated sidebars)
4. Run npm run build to verify there are no broken links

Deployment

For GitHub Pages deployment:

GIT_USER=<Your GitHub username> npm run deploy

Or using SSH:

USE_SSH=true npm run deploy

License

Documentation is licensed under MIT License, same as ImapFlow.

Links

• ImapFlow GitHub Repository
• ImapFlow on npm
• EmailEngine