mail_grabber 1.0.0.rc1 → 1.2.0

data/lib/mail_grabber/web/assets/javascripts/dom.js

@@ -0,0 +1,86 @@
+var MailGrabberDOM = {
+  /**
+   * Change which content (message part) should show. When the page is loading,
+   * the HTML content will be active and the others will be hidden. When we
+   * click on tab e.g. Plain Text then this content will be active and other
+   * hidden.
+   *
+   * @param {Object} event - which part we clicked
+   */
+  changeMessageContent: function(event) {
+    var messageTabs =
+      document
+        .querySelectorAll('[data-message-tab]');
+
+    var messageContents =
+      document
+        .querySelectorAll('[data-message-content]');
+
+    var clickedTabType = event.target.dataset.messageTab;
+
+    messageTabs.forEach(function(messageTab, index) {
+      messageTab.classList.remove('active');
+      messageContents[index].classList.remove('hide');
+
+      if(messageTab.dataset.messageTab === clickedTabType) {
+        messageTab.classList.add('active');
+      }
+
+      if(messageContents[index].dataset.messageContent !== clickedTabType) {
+        messageContents[index].classList.add('hide');
+      }
+    });
+  },
+
+  /**
+   * Create a clone from an element, e.g. template tag.
+   *
+   * @param {String} selector - which describe how to find the element
+   *
+   * @return {Object} the clone of the found element
+   */
+  cloneContent: function(selector) {
+    return document.querySelector(selector).content.cloneNode(true);
+  },
+
+  /**
+   * Show default background image instead of any content.
+   */
+  defaultBackground: function() {
+    var messageContent =
+      document
+        .querySelector('div[data-content-type=message-content]');
+
+    messageContent.innerHTML = '';
+
+    messageContent.style.background =
+      "url('" + messageContent.dataset.backgroundImage +
+      "') center center no-repeat";
+    messageContent.style.backgroundSize = '50%';
+    messageContent.style.opacity = '10%';
+  },
+
+  /**
+   * Delete all content (message list and message content as well),
+   * set default background and the infinite scroll params when we click on
+   * the Reload or Delete tabs.
+   */
+  deleteContent: function() {
+    MailGrabberVariables.lastMessageId = -1;
+    MailGrabberVariables.page = 1;
+    MailGrabberDOM.defaultBackground();
+
+    document
+      .querySelector('ul[data-content-type=message-list]')
+      .innerHTML = '';
+  },
+
+  /**
+   * Root path, which returns with the server's root path. It can be an empty
+   * string or a string. It depends on how the server is running (standalone
+   * or in Ruby on Rails).
+   */
+  rootPath: function() {
+    return document.querySelector('body').dataset.rootPath;
+  }
+};

data/lib/mail_grabber/web/assets/javascripts/message_attachment.js

@@ -0,0 +1,36 @@
+var MailGrabberMessageAttachment = {
+  /**
+   * Render message attachment. Show the list of attachments at the top of the
+   * message content.
+   *
+   * @param {Object} messageAttachments - the message attachments container
+   * @param {Object} messagePart - a message part which we loaded
+   */
+  render: function(messageAttachments, messagePart) {
+    var messageAttachment = document.createElement('a');
+    var fileSize = document.createElement('span');
+    var messageAttachmentTemplate =
+      MailGrabberDOM
+        .cloneContent(
+          'template[data-content-type=message-attachment-template]'
+        );
+
+    messageAttachment.href =
+      'data:' + messagePart.mime_type + ';base64,' + messagePart.body;
+    messageAttachment.download = messagePart.filename;
+    messageAttachment.innerHTML = messagePart.filename;
+    messageAttachment.classList.add('color-black', 'no-text-decoration');
+
+    fileSize.innerHTML = MailGrabberUtilities.formatSize(messagePart.size);
+    fileSize.classList.add('color-gray', 'font-size-0_9', 'padding-left-10');
+
+    [messageAttachment, fileSize].forEach(function(node) {
+      messageAttachmentTemplate
+        .querySelector('li[data-content-type=message-attachment]')
+        .appendChild(node);
+    });
+
+    messageAttachments.classList.remove('hide');
+    messageAttachments.appendChild(messageAttachmentTemplate);
+  }
+};

