API Guide

There are three tiers to the MailSlurper application: Web Server, Service Tier, and the SMTP Server. These tiers separate concerns as follows.

Web Server

This is the server for the user interface. All HTML pages and static assets are served from this tier. The web application is broken into three primary pages consisting of the email interface, the saved searches manager, and the settings page. Each of these pages makes heavy use of JavaScript when interacting with the interface. Subsequently JavaScript is used to perform activities such as retrieving email and paging by making AJAX calls to the Service Tier.

Service Tier

This tier is another HTTP server which offers RESTful style endpoints that facilitate tasks such as getting email collections, details, settings, and more. This tier is considered the API.

SMTP Server

This is the meat and potatoes of MailSlurper. The SMTP Server is responsible for listening on a port for incoming SMTP client connections, servicing those connections, and storing captured emails into your storage engine.

Table of Contents

• Email Endpoints
• Attachment Endpoints
• Seed Data Endpoints