module Exjournal

Public Class Methods

logger() click to toggle source

# File lib/exjournal.rb, line 10
def logger
  @logger ||= Logger.new($stderr)
end

logger=(l) click to toggle source

# File lib/exjournal.rb, line 6
def logger=(l)
  @logger=l
end

Public Instance Methods

discard_mail_body(content) click to toggle source

discard everything after the first nn , i.e. all message body content from an RFC822 encoded mail

# File lib/exjournal.rb, line 34
def discard_mail_body(content)
  content.gsub(/^(.*?)\r\n\r\n.*$/m, '\1')
end

extract_journalled_mail(mail, strip_content=true) click to toggle source

extract the first message/rfc822 attachment from the RFC822 encoded content, and return it as a TMail::Mail if headers_only is true then message content will be discarded, and only headers processed

# File lib/exjournal.rb, line 19
def extract_journalled_mail(mail, strip_content=true)
  journal_mail = TMail::Mail.parse(mail) if mail.is_a?(String)
  
  # get the attachment
  attachment = journal_mail.parts.select{ |p| p.content_disposition == "attachment" || p.content_type == "message/rfc822" }.first
  
  # complain if the email has no attachment to extract
  raise "attempted to extract journalled mail, but message has no attachments: \n#{mail}\n\n" unless attachment

  mail_content = strip_content ? discard_mail_body(attachment.body) : attachment.body

  TMail::Mail.parse(mail_content)
end

mail_to_hash(mail, strip_content=true) click to toggle source

turn a TMail::Mail into a has suitable for JSON representation

# File lib/exjournal.rb, line 72
def mail_to_hash(mail, strip_content=true)
  mail = TMail::Mail.parse(mail) if mail.is_a?(String)

  message_id = strip_header(mail.message_id) if mail.message_id
  sent_at = mail.date.xmlschema
  in_reply_to = strip_headers(mail.in_reply_to) if mail.in_reply_to
  references = strip_headers(mail.references) if mail.references
  from = parse_addresses(mail.from_addrs).first
  sender = parse_addresses(mail.sender).first
  to = parse_addresses(mail.to_addrs)
  cc=parse_addresses(mail.cc_addrs)
  bcc=parse_addresses(mail.bcc_addrs)

  h = {
    :message_id=>message_id,
    :sent_at=>sent_at,
    :in_reply_to=>in_reply_to,
    :references=>references,
    :from=>from,
    :sender=>sender,
    :to=>to,
    :cc=>cc,
    :bcc=>bcc
  }

  if !strip_content
    h[:subject] = mail.subject
  end

  h
end

parse_address(address) click to toggle source

parse an address to a hash

# File lib/exjournal.rb, line 53
def parse_address(address)
  address = TMail::Address.parse(address) if address.is_a?(String)
  {:name=>address.name, :email_address=>address.address}
end

parse_addresses(addresses) click to toggle source

parse one or more addresses to hash. failures result in a warning logged

# File lib/exjournal.rb, line 59
def parse_addresses(addresses)
  [*(addresses||[])].map do |a| 
    begin
      parse_address(a)
    rescue Exception=>e
      logger.warn("failure parsing: #{a}")
      logger.warn(e)
      nil
    end
  end.compact
end

strip_header(header) click to toggle source

remove angle brackets from a header string

# File lib/exjournal.rb, line 39
def strip_header(header)
  header.gsub(/^<(.*)>$/, '\1')
end

strip_headers(headers) click to toggle source

remove angle brackets from one or more headers

# File lib/exjournal.rb, line 48
def strip_headers(headers)
  with_headers(headers){|h| strip_header(h)}
end

with_headers(headers) { |h| ... } click to toggle source

# File lib/exjournal.rb, line 43
def with_headers(headers)
  [*(headers||[])].map{|h| yield h}
end