data/lib/mail_grabber/web/assets/javascripts/message_content.js

@@ -0,0 +1,114 @@
+var MailGrabberMessageContent = {
+  /**
+   * Fill up the message content template with content.
+   *
+   * @param {Object} response - from the server with data
+   *
+   * @return {Object} the filled up template
+   */
+  fillUpTemplateWith: function(response) {
+    var message = response.message;
+    var messageParts = response.message_parts;
+    var messageContentTemplate =
+      MailGrabberDOM
+        .cloneContent('template[data-content-type=message-content-template]');
+
+    messageContentTemplate
+      .querySelector('div[data-content-type=message-subject]')
+      .innerHTML = message.subject;
+
+    MailGrabberMessageMetadata.render(
+      messageContentTemplate
+        .querySelector('dl[data-content-type=metadata]'),
+      message
+    );
+
+    messageContentTemplate
+      .querySelector('time[data-content-type=message-sent-at]')
+      .innerHTML = MailGrabberUtilities.formatDateTime(message.created_at);
+
+    messageContentTemplate
+      .querySelectorAll('[data-message-tab]')
+      .forEach(function(tab) {
+        tab.addEventListener('click', MailGrabberDOM.changeMessageContent);
+      });
+
+    messageContentTemplate
+      .querySelector('li[data-content-type=message-delete-tab]')
+      .addEventListener('click', function() {
+        MailGrabberApplication.deleteMessage(message.id);
+      });
+
+    messageContentTemplate
+      .querySelector('li[data-content-type=message-close-tab]')
+      .addEventListener('click', MailGrabberDOM.defaultBackground);
+
+    messageParts.forEach(function(messagePart) {
+      if(messagePart.is_attachment === 0 && messagePart.is_inline === 0) {
+        switch(messagePart.mime_type) {
+          case 'text/html':
+            MailGrabberVariables.messageHasHtmlPart = true;
+            MailGrabberMessageHtmlPart.render(
+              messageContentTemplate
+                .querySelector('iframe[data-content-type=message-html-body]'),
+              messageParts,
+              messagePart.body
+            );
+
+            break;
+          case 'text/plain':
+            messageContentTemplate
+              .querySelector('pre[data-content-type=message-text-body]')
+              .innerText = messagePart.body;
+
+            break;
+        }
+      } else if(messagePart.is_attachment === 1 &&
+                messagePart.is_inline === 0) {
+        MailGrabberMessageAttachment.render(
+          messageContentTemplate
+            .querySelector('ul[data-content-type=message-attachments]'),
+          messagePart
+        );
+      }
+    });
+
+    messageContentTemplate
+      .querySelector('pre[data-content-type=message-raw-body]')
+      .innerText = message.raw;
+
+    return messageContentTemplate;
+  },
+
+  /**
+   * Render the content of the message (all parts, inline attachments and
+   * attachments). Also, it sets up event listeners of the HTML, PlainText,
+   * Raw, Delete and Close tabs.
+   *
+   * @param {Object} response - the response of the get message request
+   */
+  render: function(response) {
+    var messageContent =
+      document
+        .querySelector('div[data-content-type=message-content]');
+
+    messageContent.removeAttribute('style');
+    messageContent.innerHTML = '';
+
+    MailGrabberVariables.messageHasHtmlPart = false;
+
+    messageContent.appendChild(
+      MailGrabberMessageContent.fillUpTemplateWith(response)
+    );
+
+    if(!MailGrabberVariables.messageHasHtmlPart) {
+      messageContent
+        .querySelector('li[data-message-tab=text]')
+        .click();
+
+      messageContent
+        .querySelector('li[data-message-tab=html]')
+        .classList.add('hide');
+    }
+  }
+};

