Net::IMAP

Net::IMAP implements Internet Message Access Protocol (IMAP) client functionality. The protocol is described in RFC3501, RFC9051 and various extensions.

Installation

Add this line to your application's Gemfile:

gem'net-imap'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install net-imap

Usage

Connect with TLS to port 993

imap=Net::IMAP.new('mail.example.com',ssl: true)imap.port=>993imap.tls_verified?=>truecaseimap.greeting.namein/OK/i# The client is connected in the "Not Authenticated" state.imap.authenticate("PLAIN","joe_user","joes_password")in/PREAUTH/i# The client is connected in the "Authenticated" state.end

List sender and subject of all recent messages in the default mailbox

imap.examine('INBOX')imap.search(["RECENT"]).eachdo |message_id|
envelope=imap.fetch(message_id,"ENVELOPE")[0].attr["ENVELOPE"]puts"#{envelope.from[0].name}: \t#{envelope.subject}"end

Move all messages from April 2003 from "Mail/sent-mail" to "Mail/sent-apr03"

imap.select('Mail/sent-mail')ifimap.list('Mail/','sent-apr03').empty?imap.create('Mail/sent-apr03')endimap.search(["BEFORE","30-Apr-2003","SINCE","1-Apr-2003"]).eachdo |message_id|
ifimap.capable?(:move) || imap.capable?(:IMAP4rev2)imap.move(message_id,"Mail/sent-apr03")elseimap.copy(message_id,"Mail/sent-apr03")imap.store(message_id,"+FLAGS",[:Deleted])imap.expungeendend

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/net-imap.