Repository files navigation

Based on the greatrust-imap library.

This crate lets you connect to and interact with servers that implement the IMAP protocol (RFC3501 and various extensions). After authenticating withthe server, IMAP lets you list, fetch, and search for e-mails, as well as monitor mailboxes forchanges. It supports at least the latest three stable Rust releases (possibly even older ones;check theCI results).

To connect, use the [connect] function. This gives you an unauthenticated [Client]. You canthen use [Client::login] or [Client::authenticate] to perform username/password orchallenge/response authentication respectively. This in turn gives you an authenticated[Session], which lets you access the mailboxes at the server.

The documentation within this crate borrows heavily from the various RFCs, but should not beconsidered a complete reference. If anything is unclear, follow the links to the RFCs embeddedin the documentation for the various types and methods and read the raw text there!

See theexamples/ directory for examples.

To run the integration tests, you need to haveGreenMailrunning. Theeasiest way to do that is with Docker:

$docker pull greenmail/standalone:1.5.9$docker run -t -i -e GREENMAIL_OPTS='-Dgreenmail.setup.test.all -Dgreenmail.hostname=0.0.0.0 -Dgreenmail.auth.disabled -Dgreenmail.verbose' -p 3025:3025 -p 3110:3110 -p 3143:3143 -p 3465:3465 -p 3993:3993 -p 3995:3995 greenmail/standalone:1.5.9

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE orhttp://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT orhttp://opensource.org/licenses/MIT)at your option.

Unless you explicitly state otherwise, any contribution intentionally submittedfor inclusion in the work by you, as defined in the Apache-2.0 license, shallbe dual licensed as above, without any additional terms or conditions.