data/lib/mail_grabber/web/assets/javascripts/message_html_part.js

@@ -0,0 +1,26 @@
+var MailGrabberMessageHtmlPart = {
+  /**
+   * Render the HTML part of the message. If the message has inline images,
+   * then it will render those images as well. An iframe will contain this
+   * content.
+   *
+   * @param {Object} iFrame - the iframe HTML tag
+   * @param {Object} messageParts - the parts of the message
+   * @param {Object} messageHtmlPart - the HTML part of the message
+   */
+  render: function(iFrame, messageParts, messageHtmlPart) {
+    var messageInlineAttachmentRegExp = new RegExp('cid:');
+
+    if(messageInlineAttachmentRegExp.test(messageHtmlPart)) {
+      messageHtmlPart =
+        MailGrabberMessageInlineAttachments.render(
+          messageParts, messageHtmlPart
+        );
+    }
+
+    iFrame.srcdoc = messageHtmlPart;
+    iFrame.onload = function() {
+      iFrame.height = iFrame.contentDocument.body.scrollHeight + 65;
+    }
+  }
+};

data/lib/mail_grabber/web/assets/javascripts/message_inline_attachments.js

@@ -0,0 +1,21 @@
+var MailGrabberMessageInlineAttachments = {
+  /**
+   * Render inline images of the message. Change the cid:something12345 with
+   * the encoded image content.
+   *
+   * @param {Object} messageParts - the parts of the message
+   * @param {Object} messageHtmlPart - the HTML part of the message
+   *
+   * @return {Object} messageHtmlPart - the modified HTML part of the message
+   */
+  render: function(messageParts, messageHtmlPart) {
+    messageParts.forEach(function(messagePart) {
+      if(messagePart.is_attachment === 1 && messagePart.is_inline === 1) {
+        messageHtmlPart = messageHtmlPart.replace('cid:' + messagePart.cid,
+          'data:' + messagePart.mime_type + ';base64,' + messagePart.body);
+      }
+    });
+
+    return messageHtmlPart;
+  }
+};

data/lib/mail_grabber/web/assets/javascripts/message_list.js

@@ -0,0 +1,54 @@
+var MailGrabberMessageList = {
+  /**
+   * Fill up the message list template with content.
+   *
+   * @param {Object} message
+   *
+   * @return {Object} the filled up template
+   */
+  fillUpTemplateWith: function(message) {
+    var messageListTemplate =
+      MailGrabberDOM
+        .cloneContent('template[data-content-type=message-list-template]');
+
+    messageListTemplate
+      .querySelector('li')
+      .addEventListener('click', function() {
+        MailGrabberApplication.getMessage(message.id);
+      });
+
+    messageListTemplate
+      .querySelector('div[data-content-type=message-senders]')
+      .innerHTML = message.senders;
+
+    messageListTemplate
+      .querySelector('time[data-content-type=message-sent-at]')
+      .innerHTML =
+        MailGrabberUtilities
+          .formatDateTime(message.created_at, 'messageListDateOrTime');
+
+    messageListTemplate
+      .querySelector('div[data-content-type=message-subject]')
+      .innerHTML = message.subject;
+
+    return messageListTemplate;
+  },
+
+  /**
+   * Render the list of the messages. Also add event listener when click on a
+   * message then it will load that content.
+   *
+   * @param {Object} messages - the list of the given message.
+   */
+  render: function(messages) {
+    var messageList =
+      document
+        .querySelector('ul[data-content-type=message-list]');
+
+    messages.forEach(function(message) {
+      messageList.appendChild(
+        MailGrabberMessageList.fillUpTemplateWith(message)
+      );
+    });
+  }
+};

data/lib/mail_grabber/web/assets/javascripts/message_metadata.js

