Optionally get message bodies along with metadata. #50

Author: Rustam Aliyev

itests/src/test/java/com/elasticinbox/itests/RestV2IT.java

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2011-2013 Optimax Software Ltd.
+ * Copyright (c) 2011-2014 Optimax Software Ltd.
  * All rights reserved.
  * 
  * Redistribution and use in source and binary forms, with or without
@@ -342,13 +342,29 @@ public void messageAddListViewDeletePurgeTest() throws IOException
 			body(messageId + ".to.address", hasItems(containsString("@"))).
 			body(messageId + ".replyTo.address", hasItems(containsString("@"))).
 			body(messageId + ".messageId", containsString("@elasticinbox")).
-			body(messageId + ".subject", is(notNullValue())).
+			body(messageId + ".subject", not(isEmptyOrNullString())).
+			body(messageId, not(hasKey("htmlBody"))).
+			body(messageId, not(hasKey("plainBody"))).
 			body(messageId, not(hasKey("bcc"))).
 		when().
 			get(REST_PATH + "/mailbox/label/{labelId}?metadata=true&count=2&start={messageId}");
 
 		logger.info("Message List with Metadata Test OK");
 
+		// check message list with bodies
+		messageId = messages.get("headers").toString();
+		given().
+			pathParam("labelId", labelId).
+			pathParam("messageId", messageId).
+		expect().
+			statusCode(200).and().
+			body(messageId + ".htmlBody", not(isEmptyOrNullString())).
+			body(messageId + ".plainBody", not(isEmptyOrNullString())).
+		when().
+			get(REST_PATH + "/mailbox/label/{labelId}?metadata=true&includebody=true&count=2&start={messageId}");
+
+		logger.info("Message List with Metadata & Bodies Test OK");
+
 		// check parsed message
 		messageId = messages.get("headers").toString();
 		given().

itests/src/test/resources/elasticinbox.yaml

@@ -38,7 +38,7 @@ database_driver: cassandra
 # Note: When no HTML message body available in HTML store mode, ElasticInbox
 # will automatically fallback to PLAIN text mode and store available PLAIN text.  
 store_html_message: true
-store_plain_message: false
+store_plain_message: true
 
 # Maximum blob size in bytes which can be stored in the database.
 # Blobs larger than this value will be stored with the deafult blob profile (blobstore_write_profile).

modules/core/src/main/java/com/elasticinbox/core/MessageDAO.java

@@ -120,10 +120,12 @@ public List<UUID> getMessageIds(Mailbox mailbox, int labelId, UUID start,
 	 *            Number of message IDs to retrieve.
 	 * @param reverse
 	 *            Defines order of the retrieval.
+	 * @param includeBody
+	 *            If true, return plainBody and htmlBody as a part of metadata.           
 	 * @return
 	 */
-	public Map<UUID, Message> getMessageIdsWithHeaders(Mailbox mailbox, int labelId,
-			UUID start, int count, boolean reverse);
+	public Map<UUID, Message> getMessageIdsWithMetadata(Mailbox mailbox, int labelId,
+			UUID start, int count, boolean reverse, boolean includeBody);
 
 	/**
 	 * Modify message labels and markers.

modules/core/src/main/java/com/elasticinbox/core/cassandra/CassandraMessageDAO.java

@@ -111,13 +111,13 @@ public BlobDataSource getRaw(final Mailbox mailbox, final UUID messageId)
 	}
 
 	@Override
-	public Map<UUID, Message> getMessageIdsWithHeaders(final Mailbox mailbox,
-			final int labelId, final UUID start, final int count, boolean reverse)
+	public Map<UUID, Message> getMessageIdsWithMetadata(final Mailbox mailbox,
+			final int labelId, final UUID start, final int count, boolean reverse, boolean includeBody)
 	{
 		List<UUID> messageIds = 
 				getMessageIds(mailbox, labelId, start, count, reverse);
 
-		return MessagePersistence.fetch(mailbox.getId(), messageIds, false);
+		return MessagePersistence.fetch(mailbox.getId(), messageIds, includeBody);
 	}
 
 	@Override

modules/pop3/src/main/java/com/elasticinbox/pop3/server/handler/ElasticInboxMailboxHandler.java

@@ -153,8 +153,8 @@ public InputStream getMessageHeaders(String uid) throws IOException
 	private List<MessageMetaData> getPOP3MessageList()
 	{
 		// get list of messages
-		Map<UUID, Message> messages = dao.getMessageIdsWithHeaders(
-				mailbox, ReservedLabels.POP3.getId(), null, MAX_POP3_SESSION_MESSAGES, true);
+		Map<UUID, Message> messages = dao.getMessageIdsWithMetadata(
+				mailbox, ReservedLabels.POP3.getId(), null, MAX_POP3_SESSION_MESSAGES, true, false);
 
 		// convert to James Protocols list
 		List<MessageMetaData> list = new ArrayList<MessageMetaData>(messages.size());

modules/rest/src/main/java/com/elasticinbox/rest/v2/LabelResource.java

@@ -105,6 +105,7 @@ public Response getMessages(
 			@PathParam("domain") String domain,
 			@PathParam("id") Integer labelId,
 			@QueryParam("metadata") @DefaultValue("false") boolean withMetadata,
+			@QueryParam("includebody") @DefaultValue("false") boolean includeBody,
 			@QueryParam("reverse") @DefaultValue("true") boolean reverse,
 			@QueryParam("start") UUID start,
 			@QueryParam("count") @DefaultValue("50") int count)
@@ -114,8 +115,8 @@ public Response getMessages(
 
 		try {
 			if (withMetadata) {
-				response = JSONUtils.fromObject(messageDAO.getMessageIdsWithHeaders(mailbox,
-						labelId, start, count, reverse));
+				response = JSONUtils.fromObject(messageDAO.getMessageIdsWithMetadata(mailbox,
+						labelId, start, count, reverse, includeBody));
 			} else {
 				response = JSONUtils.fromObject(messageDAO.getMessageIds(mailbox,
 						labelId, start, count, reverse));