Documentation

General usage

1. Please see the help and FAQ document

Installation

For installation instructions please consult the web : https://github.com/stephen-kruger/bluebox

REST API

1. For direct integration with test automation, the following REST calls may be used to reduce dependancy on UI

   List user emails

   This method lists all the emails for a particular email address, of the specified state
   
   http://[hostname]/[bluebox context]/jaxrs/inbox/list/[email]/[0=ANY, 1=NORMAL, 2=DELETED]/
   
   

   								
   [{
      "Uid": "bd222e31-e3a2-42fd-a6a1-6b27b75ce53d",
      "Sender": "Display Name <test@test.com>",
      "Subject": "Mail Subject",
      "Received": "8\/8\/14 2:06 AM",
      "State": 1,
      "Inbox": "recipient@test.com",
      "Size": "21K"
   }]
   								
   								

   
   

   List email detail

   This method lists the details of a particular email message specified by the UID
   
   http://[hostname]/[bluebox context]/jaxrs//message/detail/[Uid]
   
   

   								
   {
   	"Attachment":[null],
   	"Uid":"bd222e31-e3a2-42fd-a6a1-6b27b75ce53d",
   	"Recipient":["recipient@email.com"],
   	"Cc":[],
   	"Sender":["no-reply@email.com"],
   	"Subject":"User - Your ......",
   	"Inbox":"email@email.com",
   	"Received":"08\/08\/14 02:06","State":1,"Size":"21",
   	"HtmlBody":"...",
   	"TextBody":"...",
   	"Security":"..."
   }
   								
   								

   
   

   Get email html content links

   This method parses the email html body (if it exists) and returns any links found
   
   http://[hostname]/bluebox/jaxrs/message/links/[Uid]
   
   

   								
   {
   	"links":[
   		{
   			"text":"https:\/\/xxx.com...ale=en_US",
   			"data":"",
   			"href":"https:\/\/xxx.com...ale=en_US"
   		},
   		{
   			"text":"support@xxx.com",
   			"data":"",
   			"href":"mailto:support@xxx.com"
   		},
   		{
   			"text":"http:\/\/www.xxx.com\/social",
   			"data":"",
   			"href":"http:\/\/www.xxx.com\/social"
   		}
   	]
   }
   								
   								

   
   

Feeds

1. Feeds can be passed a "type" parameter to specify the feed protocol
2. Can be one of : rss_0.91N,rss_0.93,rss_0.92,rss_1.0,rss_0.94,rss_2.0,rss_0.91U,rss_0.9,atom_1.0 or atom_0.3
3. e.g. http://<bluebox-server>/bluebox/feed/inbox?type=atom_1.0&email=steve@test.com