@@ -0,0 +1,23 @@
+var MailGrabberMessageMetadata = {
+  /**
+   * Render senders and recipients data of the message.
+   *
+   * @param {Object} messageMetadata - the metadata container
+   * @param {Object} message - the requested message
+   */
+  render: function(messageMetadata, message) {
+    var metadata =
+      '<dt>From:</dt><dd>' + message.senders + '</dd>' +
+      '<dt>To:</dt><dd>' + message.recipients + '</dd>';
+
+    if(message.carbon_copy) {
+      metadata += '<dt>Cc:</dt><dd>' + message.carbon_copy + '</dd>';
+    }
+
+    if(message.blind_carbon_copy) {
+      metadata += '<dt>Bcc:</dt><dd>' + message.blind_carbon_copy + '</dd>';
+    }
+
+    messageMetadata.innerHTML = metadata;
+  }
+};

data/lib/mail_grabber/web/assets/javascripts/utilities.js

@@ -0,0 +1,65 @@
+var MailGrabberUtilities = {
+  /**
+   * Format the given date or time.
+   *
+   * @param {DateTime} dateTime - the message created at attribute
+   * @param {String} ouputType - what type we would like to see
+   *
+   * @return {String} the new format of the date or time
+   */
+  formatDateTime: function(dateTime, outputType) {
+    dateTime = new Date(dateTime);
+    var dateTimeNow = new Date();
+    // Sun Feb 21 2021 21:00:00 GMT+0100 (Central European Standard Time)
+    //  0   1  2   3      4        5         6       7        8      9
+    var dateTimeComponents = dateTime.toString().split(' ');
+    var output;
+
+    switch(outputType) {
+      case 'messageListDateOrTime':
+        if(dateTime.getDate() === dateTimeNow.getDate()) {
+          output = MailGrabberUtilities.formatTime(dateTimeComponents[4]);
+        } else if(dateTime.getFullYear() === dateTimeNow.getFullYear()) {
+          output = dateTimeComponents[1] + ' ' + dateTimeComponents[2];
+        } else {
+          output = dateTimeComponents[3] + ' ' + dateTimeComponents[1] + ' ' +
+            dateTimeComponents[2];
+        }
+
+        break;
+      default:
+        output = dateTimeComponents[3] + ' ' + dateTimeComponents[1] + ' ' +
+          dateTimeComponents[2] + ' - ' +
+          MailGrabberUtilities.formatTime(dateTimeComponents[4]);
+    }
+
+    return output;
+  },
+
+  /**
+   * Format the given number (attachment size).
+   *
+   * @param {Number} size - the size of the attachment in bytes
+   *
+   * @return {String} the formatted number with unit
+   */
+  formatSize: function(size) {
+    var exponent = (Math.log(size) / Math.log(1024)) | 0;
+    var number = +(size / Math.pow(1024, exponent)).toFixed(1);
+
+    return number + ' ' + ('KMGTPEZY'[exponent - 1] || '') + 'B';
+  },
+
+  /**
+   * Format the given time.
+   *
+   * @param {String} time
+   *
+   * @return {String} the new format of the time
+   */
+  formatTime: function(time) {
+    var timeComponents = time.split(':');
+
+    return timeComponents[0] + ':' + timeComponents[1];
+  }
+};

data/lib/mail_grabber/web/assets/javascripts/variables.js

@@ -0,0 +1,24 @@
+var MailGrabberVariables = {
+  /**
+   * The last message id what loaded. If it is -1 then we have no any
+   * messages.
+   */
+  lastMessageId: -1,
+
+  /**
+   * The message has HTML part or not.
+   */
+  messageHasHtmlPart: false,
+
+  /**
+   * The message is list reloading or not (click on the Reload tab).
+   */
+  messageListReloading: false,
+
+  /**
+   * Params that we can follow how many messages we have on the list. We are
+   * loading 15 messages in every request.
+   */
+  page: 1,
+  perPage: 15
+};

data/lib/mail_grabber/web/assets/javascripts/web.js

