Class: Mail::IMAP

Inherits:
Object
  • Object
show all
Defined in:
lib/mailhandler/receiving/mail.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#imap ⇒ Object

Returns the value of attribute imap.



5
6
7
 
# File 'lib/mailhandler/receiving/mail.rb', line 5

def imap
  @imap
end

Instance Method Details

#connect(config = Mail::Configuration.instance) ⇒ Object

Start an IMAP session



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/mailhandler/receiving/mail.rb', line 63

def connect(config=Mail::Configuration.instance)

    @imap = Net::IMAP.new(settings[:address], settings[:port], settings[:enable_ssl], nil, false)

    if settings[:authentication].nil?
      imap.(settings[:user_name], settings[:password])
    else
      # Note that Net::IMAP#authenticate('LOGIN', ...) is not equal with Net::IMAP#login(...)!
      # (see also http://www.ensta.fr/~diam/ruby/online/ruby-doc-stdlib/libdoc/net/imap/rdoc/classes/Net/IMAP.html#M000718)
      imap.authenticate(settings[:authentication], settings[:user_name], settings[:password])
    end

end

#disconnect ⇒ Object 



77
78
79
80
81
82
83
84
85
 
# File 'lib/mailhandler/receiving/mail.rb', line 77

def disconnect

  if defined?(imap) && imap && !imap.disconnected?

    imap.disconnect

  end

end

#find(options = {}, &block) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/mailhandler/receiving/mail.rb', line 7

def find(options={}, &block)

  options = validate_options(options)

  options[:read_only] ? imap.examine(options[:mailbox]) : imap.select(options[:mailbox])

  uids = imap.uid_search(options[:keys])
  uids.reverse! if options[:what].to_sym == :last
  uids = uids.first(options[:count]) if options[:count].is_a?(Integer)
  uids.reverse! if (options[:what].to_sym == :last && options[:order].to_sym == :asc) ||
      (options[:what].to_sym != :last && options[:order].to_sym == :desc)


  if block_given?

    uids.each do |uid|
      uid = options[:uid].to_i unless options[:uid].nil?
      fetchdata = imap.uid_fetch(uid, ['RFC822'])[0]
      new_message = Mail.new(fetchdata.attr['RFC822'])
      new_message.mark_for_delete = true if options[:delete_after_find]
      if block.arity == 3
        yield new_message, imap, uid
      else
        yield new_message
      end
      imap.uid_store(uid, "+FLAGS", [Net::IMAP::DELETED]) if options[:delete_after_find] && new_message.is_marked_for_delete?
      break unless options[:uid].nil?
    end

    imap.expunge if options[:delete_after_find]

  else

    emails = []

    unless uids.nil?

      uids.each do |uid|
        uid = options[:uid].to_i unless options[:uid].nil?
        fetchdata = imap.uid_fetch(uid, ['RFC822'])[0]
        emails << Mail.new(fetchdata.attr['RFC822'])
        imap.uid_store(uid, "+FLAGS", [Net::IMAP::DELETED]) if options[:delete_after_find]
        break unless options[:uid].nil?

      end

    end

    imap.expunge if options[:delete_after_find]
    emails.size == 1 && options[:count] == 1 ? emails.first : emails

  end

end