1. module exchanger
   1. function exchanger.getEmail (itemId, callback)
   2. function exchanger.getEmails (folderName, limit, callback)
   3. function exchanger.getFolders (id, callback)
   4. function exchanger.initialize (settings, callback)
   5. object exchanger.client

module exchanger

function exchanger.getEmail (itemId, callback)

• description and source-code

  getEmail = function (itemId, callback) {
    if (!exports.client) {
      return callback(new Error('Call initialize()'))
    }
    if ((!itemId['id'] || !itemId['changeKey']) && itemId.indexOf('|') > 0) {
      var s = itemId.split('|');
  
      itemId = {
        id: itemId.split('|')[0],
        changeKey: itemId.split('|')[1]
      };
    }
  
    if (!itemId.id || !itemId.changeKey) {
      return callback(new Error('Id is not correct.'));
    }
  
    var soapRequest =
      '<tns:GetItem xmlns="http://schemas.microsoft.com/exchange/services/2006/messages" xmlns:t="http://schemas.microsoft.com/exchange
  /services/2006/types">' +
        '<tns:ItemShape>' +
          '<t:BaseShape>Default</t:BaseShape>' +
          '<t:IncludeMimeContent>true</t:IncludeMimeContent>' +
        '</tns:ItemShape>' +
        '<tns:ItemIds>' +
          '<t:ItemId Id="' + itemId.id + '" ChangeKey="' + itemId.changeKey + '" />' +
        '</tns:ItemIds>' +
      '</tns:GetItem>';
  
    exports.client.GetItem(soapRequest, function(err, result, body) {
      if (err) {
        return callback(err);
      }
  
      var parser = new xml2js.Parser();
  
      parser.parseString(body, function(err, result) {
        var responseCode = result['s:Body']['m:GetItemResponse']['m:ResponseMessages']['m:GetItemResponseMessage']['m:ResponseCode
  '];
  
        if (responseCode !== 'NoError') {
          return callback(new Error(responseCode));
        }
  
        var item = result['s:Body']['m:GetItemResponse']['m:ResponseMessages']['m:GetItemResponseMessage']['m:Items']['t:Message'];
  
        var itemId = {
          id: item['t:ItemId']['@'].Id,
          changeKey: item['t:ItemId']['@'].ChangeKey
        };
  
        function handleMailbox(mailbox) {
          var mailboxes = [];
  
          if (!mailbox || !mailbox['t:Mailbox']) {
            return mailboxes;
          }
          mailbox = mailbox['t:Mailbox'];
  
          function getMailboxObj(mailboxItem) {
            return {
              name: mailboxItem['t:Name'],
              emailAddress: mailboxItem['t:EmailAddress']
            };
          }
  
          if (mailbox instanceof Array) {
            mailbox.forEach(function(m, idx) {
              mailboxes.push(getMailboxObj(m));
            })
          } else {
            mailboxes.push(getMailboxObj(mailbox));
          }
  
          return mailboxes;
        }
  
        var toRecipients = handleMailbox(item['t:ToRecipients']);
        var ccRecipients = handleMailbox(item['t:CcRecipients']);
        var from = handleMailbox(item['t:From']);
  
        var email = {
          id: itemId.id + '|' + itemId.changeKey,
          subject: item['t:Subject'],
          bodyType: item['t:Body']['@']['t:BodyType'],
          body: item['t:Body']['#'],
          size: item['t:Size'],
          dateTimeSent: item['t:DateTimeSent'],
          dateTimeCreated: item['t:DateTimeCreated'],
          toRecipients: toRecipients,
          ccRecipients: ccRecipients,
          from: from,
          isRead: (item['t:IsRead'] == 'true') ? true : false,
          meta: {
            itemId: itemId
          }
        };
  
        callback(null, email);
      });
    });
  }

• example usage

  n/a

function exchanger.getEmails (folderName, limit, callback)

• description and source-code

  getEmails = function (folderName, limit, callback) {
    if (typeof(folderName) === "function") {
      callback = folderName;
      folderName = 'inbox';
      limit = 10;
    }
    if (typeof(limit) === "function") {
      callback = limit;
      limit = 10;
    }
    if (!exports.client) {
      return callback(new Error('Call initialize()'));
    }
  
    var soapRequest =
      '<tns:FindItem Traversal="Shallow" xmlns:tns="http://schemas.microsoft.com/exchange/services/2006/messages">' +
        '<tns:ItemShape>' +
          '<t:BaseShape>IdOnly</t:BaseShape>' +
          '<t:AdditionalProperties>' +
            '<t:FieldURI FieldURI="item:ItemId"></t:FieldURI>' +
            // '<t:FieldURI FieldURI="item:ConversationId"></t:FieldURI>' +
            // '<t:FieldURI FieldURI="message:ReplyTo"></t:FieldURI>' +
            // '<t:FieldURI FieldURI="message:ToRecipients"></t:FieldURI>' +
            // '<t:FieldURI FieldURI="message:CcRecipients"></t:FieldURI>' +
            // '<t:FieldURI FieldURI="message:BccRecipients"></t:FieldURI>' +
            '<t:FieldURI FieldURI="item:DateTimeCreated"></t:FieldURI>' +
            '<t:FieldURI FieldURI="item:DateTimeSent"></t:FieldURI>' +
            '<t:FieldURI FieldURI="item:HasAttachments"></t:FieldURI>' +
            '<t:FieldURI FieldURI="item:Size"></t:FieldURI>' +
            '<t:FieldURI FieldURI="message:From"></t:FieldURI>' +
            '<t:FieldURI FieldURI="message:IsRead"></t:FieldURI>' +
            '<t:FieldURI FieldURI="item:Importance"></t:FieldURI>' +
            '<t:FieldURI FieldURI="item:Subject"></t:FieldURI>' +
            '<t:FieldURI FieldURI="item:DateTimeReceived"></t:FieldURI>' +
          '</t:AdditionalProperties>' +
        '</tns:ItemShape>' +
        '<tns:IndexedPageItemView BasePoint="Beginning" Offset="0" MaxEntriesReturned="10"></tns:IndexedPageItemView>' +
        '<tns:ParentFolderIds>' +
          '<t:DistinguishedFolderId Id="inbox"></t:DistinguishedFolderId>' +
        '</tns:ParentFolderIds>' +
      '</tns:FindItem>';
  
    exports.client.FindItem(soapRequest, function(err, result, body) {
      if (err) {
        return callback(err);
      }
  
      var parser = new xml2js.Parser();
  
      parser.parseString(body, function(err, result) {
        var responseCode = result['s:Body']['m:FindItemResponse']['m:ResponseMessages']['m:FindItemResponseMessage']['m:ResponseCode
  '];
  
        if (responseCode !== 'NoError') {
          return callback(new Error(responseCode));
        }
  
        var rootFolder = result['s:Body']['m:FindItemResponse']['m:ResponseMessages']['m:FindItemResponseMessage']['m:RootFolder'];
  
        var emails = [];
        rootFolder['t:Items']['t:Message'].forEach(function(item, idx) {
          var md5hasher = crypto.createHash('md5');
          md5hasher.update(item['t:Subject'] + item['t:DateTimeSent']);
          var hash = md5hasher.digest('hex');
  
          var itemId = {
            id: item['t:ItemId']['@'].Id,
            changeKey: item['t:ItemId']['@'].ChangeKey
          };
  
          var dateTimeReceived = item['t:DateTimeReceived'];
  
          emails.push({
            id: itemId.id + '|' + itemId.changeKey,
            hash: hash,
            subject: item['t:Subject'],
            dateTimeReceived: moment(dateTimeReceived).format("MM/DD/YYYY, h:mm:ss A"),
            size: item['t:Size'],
            importance: item['t:Importance'],
            hasAttachments: (item['t:HasAttachments'] === 'true'),
            from: item['t:From']['t:Mailbox']['t:Name'],
            isRead: (item['t:IsRead'] === 'true'),
            meta: {
              itemId: itemId
            }
          });
        });
  
        callback(null, emails);
      });
    });
  }

• example usage

  ...
  ``` javascript
  var exchanger = require('exchanger');
  retriever.initialize({ url: 'webmail.example.com', username: 'username', password: 'password' }, function
  (err) {
    console.log('Initialized!');
  });
  ```
  
  ###exchanger.getEmails(folderName, limit, callback)
  
  ``` javascript
  var exchanger = require('exchanger');
  retriever.initialize({ url: 'webmail.example.com', username: 'username', password: 'password' }, function
  (err) {
    exchanger.getEmails('inbox', 50, function(err, emails) {
      console.log(emails);
    });
  ...

function exchanger.getFolders (id, callback)

• description and source-code

  getFolders = function (id, callback) {
    if (typeof(id) == 'function') {
      callback = id;
      id = 'inbox';
    }
  
    var soapRequest =
      '<tns:FindFolder xmlns:tns="http://schemas.microsoft.com/exchange/services/2006/messages">' +
          '<tns:FolderShape>' +
            '<t:BaseShape>Default</t:BaseShape>' +
          '</tns:FolderShape>' +
          '<tns:ParentFolderIds>' +
            '<t:DistinguishedFolderId Id="inbox"></t:DistinguishedFolderId>' +
          '</tns:ParentFolderIds>' +
        '</tns:FindFolder>';
  
    exports.client.FindFolder(soapRequest, function(err, result) {
      if (err) {
        callback(err)
      }
  
      if (result.ResponseMessages.FindFolderResponseMessage.ResponseCode == 'NoError') {
        var rootFolder = result.ResponseMessages.FindFolderResponseMessage.RootFolder;
  
        rootFolder.Folders.Folder.forEach(function(folder) {
          // console.log(folder);
        });
  
        callback(null, {});
      }
    });
  }

• example usage

  n/a

function exchanger.initialize (settings, callback)

• description and source-code

  initialize = function (settings, callback) {
    var soap = require('soap');
    // TODO: Handle different locations of where the asmx lives.
    var endpoint = 'https://' + path.join(settings.url, 'EWS/Exchange.asmx');
    var url = path.join(__dirname, 'Services.wsdl');
  
    soap.createClient(url, {}, function(err, client) {
      if (err) {
        return callback(err);
      }
      if (!client) {
        return callback(new Error('Could not create client'));
      }
  
      exports.client = client;
      exports.client.setSecurity(new soap.BasicAuthSecurity(settings.username, settings.password));
  
      return callback(null);
    }, endpoint);
  }

• example usage

  ...
  
  ```
  npm install exchanger
  ```
  
  ##Module
  
  ###exchanger.initialize(settings, callback)
  
  ``` javascript
    var exchanger = require('exchanger');
    retriever.initialize({ url: 'webmail.example.com', username: 'username', password: 'password' },
  function(err) {
      console.log('Initialized!');
    });
  ```
  ...