Categorygithub.com/emersion/go-imap-idle
modulepackage
0.0.0-20210907174914-db2568431445
Repository: https://github.com/emersion/go-imap-idle.git
Documentation: pkg.go.dev

# README

go-imap-idle

GoDoc

IDLE extension for go-imap.

This extension has been merged into go-imap. Use built-in support instead of this repository!

Usage

Client

// Let's assume c is an IMAP client
var c *client.Client

// Select a mailbox
if _, err := c.Select("INBOX", false); err != nil {
	log.Fatal(err)
}

idleClient := idle.NewClient(c)

// Create a channel to receive mailbox updates
updates := make(chan client.Update)
c.Updates = updates

// Start idling
done := make(chan error, 1)
go func() {
	done <- idleClient.IdleWithFallback(nil, 0)
}()

// Listen for updates
for {
	select {
	case update := <-updates:
		log.Println("New update:", update)
	case err := <-done:
		if err != nil {
			log.Fatal(err)
		}
		log.Println("Not idling anymore")
		return
	}
}

Server

s.Enable(idle.NewExtension())

License

MIT

# Functions

NewClient creates a new client.
No description provided by the author

# Constants

The IDLE capability.

# Structs

Client is an IDLE client.
An IDLE command.
No description provided by the author
An IDLE response.

# Type aliases

IdleClient is an alias used to compose multiple client extensions.