https://github.com/ruby/net-imap

Ruby client api for Internet Message Access Protocol
https://github.com/ruby/net-imap

hacktoberfest ruby

Last synced: 3 days ago
JSON representation

Ruby client api for Internet Message Access Protocol

• Host: GitHub
• URL: https://github.com/ruby/net-imap
• Owner: ruby
• License: other
• Created: 2020-02-13T07:27:42.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-17T02:54:34.000Z (10 days ago)
• Last Synced: 2025-01-17T09:03:10.562Z (10 days ago)
• Topics: hacktoberfest, ruby
• Language: Ruby
• Homepage: https://ruby.github.io/net-imap
• Size: 1.48 MB
• Stars: 66
• Watchers: 37
• Forks: 29
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# Net::IMAP

Net::IMAP implements Internet Message Access Protocol (IMAP) client

functionality.  The protocol is described in

[RFC3501](https://www.rfc-editor.org/rfc/rfc3501),

[RFC9051](https://www.rfc-editor.org/rfc/rfc9051) and various extensions.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'net-imap'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install net-imap

## Usage

### Connect with TLS to port 993

```ruby

imap = Net::IMAP.new('mail.example.com', ssl: true)

imap.port          => 993

imap.tls_verified? => true

case imap.greeting.name

in /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

```ruby

imap.examine('INBOX')

imap.search(["RECENT"]).each do |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"

```ruby

imap.select('Mail/sent-mail')

if imap.list('Mail/', 'sent-apr03').empty?

  imap.create('Mail/sent-apr03')

end

imap.search(["BEFORE", "30-Apr-2003", "SINCE", "1-Apr-2003"]).each do |message_id|

  if imap.capable?(:move) || imap.capable?(:IMAP4rev2)

    imap.move(message_id, "Mail/sent-apr03")

  else

    imap.copy(message_id, "Mail/sent-apr03")

    imap.store(message_id, "+FLAGS", [:Deleted])

  end

end

imap.expunge

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake 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](https://rubygems.org).

## Contributing

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