Skip to content

📥 An IMAP library for clients and servers

License

Notifications You must be signed in to change notification settings

LBeernaertProton/go-imap

This branch is 814 commits ahead of, 514 commits behind emersion/go-imap:v2.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

cc99410 · Apr 9, 2022
Oct 6, 2021
Sep 7, 2021
Sep 7, 2021
Sep 7, 2021
Oct 27, 2016
Sep 7, 2021
Jan 19, 2022
Feb 19, 2021
Apr 30, 2021
Jun 8, 2016
Jul 21, 2016
Oct 18, 2021
Jun 6, 2019
Jun 6, 2019
May 4, 2019
Mar 8, 2019
Aug 15, 2019
Oct 4, 2016
Oct 6, 2021
Oct 6, 2021
Sep 7, 2021
Oct 16, 2016
Dec 1, 2016
Apr 9, 2022
Jun 6, 2019
Apr 9, 2022
Nov 1, 2020
Jul 7, 2020
Jun 1, 2019
Jun 6, 2019
Jun 6, 2019
Jan 5, 2020
Jan 5, 2020
Dec 1, 2017
Jun 7, 2017
May 11, 2020
Jun 6, 2019
Dec 1, 2019
Jun 10, 2019

Repository files navigation

go-imap

godocs.io builds.sr.ht status

An IMAP4rev1 library written in Go. It can be used to build a client and/or a server.

Usage

Client godocs.io

package main

import (
	"log"

	"github.com/emersion/go-imap/client"
	"github.com/emersion/go-imap"
)

func main() {
	log.Println("Connecting to server...")

	// Connect to server
	c, err := client.DialTLS("mail.example.org:993", nil)
	if err != nil {
		log.Fatal(err)
	}
	log.Println("Connected")

	// Don't forget to logout
	defer c.Logout()

	// Login
	if err := c.Login("username", "password"); err != nil {
		log.Fatal(err)
	}
	log.Println("Logged in")

	// List mailboxes
	mailboxes := make(chan *imap.MailboxInfo, 10)
	done := make(chan error, 1)
	go func () {
		done <- c.List("", "*", mailboxes)
	}()

	log.Println("Mailboxes:")
	for m := range mailboxes {
		log.Println("* " + m.Name)
	}

	if err := <-done; err != nil {
		log.Fatal(err)
	}

	// Select INBOX
	mbox, err := c.Select("INBOX", false)
	if err != nil {
		log.Fatal(err)
	}
	log.Println("Flags for INBOX:", mbox.Flags)

	// Get the last 4 messages
	from := uint32(1)
	to := mbox.Messages
	if mbox.Messages > 3 {
		// We're using unsigned integers here, only subtract if the result is > 0
		from = mbox.Messages - 3
	}
	seqset := new(imap.SeqSet)
	seqset.AddRange(from, to)

	messages := make(chan *imap.Message, 10)
	done = make(chan error, 1)
	go func() {
		done <- c.Fetch(seqset, []imap.FetchItem{imap.FetchEnvelope}, messages)
	}()

	log.Println("Last 4 messages:")
	for msg := range messages {
		log.Println("* " + msg.Envelope.Subject)
	}

	if err := <-done; err != nil {
		log.Fatal(err)
	}

	log.Println("Done!")
}

Server godocs.io

package main

import (
	"log"

	"github.com/emersion/go-imap/server"
	"github.com/emersion/go-imap/backend/memory"
)

func main() {
	// Create a memory backend
	be := memory.New()

	// Create a new server
	s := server.New(be)
	s.Addr = ":1143"
	// Since we will use this server for testing only, we can allow plain text
	// authentication over unencrypted connections
	s.AllowInsecureAuth = true

	log.Println("Starting IMAP server at localhost:1143")
	if err := s.ListenAndServe(); err != nil {
		log.Fatal(err)
	}
}

You can now use telnet localhost 1143 to manually connect to the server.

Extensions

Support for several IMAP extensions is included in go-imap itself. This includes:

Support for other extensions is provided via separate packages. See below.

Extending go-imap

Extensions

Commands defined in IMAP extensions are available in other packages. See the wiki to learn how to use them.

Server backends

Related projects

  • go-message - parsing and formatting MIME and mail messages
  • go-msgauth - handle DKIM, DMARC and Authentication-Results
  • go-pgpmail - decrypting and encrypting mails with OpenPGP
  • go-sasl - sending and receiving SASL authentications
  • go-smtp - building SMTP clients and servers

License

MIT

About

📥 An IMAP library for clients and servers

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%