class Gmail::Mailbox
Constants
- MAILBOX_ALIASES
Attributes
external_name[R]
name[R]
Public Class Methods
new(gmail, name="INBOX")
click to toggle source
# File lib/gmail/mailbox.rb, line 22 def initialize(gmail, name="INBOX") @name = name @external_name = Net::IMAP.decode_utf7(name) @gmail = gmail end
Public Instance Methods
count(*args)
click to toggle source
This is a convenience method that really probably shouldn't need to exist, but it does make code more readable, if seriously all you want is the count of messages.
Examples¶ ↑
gmail.inbox.count(:all) gmail.inbox.count(:unread, :from => "friend@gmail.com") gmail.mailbox("Test").count(:all, :after => Time.now-(20*24*3600))
# File lib/gmail/mailbox.rb, line 89 def count(*args) emails(*args).size end
emails(*args, &block)
click to toggle source
Returns list of emails which meets given criteria.
Examples¶ ↑
gmail.inbox.emails(:all) gmail.inbox.emails(:unread, :from => "friend@gmail.com") gmail.inbox.emails(:all, :after => Time.now-(20*24*3600)) gmail.mailbox("Test").emails(:read) gmail.mailbox("Test") do |box| box.emails(:read) box.emails(:unread) do |email| ... do something with each email... end end
# File lib/gmail/mailbox.rb, line 43 def emails(*args, &block) args << :all if args.size == 0 if args.first.is_a?(Symbol) search = MAILBOX_ALIASES[args.shift].dup opts = args.first.is_a?(Hash) ? args.first : {} opts[:after] and search.concat ['SINCE', opts[:after].to_imap_date] opts[:before] and search.concat ['BEFORE', opts[:before].to_imap_date] opts[:on] and search.concat ['ON', opts[:on].to_imap_date] opts[:from] and search.concat ['FROM', opts[:from]] opts[:to] and search.concat ['TO', opts[:to]] opts[:subject] and search.concat ['SUBJECT', opts[:subject]] opts[:label] and search.concat ['LABEL', opts[:label]] opts[:attachment] and search.concat ['HAS', 'attachment'] opts[:search] and search.concat ['BODY', opts[:search]] opts[:body] and search.concat ['BODY', opts[:body]] opts[:query] and search.concat opts[:query] @gmail.mailbox(name) do @gmail.conn.uid_search(search).collect do |uid| message = (messages[uid] ||= Message.new(self, uid)) block.call(message) if block_given? message end end elsif args.first.is_a?(Hash) emails(:all, args.first) else raise ArgumentError, "Invalid search criteria" end end
expunge()
click to toggle source
This permanently removes messages which are marked as deleted
# File lib/gmail/mailbox.rb, line 94 def expunge @gmail.mailbox(name) { @gmail.conn.expunge } end
inspect()
click to toggle source
# File lib/gmail/mailbox.rb, line 103 def inspect "#<Gmail::Mailbox#{'0x%04x' % (object_id << 1)} name=#{external_name}>" end
messages()
click to toggle source
Cached messages.
# File lib/gmail/mailbox.rb, line 99 def messages @messages ||= {} end
to_s()
click to toggle source
# File lib/gmail/mailbox.rb, line 107 def to_s name end