Using MailSlurper - mailslurper/mailslurper GitHub Wiki

Once you've installed and configured MailSlurper open your favorite browser to the URL and port you've configured MailSlurper to run on. In this section we will assume that you are running MailSlurper on your local machine on port 8080. Go ahead and open http://localhost:8080. You should be presented with a screen that looks like this.

Main Interface

Header

At the very top of the window is the header area.

Close-up of Header

The header has three main components:

  1. Primary Navigation
  2. Action Buttons
  3. Information Button

Primary Navigation

The Primary Navigation contains links to move around MailSlurper. There are three buttons found at the top that make up this navigation. The Home Button takes you to your list of captured emails. This is where you will spend most of your time. The Filter Button will navigate to the the Saved Searches page. Here you can manage any search filter sets you have saved. The last button is the Configuration Button, which will take you to the configuration page. Here you can alter some of the basic behaviors of MailSlurper.

Action Buttons

There are two action buttons: Refresh and Search. The refresh button does exactly as advertised. When pressed it will reload the email list view and display any new emails captured. The search button will present a dialog that allows you to filter the email list view using a number of search controls. See Searching For Mail for more details on searching and filtering the email list view.

Information Button

The Information Button, when clicked, will pop up an information bubble that displays data about what emails you are currently viewing.

Information Bubble

In the above screenshot you can see that we are viewing email that meet the following criteria:

  • We are on page 1 of our search results
  • We are viewing emails that have a subject or message body that contain the text Text
  • We are viewing emails that were sent between March 1st and March 31st 2016

Email List View

Just below the Action Buttons is the email list view. Here is where you see all emails captured by MailSlurper.

Close-up of Email List View

Emails displayed here are show in decending order by the date the email was sent. This view shows, at a glance, the date sent, the subject of the email, and the email address of the sender. If an email has one or more attachments a paperclip icon is displayed to the left of the sent date. Up to 50 emails are shown at a time. If there are more pages of emails to view a set of paging navigation buttons will be displayed below the email list.

Paging Navigation Buttons

Email Detail View

Clicking on subject of an email will load the details of that email and display them in the Email Detail View.

Close-up of Email Detail View

This view will display who the email was sent to, who sent the email, and what the subject is. If there are any attachments those are displayed as clickable links. Clicking on an attachment will attempt to open it. Image attachments are displayed in a nifty shadowbox. All other attachment types are either opened by your browser, or downloaded. Finally the remaining area contains the body of the email. MailSlurper is able to parse and display text-based email, HTML-based email, and multipart text and HTML emails. When an email is multipart text and HTML, the HTML version is displayed.

Up next:

Searching For Mail