mailchain_connector_imap 0.1.4 → 0.1.5

data/README.md

@@ -1,58 +1,62 @@
-# MailchainConnectorImap
-
-The Mailchain Connector for IMAP makes it possible to receive Mailchain messages in your email inbox (i.e. your webmail, desktop or phone mail application).
-
-It connects to the Mailchain API, converts messages to emails, then uploads them to your chosen IMAP mailbox.
-
-**NOTE: Further documentation can be found here: <https://docs.mailchain.xyz/mailchain-connectors/mailchain-connector-imap>**
-
-## Prerequisites
-
-You need to have installed:
-
-1. Ruby
-1. The Mailchain API client (<https://docs.mailchain.xyz/installation>)
-
-## Installation
-
-Install by running:
-
-```sh
-  gem install mailchain_connector_imap
-```
-
-## Usage
-
-### Getting Started & Configuration
-
-When running mailchain_connector_imap for the first time, or to change the configuration, run:
-
-```sh
-  mailchain_connector_imap --configure
-```
-
-This will walk you through the configuration options.
-
-NOTE: See [Mailchain Docs](https://docs.mailchain.xyz/mailchain-connectors/mailchain-connector-imap) for further information.
-
-### Running the Mailchain Connector for IMAP
-
-To run the connector, once you have run the configuration:
-
-```sh
-  mailchain_connector_imap
-```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at <https://github.com/mailchain/mailchain_connector_imap>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mailchain/community/blob/master/code-of-conduct.md).
-
-## Code of Conduct
-
-Everyone interacting in the MailchainConnectorImap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mailchain/community/blob/master/code-of-conduct.md).
+# MailchainConnectorImap
+
+The Mailchain Connector for IMAP makes it possible to receive Mailchain messages in your email inbox (i.e. your webmail, desktop or phone mail application).
+
+It connects to the Mailchain API, converts messages to emails, then uploads them to your chosen IMAP mailbox.
+
+**NOTE: Further documentation can be found here: <https://docs.mailchain.xyz/mailchain-connectors/mailchain-connector-imap>**
+
+## Prerequisites
+
+You need to have installed:
+
+1. Ruby
+1. The Mailchain API client (<https://docs.mailchain.xyz/installation>)
+
+## Installation
+
+Install by running:
+
+```sh
+  gem install mailchain_connector_imap
+```
+
+## Usage
+
+### Getting Started & Configuration
+
+When running mailchain_connector_imap for the first time, or to change the configuration, run:
+
+```sh
+  mailchain_connector_imap --configure
+```
+
+This will walk you through the configuration options.
+
+NOTE: See [Mailchain Docs](https://docs.mailchain.xyz/mailchain-connectors/mailchain-connector-imap) for further information.
+
+### Running the Mailchain Connector for IMAP
+
+To run the connector, once you have run the configuration:
+
+```sh
+  mailchain_connector_imap
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To clean up and re-install the gem locally, run `bundle exec rake clean` then `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/mailchain/mailchain_connector_imap>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mailchain/community/blob/master/code-of-conduct.md).
+
+## Code of Conduct
+
+Everyone interacting in the MailchainConnectorImap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mailchain/community/blob/master/code-of-conduct.md).

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/SPECIFICATION.md

@@ -0,0 +1,140 @@
+# **Mailchain Connector for IMAP Specification**
+
+The Mailchain Connector for IMAP enables users to receive Mailchain messages in their email client inbox by using the IMAP protocol to append messages to a new or existing email account via the email server (the email provider/ server must support IMAP).
+
+The following requirements set out how the Mailchain Connector for IMAP can be implemented:
+
+## **Requirements Notation**
+
+This document occasionally uses terms that appear in capital letters. When the terms “MUST”, “SHOULD”, “RECOMMENDED”, “MUST NOT”, “SHOULD NOT”, and “MAY” appear capitalised, they are being used to indicate particular requirements of this specification. A discussion of the meanings of these terms appears in [RFC2119](https://tools.ietf.org/html/rfc2119).
+
+### **Definitions for the purpose of these requirements**
+
+| Term       | Definition |
+| ----------- | ----------- |
+| Centralized resource | A single entity or group of entities could be said to have control of the resource. Responsibility for the integrity or availability or the resource falls on entity or entities.
+| Decentralized resource | No single entity or group of entities could be said to have control of the resource. Responsibility for the integrity or availability or the resource falls on the participants in the decentralized system according to the set of rules that govern the system.
+| Mailbox | The email account or mailbox that 1. supports IMAP, and 2. is where the Mailchain messages will be delivered.
+| Mailchain Client | The Mailchain API Client, available from [https://github.com/mailchain/mailchain]
+| the Connector | The Mailchain Connector for IMAP.
+| Message | A Mailchain message.
+| Email | A Mailchain message converted to an email message.
+
+## **Message Handling**
+
+### Mailchain Client
+
+The Connector SHOULD interact with the Mailchain Client for Message retrieval.
+
+### Message Storage & Logging
+
+Messages SHOULD not be stored on disk by the Connector.
+
+Message metadata SHOULD not be stored on disk unless it has been encrypted or hashed.
+
+A hash of the Message ID MAY be stored on disk to track which messages have been appended to the Mailbox.
+
+Credentials SHOULD not be stored on disk by the Connector unless encrypted.
+
+The Connector MAY log connection attempts.
+
+### IMAP Support
+
+The Connector MUST support HTTPS and HTTP connections to the Mailbox.
+
+The Connector MUST support PLAIN and LOGIN Mailbox authentication types.
+
+The Connector SHOULD prompt the user for credentials at runtime.
+
+The Connector SHOULD not append messages that already exist in the Mailbox.
+
+The Connector SHOULD not append messages that have been deleted from the Mailbox.
+
+Email state MUST be handled by the Mailbox server (or IMAP server). I.e. it is out of scope.
+
+### Appending Messages & Folder Structure
+
+A folder hierarchy SHOULD support either: `Protocol > Network > Address`, or `Address > Protocol > Network`.
+
+The Connector SHOULD append each Email according to the folder hierarchy.
+
+A user MAY indicate a preference for the folder hierarchy.
+
+The Connector SHOULD support delivering Mainnet (or equivalent) Emails to the primary inbox folder that alerts the user of a new emails.
+
+A user MAY indicate a preference for storing Mainnet Emails in the primary inbox or in a folder in the folder hierarchy.
+
+The Connector MAY poll for new Messages at regular intervals.
+
+A user MAY indicate a preference for the duration between polling for new Messages.
+
+### **Mailchain Addressing Format**
+
+Addressing SHOULD follow the standard mailchain format.
+
+For example:
+
+`recipient_public_address`@`network`.`protocol`, where:
+
+- `recipient_public_address` SHOULD be a public address for the recipient.
+- `@` MUST be the delimiter to separate address from protocol and network details.
+- `network`, an optional parameter MAY be included to specify the network the transaction is broadcast to, for example a testnet or a mainnet.
+- `protocol` SHOULD specify the blockchain protocol for the message, for example, bitcoin or ethereum.
+- `.` (dot) MUST be the delimiter to separate the protocol from network details.
+
+The address MAY append a resolvable FQDN to the Mailchain address when appending to the Mailbox, e.g. `recipient_public_address`@`network.protocol.example.com`.
+
+## **Private Keys**
+
+The Connector MUST not handle private keys. This SHOULD be handled by the Mailchain Client.
+
+## **Message Format**
+
+The Connector MUST convert the Message to RFC5322 Internet Message Format.
+
+The Connector MUST not alter the Message subject and body.
+
+The Connector SHOULD support plaintext and html message content types.
+
+The Connector MAY add a footer to the Email prior to appending it to the Mailbox.
+
+The Connector MUST add Mailchain message headers in the format 'X-Mailchain-' + 'Dash-Separated-Capitalised-Header', e.g. Mailchain message header: 'block-id-encoding' = email header 'X-Mailchain-Block-Id-Encoding'.
+
+The Connector SHOULD include transaction details in the Email headers.
+
+The Email body MUST be included after the headers.
+
+An Email body MUST follow the content-type specified in Content-Type header.
+
+An Email body MUST be encoded with the content-transfer-encoding specified in Content-Transfer-Encoding header.
+
+An Email body MAY be empty.
+
+An Email MUST have the following fields:
+
+| Field       | Description |
+| ----------- | ----------- |
+| To: | The recipient public address formatted according to the Mailchain Addressing Format
+| From: | The sender public address formatted according to the Mailchain Addressing Format
+| Message-ID: | The Message header message-id field value
+| Date: | The RFC5322 date format
+| Content-Type: | As per RFC6532 content type for the contents of the message.
+| Content-Transfer-Encoding: | How the message body SHOULD encoded
+| Subject: | The message subject
+| Body: | The message body
+
+Email headers SHOULD contain the following fields:
+
+| Field       | Description |
+| ----------- | ----------- |
+| X-Mailchain-Block-Id | Corresponding Message header field: block-id
+| X-Mailchain-Transaction-Hash | Corresponding Message header field: transaction-hash
+| X-Mailchain-Transaction-Hash-Encoding | Corresponding Message header field: transaction-hash-encoding
+| X-Mailchain-Block-Id-Encoding | Corresponding Message header field: block-id-encoding
+
+An Email MAY contain the following header fields:
+
+| Field       | Description |
+| ----------- | ----------- |
+| Reply-To: | The public address responses should be sent to
+| Reply-To-Public-Key: | The public key that should be used to encrypt a reply

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "mailchain_connector_imap"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mailchain_connector_imap"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/mailchain_connector_imap

@@ -1,7 +1,7 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require File.absolute_path('../lib/mailchain_connector_imap', __dir__)
-
-connector = MailchainConnectorImap::Connector.new
-connector.start
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require File.absolute_path('../lib/mailchain_connector_imap', __dir__)
+
+connector = MailchainConnectorImap::Connector.new
+connector.start

data/lib/api/mailchain.rb

@@ -1,50 +1,50 @@
-# frozen_string_literal: true
-
-require 'httparty'
-
-class MailchainApi
-  include HTTParty
-  @config = {}
-
-  # Initialize the config
-  def initialize(config)
-    @config = config
-  end
-
-  # Return the base_uri as specified in the config
-  def base_uri
-    ssl = @config['ssl'] ? 'https' : 'http'
-    uri = @config['hostname']
-    port = @config['port']
-    "#{ssl}://#{uri}:#{port}/api"
-  end
-
-  # Get addresses endpoint
-  # `protocol` = the protocol
-  # `network` = the network
-  def addresses(protocol, network)
-    res = self.class.get("#{base_uri}/addresses?protocol=#{protocol}&network=#{network}")
-    { body: JSON.parse(res.body), status_code: res.code }
-  end
-
-  # Get messages from api
-  # `address`: the address (string e.g. '0x123...')
-  # `protocol`: the protocol (string e.g. 'ethereum)
-  # `network`: the network (string e.g. 'ropsten')
-  def messages(address, protocol, network)
-    res = self.class.get("#{base_uri}/messages?address=#{address}&protocol=#{protocol}&network=#{network}")
-    { body: JSON.parse(res.body), status_code: res.code }
-  end
-
-  # Get protocols endpoint
-  def protocols
-    res = self.class.get("#{base_uri}/protocols")
-    { body: JSON.parse(res.body), status_code: res.code }
-  end
-
-  # Calls the version endpoint, returns version
-  def version
-    res = self.class.get("#{base_uri}/version")
-    { body: JSON.parse(res.body), status_code: res.code }
-  end
-end
+# frozen_string_literal: true
+
+require 'httparty'
+
+class MailchainApi
+  include HTTParty
+  @config = {}
+
+  # Initialize the config
+  def initialize(config)
+    @config = config
+  end
+
+  # Return the base_uri as specified in the config
+  def base_uri
+    ssl = @config['ssl'] ? 'https' : 'http'
+    uri = @config['hostname']
+    port = @config['port']
+    "#{ssl}://#{uri}:#{port}/api"
+  end
+
+  # Get addresses endpoint
+  # `protocol` = the protocol
+  # `network` = the network
+  def addresses(protocol, network)
+    res = self.class.get("#{base_uri}/addresses?protocol=#{protocol}&network=#{network}")
+    { body: JSON.parse(res.body), status_code: res.code }
+  end
+
+  # Get messages from api
+  # `address`: the address (string e.g. '0x123...')
+  # `protocol`: the protocol (string e.g. 'ethereum)
+  # `network`: the network (string e.g. 'ropsten')
+  def messages(address, protocol, network)
+    res = self.class.get("#{base_uri}/messages?address=#{address}&protocol=#{protocol}&network=#{network}")
+    { body: JSON.parse(res.body), status_code: res.code }
+  end
+
+  # Get protocols endpoint
+  def protocols
+    res = self.class.get("#{base_uri}/protocols")
+    { body: JSON.parse(res.body), status_code: res.code }
+  end
+
+  # Calls the version endpoint, returns version
+  def version
+    res = self.class.get("#{base_uri}/version")
+    { body: JSON.parse(res.body), status_code: res.code }
+  end
+end

data/lib/connection/mailchain.rb

@@ -1,159 +1,160 @@
-# frozen_string_literal: true
-
-require_relative '../api/mailchain'
-require_relative '../connection/mailchain'
-require 'mail'
-# Handles the Mailchain API configuration and connection
-class ConnectionMailchain
-  # Initialize configs
-  def initialize(config, config_file)
-    @config = config
-    @config_file = config_file
-    @api = MailchainApi.new(@config['mailchain'])
-  end
-
-  # Configures the Mailchain API settings then tests the connection
-  def configure_and_connect
-    if !configuration_wizard # TODO: - wire up to connection configuration
-      exit
-    else
-      test_connection
-    end
-  end
-
-  # # Run the Mailchain API configuration
-  def configuration_wizard
-    connection_configuration = ConnectionConfigurationMailchain.new(@config)
-    result = connection_configuration.configuration_wizard
-    if result['save']
-      result['config']['imap'].delete('password')
-      new_config_json = JSON.pretty_generate(result['config'])
-      File.write(@config_file, new_config_json)
-    end
-  end
-
-  # Tests the connection to the Mailchain API
-  def test_connection(silent = false)
-    puts 'Testing API connection...' unless silent
-    result = true
-    begin
-      res = @api.version
-      res[:status_code] != 200
-      puts "Connection was successful (API version: #{res[:body]['version']})" unless silent
-    rescue StandardError => e
-      puts "Mailchain API failed to connect with the following error: #{e}"
-      puts 'Check the Mailchain client is running and configured correctly'
-      result = false
-    end
-    result
-  end
-
-  # Converts mailchain message to regular email
-  def convert_message(message)
-    footer = 'Delivered by Mailchain IMAP Connector'
-    c_type = get_content_type(message['headers']['content-type'])
-
-    mail = Mail.new do
-      from        message['headers']['from']
-      to          message['headers']['to']
-      date        message['headers']['date']
-      message_id  message['headers']['message-id']
-      subject     message['subject']
-      if c_type == 'html'
-        html_part do
-          content_type message['headers']['content-type']
-          body "#{message['body']} <br/><br/>#{footer}"
-        end
-      end
-      if c_type == 'plain'
-        text_part do
-          content_type message['headers']['content-type']
-          body "#{message['body']} \r\n#{footer}"
-        end
-      end
-    end
-    mail.header['X-Mailchain-Block-Id'] = message['block-id']
-    mail.header['X-Mailchain-Block-Id-Encoding'] = message['block-id-encoding']
-    mail.header['X-Mailchain-Transaction-Hash']  = message['transaction-hash']
-    mail.header['X-Mailchain-Transaction-Hash-Encoding'] = message['transaction-hash-encoding']
-    mail
-  end
-
-  # Returns `text` or `html`
-  def get_content_type(content_type)
-    case content_type
-    when '"text/html; charset=\"UTF-8\""'
-      'html'
-    when '"text/plain; charset=\"UTF-8\""'
-      'plain'
-    else
-      'plain'
-    end
-  end
-
-  # Returns addresses formatted by_network
-  # e.g. [{
-  #         "protocol" => "ethereum",
-  #         "network" => "kovan",
-  #         "addresses"=> ["1234567890...", "d5ab4ce..."]
-  #       }]
-  def addresses_by_network
-    protocol_networks.map do |obj|
-      {
-        'protocol' => obj['protocol'],
-        'network' => obj['network'],
-        'addresses' => @api.addresses(obj['protocol'], obj['network'])[:body]['addresses']
-      }
-    end
-  end
-
-  # Returns messages formatted by_network
-  #  e.g. [ address, res['messages'] ]
-  def messages_by_network(item)
-    protocol = item['protocol']
-    network = item['network']
-    addresses = item['addresses']
-    messages = []
-    addresses.each do |address|
-      res = get_messages(address, protocol, network)
-      messages << [address, res['messages']] unless res['messages'].nil?
-    end
-    messages
-  end
-
-  # Gets messages from api and returns `body` {"messages" => [...]}
-  def get_messages(addr, protocol, network)
-    address = "0x#{addr}"
-    @api.messages(address, protocol, network)[:body]
-  end
-
-  # Convert and call the append_message for each valid message
-  def convert_messages(messages)
-    cmgs = []
-    messages.each do |msg|
-      next unless msg['status'] == 'ok'
-
-      cm = convert_message(msg)
-      cmgs << {
-        'message' => cm,
-        'message_id' => msg['headers']['message-id'],
-        'message_date' => cm.date.to_time
-      }
-    end
-    cmgs
-  end
-
-  # Returns array of each network with parent protocol
-  # e.g. [{'protocol' => 'ethereum', 'network' => 'ropsten'},...]
-  def protocol_networks
-    output = []
-    @api.protocols[:body]['protocols'].each do |proto|
-      output << proto['networks'].map do |n|
-        { 'protocol' => proto['name'], 'network' => n['name'] }
-      end
-    end
-    output.flatten
-  rescue StandardError => e
-    puts "Error: #{e}"
-  end
-end
+# frozen_string_literal: true
+
+require_relative '../api/mailchain'
+require_relative '../connection/mailchain'
+require 'mail'
+# Handles the Mailchain API configuration and connection
+class ConnectionMailchain
+  # Initialize configs
+  def initialize(config, config_file)
+    @config = config
+    @config_file = config_file
+    @api = MailchainApi.new(@config['mailchain'])
+  end
+
+  # Configures the Mailchain API settings then tests the connection
+  def configure_and_connect
+    if !configuration_wizard # TODO: - wire up to connection configuration
+      exit
+    else
+      test_connection
+    end
+  end
+
+  # # Run the Mailchain API configuration
+  def configuration_wizard
+    connection_configuration = ConnectionConfigurationMailchain.new(@config)
+    result = connection_configuration.configuration_wizard
+    if result['save']
+      result['config']['imap'].delete('password')
+      new_config_json = JSON.pretty_generate(result['config'])
+      File.write(@config_file, new_config_json)
+    end
+  end
+
+  # Tests the connection to the Mailchain API
+  def test_connection(silent = false)
+    puts 'Testing API connection...' unless silent
+    result = true
+    begin
+      res = @api.version
+      res[:status_code] != 200
+      puts "Connection was successful (API version: #{res[:body]['version']})" unless silent
+    rescue StandardError => e
+      puts "Mailchain API failed to connect with the following error: #{e}"
+      puts 'Check the Mailchain client is running and configured correctly'
+      result = false
+    end
+    result
+  end
+
+  # Converts mailchain message to regular email
+  def convert_message(message)
+    footer = 'Delivered by Mailchain IMAP Connector'
+    c_type = get_content_type(message['headers']['content-type'])
+
+    mail = Mail.new do
+      from        message['headers']['from']
+      to          message['headers']['to']
+      date        message['headers']['date']
+      message_id  message['headers']['message-id']
+      subject     message['subject']
+      if c_type == 'html'
+        html_part do
+          content_type message['headers']['content-type']
+          body "#{message['body']} <br/><br/>#{footer}"
+        end
+      end
+      if c_type == 'plain'
+        text_part do
+          content_type message['headers']['content-type']
+          body "#{message['body']} \r\n#{footer}"
+        end
+      end
+    end
+    mail.header['X-Mailchain-Block-Id'] = message['block-id']
+    mail.header['X-Mailchain-Block-Id-Encoding'] = message['block-id-encoding']
+    mail.header['X-Mailchain-Transaction-Hash']  = message['transaction-hash']
+    mail.header['X-Mailchain-Transaction-Hash-Encoding'] = message['transaction-hash-encoding']
+    mail
+  end
+
+  # Returns `text` or `html`
+  def get_content_type(content_type)
+    case content_type
+    when '"text/html; charset=\"UTF-8\""'
+      'html'
+    when '"text/plain; charset=\"UTF-8\""'
+      'plain'
+    else
+      'plain'
+    end
+  end
+
+  # Returns addresses formatted by_network
+  # e.g. [{
+  #         "protocol" => "ethereum",
+  #         "network" => "kovan",
+  #         "addresses"=> ["1234567890...", "d5ab4ce..."]
+  #       }]
+  def addresses_by_network
+    protocol_networks.map do |obj|
+      {
+        'protocol' => obj['protocol'],
+        'network' => obj['network'],
+        'addresses' => @api.addresses(obj['protocol'], obj['network'])[:body]['addresses']
+      }
+    end
+  end
+
+  # Returns messages formatted by_network
+  #  e.g. [ address, res['messages'] ]
+  def messages_by_network(item)
+    protocol = item['protocol']
+    network = item['network']
+    addresses = item['addresses']
+    messages = []
+    addresses.each do |address|
+      address_val = address["value"]
+      res = get_messages(address_val, protocol, network)
+      messages << [address_val, res['messages']] unless res['messages'].nil?
+    end
+    messages
+  end
+
+  # Gets messages from api and returns `body` {"messages" => [...]}
+  def get_messages(addr, protocol, network)
+    address = "#{addr}"
+    @api.messages(address, protocol, network)[:body]
+  end
+
+  # Convert and call the append_message for each valid message
+  def convert_messages(messages)
+    cmgs = []
+    messages.each do |msg|
+      next unless msg['status'] == 'ok'
+
+      cm = convert_message(msg)
+      cmgs << {
+        'message' => cm,
+        'message_id' => msg['headers']['message-id'],
+        'message_date' => cm.date.to_time
+      }
+    end
+    cmgs
+  end
+
+  # Returns array of each network with parent protocol
+  # e.g. [{'protocol' => 'ethereum', 'network' => 'ropsten'},...]
+  def protocol_networks
+    output = []
+    @api.protocols[:body]['protocols'].each do |proto|
+      output << proto['networks'].map do |n|
+        { 'protocol' => proto['name'], 'network' => n['name'] }
+      end
+    end
+    output.flatten
+  rescue StandardError => e
+    puts "Error: #{e}"
+  end
+end