File: //usr/local/rvm/gems/default/doc/mail-2.7.1/ri/Mail/IMAP/cdesc-IMAP.ri
U:RDoc::NormalClass[iI" IMAP:ETI"Mail::IMAP;TI"Mail::Retriever;To:RDoc::Markup::Document:@parts[o;;[o:RDoc::Markup::Paragraph;[I"XThe IMAP retriever allows to get the last, first or all emails from a IMAP server. ;TI"IEach email retrieved (RFC2822) is given as an instance of +Message+.;To:RDoc::Markup::BlankLine o; ;[I"FWhile being retrieved, emails can be yielded if a block is given.;T@S:RDoc::Markup::Heading:
leveli: textI"-Example of retrieving Emails from GMail:;T@o:RDoc::Markup::Verbatim;[I"Mail.defaults do
;TI"P retriever_method :imap, { :address => "imap.googlemail.com",
;TI"> :port => 993,
;TI"G :user_name => '<username>',
;TI"G :password => '<password>',
;TI"@ :enable_ssl => true }
;TI" end
;TI"
;TI"4Mail.all #=> Returns an array of all emails
;TI"4Mail.first #=> Returns the first unread email
;TI"3Mail.last #=> Returns the last unread email
;T:@format0o; ;[I"VYou can also pass options into Mail.find to locate an email in your imap mailbox ;TI" with the following options:;T@o;;[I"Tmailbox: name of the mailbox used for email retrieval. The default is 'INBOX'.
;TI";what: last or first emails. The default is :first.
;TI"border: order of emails returned. Possible values are :asc or :desc. Default value is :asc.
;TI"]count: number of emails to retrieve. The default value is 10. A value of 1 returns an
;TI"F instance of Message, not an array of Message instances.
;TI"|keys: are passed as criteria to the SEARCH command. They can either be a string holding the entire search string,
;TI"| or a single-dimension array of search keywords and arguments. Refer to [IMAP] section 6.4.4 for a full list
;TI"# The default is 'ALL'
;TI"
;TI"LMail.find(:what => :first, :count => 10, :order => :asc, :keys=>'ALL')
;TI"7#=> Returns the first 10 emails in ascending order;T;0:
@fileI"/lib/mail/network/retriever_methods/imap.rb;T:0@omit_headings_from_table_of_contents_below0;0;0[[
I"
settings;TI"RW;T:publicFI"/lib/mail/network/retriever_methods/imap.rb;T[ [ [[I"
class;T[[;[[I"new;T@;[:protected[ [:private[ [I"
instance;T[[;[[I"connection;T@;[I"delete_all;T@;[I" find;T@;[;[ [;[[I"
start;T@;[I"validate_options;T@;[ [U:RDoc::Context::Section[i 0o;;[ ;0;0[@6I" Mail;TcRDoc::NormalModule