class IMAPProcessor::Flag

Automatically flag your messages, yo!

aka part two of my Plan for Total Email Domination.

IMAPFlag flags messages you’ve responded to, messages you’ve written and messages in response to messages you’ve written.

If you unflag a message IMAPFlag is smart and doesn’t re-flag it.

I chose these settings because I find these messages interesting but don’t want to manually flag them. Why should I do all the clicking when the computer can do it for me?

Constants

AUTO_FLAG_KEYWORD: IMAP keyword for automatically flagged messages
MESSAGE_ID: Message-Id query

Public Class Methods

new(options) click to toggle source

Creates a new IMAPFlag from options.

Options include:

+:Email:: Email address used for sending email

and all options from IMAPClient

Calls superclass method IMAPProcessor::Client::new

# File lib/imap_processor/flag.rb, line 37
def initialize(options)
  super

  @flag = options[:flag]
  @boxes = @flag.keys
end

process_args(args) click to toggle source

Calls superclass method IMAPProcessor::process_args

# File lib/imap_processor/flag.rb, line 44
  def self.process_args(args)
    super __FILE__, args, {} do |opts, options|
      opts.banner << <<-EOF
imap_flag automatically flags your messages.
      EOF
    end
  end

Public Instance Methods

all_email() click to toggle source

# File lib/imap_processor/flag.rb, line 81
def all_email
  @email.map { |e| "FROM #{e}" }.inject { |s,e| "OR #{s} #{e}" }
end

answered_in_curr() click to toggle source

Answered messages in the selected mailbox.

# File lib/imap_processor/flag.rb, line 73
def answered_in_curr
  search [
    'ANSWERED',
    'NOT', 'FLAGGED',
    'NOT', 'KEYWORD', AUTO_FLAG_KEYWORD
  ], 'answered messages'
end

find_messages() click to toggle source

Searches for messages I answered and messages I wrote.

# File lib/imap_processor/flag.rb, line 62
def find_messages
  @box = @boxes.find { |box| @mailbox =~ /#{box}/ } # TODO: needs more work
  raise unless @box
  @email = @flag[@box]
  raise unless @email
  return [answered_in_curr, wrote_in_curr, responses_in_curr].flatten
end

responses_in_curr() click to toggle source

Messages in response to messages I wrote in the selected mailbox.

# File lib/imap_processor/flag.rb, line 96
def responses_in_curr
  log "  Scanning for responses to messages I wrote"
  my_mail = @imap.search self.all_email

  return [] if my_mail.empty?

  msg_ids = @imap.fetch my_mail, "BODY.PEEK[#{MESSAGE_ID}]"
  msg_ids.map! do |data|
    data.attr["BODY[#{MESSAGE_ID}]"].split(':', 2).last.strip
  end

  messages = msg_ids.map do |id|
    @imap.search([
      'HEADER', 'In-Reply-To', id,
      'NOT', 'FLAGGED',
      'NOT', 'KEYWORD', AUTO_FLAG_KEYWORD
    ])
  end

  messages.flatten!

  log "    Found #{messages.length} messages"

  return messages
end

run() click to toggle source

Removes read, unflagged messages from all selected mailboxes…

Calls superclass method IMAPProcessor::Client#run

# File lib/imap_processor/flag.rb, line 55
def run
  super "Flagging messages", [:Flagged, AUTO_FLAG_KEYWORD]
end

wrote_in_curr() click to toggle source

Messages I wrote in the selected mailbox.

# File lib/imap_processor/flag.rb, line 88
def wrote_in_curr
  search("#{self.all_email} NOT FLAGGED NOT KEYWORD AUTO_FLAG_KEYWORD",
         "messages by #{@email.join(", ")}")
end