1. Introduction
  2. User Guide
  3. 1. Intended Usage
  4. 2. Installation
    1. 2.1. Docker
    2. 2.2. Linux Packages
  5. 3. Integration
    1. 3.1. Mail Routing
    2. 3.2. HTTP Proxies
  6. 4. User Interface
  7. Reference Guide
  8. 5. Configuration
    1. 5.1. Global
    2. 5.2. SMTP Service
    3. 5.3. POP3 Service
    4. 5.4. Web Interface
    5. 5.5. Mail Storage
  9. 6. Extending Inbucket
  10. 7. REST API
    1. 7.1. List Mailbox Contents
    2. 7.2. Get Message
    3. 7.3. Get Message Source
    4. 7.4. Delete Message
    5. 7.5. Purge Mailbox
  11. 8. Lua API
    1. 8.1. Logging from Lua
    2. 8.2. Events
      1. 8.2.1. Before MAIL FROM Accepted
      2. 8.2.2. Before RCPT TO Accepted
      3. 8.2.3. Before Message Stored
      4. 8.2.4. After Message Stored
      5. 8.2.5. After Message Deleted
  12. 9. Go API

[DRAFT] Inbucket Documentation

REST API

Allows clients to retrieve, and delete the contents of mailboxes and messages.

Clients

  • Go: https://godoc.org/github.com/inbucket/inbucket/pkg/rest/client
  • Java: https://github.com/stepstone-tech/inbucket-java-client
  • Node.js: https://github.com/Xotabu4/inbucket-js-client
  • Shell: https://github.com/inbucket/inbucket/blob/master/etc/rest-apiv1.sh

API v1

  • List Mailbox Contents: GET /api/v1/mailbox/{name}
  • Get Message: GET /api/v1/mailbox/{name}/{id}
  • Get Message Source: GET /api/v1/mailbox/{name}/{id}/source
  • Delete Message: DELETE /api/v1/mailbox/{name}/{id}
  • Purge Mailbox Contents: DELETE /api/v1/mailbox/{name}