@@ -0,0 +1,6 @@
+(function() {
+  /**
+   * When DOM loaded, then call MailGrabber's init function.
+   */
+  document.addEventListener('DOMContentLoaded', MailGrabberApplication.init);
+})();

data/lib/mail_grabber/web/views/index.html.erb

@@ -11,6 +11,16 @@
     <link rel="stylesheet" href="<%= root_path %>/stylesheets/application.css" type="text/css" charset="utf-8">
 
     <script src="<%= root_path %>/javascripts/application.js"></script>
+    <script src="<%= root_path %>/javascripts/dom.js"></script>
+    <script src="<%= root_path %>/javascripts/message_attachment.js"></script>
+    <script src="<%= root_path %>/javascripts/message_content.js"></script>
+    <script src="<%= root_path %>/javascripts/message_html_part.js"></script>
+    <script src="<%= root_path %>/javascripts/message_inline_attachments.js"></script>
+    <script src="<%= root_path %>/javascripts/message_list.js"></script>
+    <script src="<%= root_path %>/javascripts/message_metadata.js"></script>
+    <script src="<%= root_path %>/javascripts/utilities.js"></script>
+    <script src="<%= root_path %>/javascripts/variables.js"></script>
+    <script src="<%= root_path %>/javascripts/web.js"></script>
   </head>
 
   <body data-root-path="<%= root_path %>">

data/lib/mail_grabber/web.rb

@@ -14,7 +14,8 @@ module MailGrabber
   module Web
     module_function
 
-    # Method which build a Rack application and run the Web::Application
+    # Method which build a Rack application and run the
+    # MailGrabber::Web::Application.
     def app
       @app ||= Rack::Builder.new do
         use Rack::Static,

data/lib/mail_grabber.rb

@@ -3,6 +3,6 @@
 require 'mail_grabber/error'
 require 'mail_grabber/database_helper'
 require 'mail_grabber/delivery_method'
-# If we are using this gem outside of Rails then do not load this code.
+# If we are using this gem outside of Rails, then do not load this code.
 require 'mail_grabber/railtie' if defined?(Rails)
 require 'mail_grabber/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_grabber
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.2.0
 platform: ruby
 authors:
 - Norbert Szivós
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-20 00:00:00.000000000 Z
+date: 2022-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -78,6 +78,16 @@ files:
 - lib/mail_grabber/web/application_router.rb
 - lib/mail_grabber/web/assets/images/mail_grabber515x500.png
 - lib/mail_grabber/web/assets/javascripts/application.js
+- lib/mail_grabber/web/assets/javascripts/dom.js
+- lib/mail_grabber/web/assets/javascripts/message_attachment.js
+- lib/mail_grabber/web/assets/javascripts/message_content.js
+- lib/mail_grabber/web/assets/javascripts/message_html_part.js
+- lib/mail_grabber/web/assets/javascripts/message_inline_attachments.js
+- lib/mail_grabber/web/assets/javascripts/message_list.js
+- lib/mail_grabber/web/assets/javascripts/message_metadata.js
+- lib/mail_grabber/web/assets/javascripts/utilities.js
+- lib/mail_grabber/web/assets/javascripts/variables.js
+- lib/mail_grabber/web/assets/javascripts/web.js
 - lib/mail_grabber/web/assets/stylesheets/application.css
 - lib/mail_grabber/web/views/_message_attachment_template.html.erb
 - lib/mail_grabber/web/views/_message_content_template.html.erb
@@ -91,7 +101,8 @@ metadata:
   source_code_uri: https://github.com/MailToolbox/mail_grabber
   changelog_uri: https://github.com/MailToolbox/mail_grabber/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/MailToolbox/mail_grabber/issues
-  documentation_uri: https://rubydoc.info/gems/mail_grabber
+  documentation_uri: https://rubydoc.info/github/MailToolbox/mail_grabber/main
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -100,14 +111,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Grab mails to inspect with MailGrabber.