Class: ICFS::Email::Imap

Inherits:
Object
  • Object
show all
Defined in:
lib/icfs/email/imap.rb

Overview

Get email using IMAP

Instance Method Summary collapse

Constructor Details

#initialize(core, log, opts = {}) ⇒ Imap

New instance

Parameters:

  • core (Email::Core) —

    The core email processor

  • log (Logger) —

    The log

  • opts (Hash) (defaults to: {}) —

    configuration options

Options Hash (opts):

  • :address (String) —

    The server address

  • :port (Integer) —

    The server port

  • :enable_ssl (Boolean) —

    Use SSL or not

  • :username (String) —

    The login username

  • :password (String) —

    The login password

  • :mailbox (String) —

    The mailbox to read

  • :keys (Array, String) —

    keys to pass to Net::IMAP#uid_search

  • :idle_time (Integer) —

    Seconds to wait IDLE before polling

  • :reconnect (Integer) —

    Seconds after which we can reconnect



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/icfs/email/imap.rb', line 42

def initialize(core, log, opts={})
  @core = core
  @log = log
  @cfg = {
    :port => 993,
    :enable_ssl => true,
    :keys => 'ALL',
    :idle_time => 60*5,
    :reconnect => 60*15,
  }.merge!(opts)
end

Instance Method Details

#fetch ⇒ Object

Fetch messages



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/icfs/email/imap.rb', line 81

def fetch()

  # open & login
  imap = ::Net::IMAP.new(@cfg[:address], @cfg[:port],
      @cfg[:enable_ssl], nil, false)
  imap.(@cfg[:username], @cfg[:password])
  @log.info('IMAP: open and login')

  # mailbox
  if @cfg[:mailbox]
    imap.select(::Net::IMAP.encode_utf7(@cfg[:mailbox]))
    @log.info('IMAP: mailbox selected: %s' % @cfg[:mailbox])
  else
    @log.error('IMAP: no mailbox specified')
    mbxs = imap.list('', '*')
    @log.info('IMAP: mailbox list: %s' % mbxs.map{|mb| mb.name }.join(', '))
    return
  end

  while true
    # fetch messages
    uids = imap.uid_search(@cfg[:keys])
    @log.debug('IMAP: %d messages found' % uids.size)
    uids.each do |uid|
      fd = imap.uid_fetch(uid, ['RFC822'])[0]
      @log.debug('IMAP: message fetched')
      msg = ::Mail.new(fd.attr['RFC822'])
      @core.receive(msg)
      if @cfg[:delete]
        imap.uid_store(uid, "+FLAGS", [:Deleted])
        @log.debug('IMAP: message deleted')
      end
    end
    if @cfg[:delete]
      imap.expunge
      @log.debug('IMAP: expunged')
    end

    # wait IDLE until new mail
    if @cfg[:idle_time]
      @log.debug('IMAP: starting IDLE')
      imap.idle(@cfg[:idle_time]) do |resp|
        if resp.is_a?(::Net::IMAP::UntaggedResponse) && resp.name == "EXISTS"
          @log.debug('IMAP: new mail, IDLE done')
          imap.idle_done
        end
      end
      @log.debug('IMAP: exited IDLE')

    # or we just run once
    else
      @log.debug('IMAP: fetch completed')
      break
    end
  end

ensure
  if defined?(imap) && imap && !imap.disconnected?
    imap.disconnect
    @log.info('IMAP: disconnected')
  end
end

#reconnect ⇒ Object

Handles reconnects when dropped



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/icfs/email/imap.rb', line 58

def reconnect()

  while true
    start = Time.now
    begin
      fetch()
    rescue EOFError
      if( (Time.now - start) > @cfg[:reconnect] )
        @log.info('IMAP: lost connection, reconnecting')
        next
      else
        @log.error('IMAP: disconnected under the reconnect limit')
        break
      end
    end
  end

end