Popularity
7.6
Growing
Activity
7.6
Declining
839
34
127

Programming language: Go
Tags: Email    
Latest version: v1.0.2

go-imap alternatives and similar packages

Based on the "Email" category

Do you think we are missing an alternative of go-imap or a related project?

Add another 'Email' Package

README

go-imap

GoDoc builds.sr.ht status Codecov

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

go get github.com/emersion/go-imap/...

Usage

Client GoDoc

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 substract 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 GoDoc

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.

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

  • 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


*Note that all licence references and agreements mentioned in the go-imap README section above are relevant to that project's source code only.