emersion / go-imap Goto Github PK

View Code? Open in Web Editor NEW

2.0K 48.0 282.0 1.74 MB

📥 An IMAP library for clients and servers

License: MIT License

Go 100.00%

imap client server mail

go-imap's Introduction

go-imap

An IMAP4rev2 library for Go.

Note This is the README for go-imap v2. This new major version is still in development. For go-imap v1, see the v1 branch.

Usage

To add go-imap to your project, run:

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

Documentation and examples for the module are available here:

License

MIT

go-imap's People

Contributors

Stargazers

Watchers

Forkers

wheelcomplex ligadous chris-garrett zhj4478 gitter-badger ferhatelmas manishrjain sotolitolabs redsift ofsahin icecream78 donghui mahmoudhossam nevernet gophersgang thebrave sakti jim-minter iotmaster ineiti advancedlogic bakul pipergate lucasdss protonmail chenguifeng douglas-larocca juyufeng phpnewnew sefasenturk95 yangwugui cseeger-epages wjybluse bong106 renesugar marcelomata priestd09 markxnelson loweel linecode antihax goglue wallix mbhatia duesee firedemonsu farfar23 migzone ihippik tsinghoo iketutg crawshaw smlrepo pabluk iamanujvrma azurecloudmonk jangocheng davemckeown chirpeur xerpch imjorge sbinet-xyz linuxtea codelingobot foxcpp neopallium friendlydan spankders daanikus codelingoteam leonee sbioa1234 wucdbm hotion obukhov-sergey weihaitong dolanor-galaxy mr9697 johnjjung mmasztalerczuk lucifinil-long artpar woshizilong linwenming cnt0 fireword chenjie4255 smartfish kidothunder quite coinsgo xaeonn schollz danielkucera nicolascb steffenfritz backwardn xiaobin-qmcx kadeatfox muellerj

go-imap's Issues

Implement UTF8=ACCEPT capability

See https://tools.ietf.org/html/rfc6855

Add Deadline support

Add ability to specify a deadline for connections. According to the RFC, should be at least 30 min (https://tools.ietf.org/html/rfc3501#section-5.4).

Implement IMAP LIST Extension for Special-Use Mailboxes

See https://tools.ietf.org/html/rfc6154

Find a way to allow third-party packages to extend server.Conn

ID extension needs to store IDs for each conn
ENABLE extension needs to keep a list of enabled extensions for each conn

Make imap.MailboxStatus extendable

Make it a map? (like https://golang.org/pkg/net/mail/#Header)
- Would require a lot of getters and setters :(
- See 8d1e889
Use an interface?
- Would require also getters and setters
Mix a struct and a map?
- Keep current fields, ie. keep backwards compatibility
- Add a Items map[string]interface{} field which contains all items and their values
- See f051cce
Find a better solution?

Implement IMAP COMPRESS Extension

See https://tools.ietf.org/html/rfc4978

Add Client.Logger and Server.Logger

This will allow to turn off logs or redirect them. Same thing as http.Server.

Make imap.Message extendable

Make it a map?
Make it an interface?

Related to #57

Add a write lock

Currently sending two responses at the same time will lead to undefined behavior on the server. Att a write lock to prevent bad things to happen. Beware of deadlocks.

Do not panic when parsing

If the IMAP server is sending bad data, do not panic when parsing. Change str := val.(string) to str, _ := val.(string).

Implement IMAP MOVE Extension

See https://tools.ietf.org/html/rfc6851

Implement some SASL mechanisms

See https://github.com/xarg/imap/blob/4622542db1f661e5cf9ec7de8127056c595fcfb8/sasl.go

PLAIN
EXTERNAL
XOAUTH2

Implement IMAP Child Mailbox Extension

See https://tools.ietf.org/html/rfc3348

Fetching a partial BODY returns an error

When fetching BODY.PEEK[]<0.8>, the client fails when parsing the server's BODY[]<0> {8} response.

server.go:

package main

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

func main() {
    bkd := memory.New()
    s := server.New(bkd)
    s.Addr = ":3000"
    s.AllowInsecureAuth = true
    log.Println("Starting IMAP server at localhost:3000")
    if err := s.ListenAndServe(); err != nil {
        log.Fatal(err)
    }
}

client.go:

package main

import (
    "github.com/emersion/go-imap"
    "github.com/emersion/go-imap/client"
    "log"
    "os"
)

func main() {
    c, _ := client.Dial("localhost:3000")
    c.SetDebug(os.Stderr)
    c.Login("username", "password")
    c.Select("INBOX", false)
    seqset, _ := imap.NewSeqSet("1:*")
    messages := make(chan *imap.Message)
    done := make(chan error, 1)
    go func() {
        done <- c.Fetch(seqset, []string{"BODY.PEEK[]<0.8>"}, messages)
    }()
    for msg := range messages {
        log.Println("MESSAGE: %v", msg) // expected: a message
    }
    if err := <-done; err != nil {
        log.Fatal(err) // got: Invalid body section name: partial must have two fields
    }
}

stderr:

Kj3K0Q LOGIN username password
5SektA SELECT INBOX
* FLAGS (\Answered \Flagged \Deleted \Seen \Draft)
* OK [PERMANENTFLAGS (\Answered \Flagged \Deleted \Seen \Draft \*)] Flags permitted.
* 1 EXISTS
* 0 RECENT
* OK [UNSEEN 0] 
* OK [UIDNEXT 7] Predicted next UID
* OK [UIDVALIDITY 1] UIDs valid
5SektA OK [READ-WRITE] SELECT completed
SwWRDQ FETCH 1:* (BODY.PEEK[]<0.8>)
* 1 FETCH (BODY[]<0> {8}
From: co)
<0>
SwWRDQ OK FETCH completed
2016/09/23 21:44:08 Invalid body section name: partial must have two fields
exit status 1

Better BODY[part]<range> support in FETCH

Currently the backend has to parse it

Add Close() and Logout() methods to Mailbox and User

Add an extension interface

Add a Server.Enable(extension Extension) method.

type Extension interface {
    Capabilities(state common.ConnState) []string
    Commands() map[string]HandlerFactory
}

APPEND test fails in rare cases

It timeouts.

Example: https://travis-ci.org/emersion/go-imap/builds/146058423

Implement IMAP4 IDLE command

See https://tools.ietf.org/html/rfc2177

how to parse msg.body

err = c.Fetch(seqset, []string{"ENVELOPE", "RFC822.HEADER", "RFC822.TEXT"}, messages)
    if err != nil {
        log.Fatal(err)
    }

for msg := range messages {
        log.Println(msg.Envelope.Subject)
        //log.Println(msg.Body) 
    }

msg.body return text how to parse email body get struct

thk

Handle all unilateral responses

Info: * OK [ALERT] System shutdown in 10 minutes
Warning: * NO Disk is 98% full, please delete unnecessary data
Protocol-level error/internal server failure: * BAD Disk crash, attempting salvage to a new disk!
Server closing connection: * BYE Autologout; idle for too long
Number of messages: * 23 EXISTS
Number of \Recent: * 5 RECENT
Message deleted: * 44 EXPUNGE
~~Message update (e.g. flags): * 23 FETCH (FLAGS (\Seen))~~ (#5)

Rename MailboxInfo.Flags to MailboxInfo.Attributes

Not to be confused with MailboxStatus.Flags.

Implement IMAP4 QUOTA extension

See https://tools.ietf.org/html/rfc2087

Add helper functions to broadcast Updates

Implement IMAP ENABLE Extension

See https://tools.ietf.org/html/rfc5161

Tests for unilateral server updates

Use net/textproto

Make use of textproto.Reader, textproto.Writer and textproto.Pipeline.

Replace Id, SeqId by SeqNum

In several parts of the code, Id or SeqId is used. This is confusing since the RFC only uses the term sequence number. Replace those with SeqNum.

Wait for continuation request from server before sending literal

How to authenticate with this capabilities?

CAPABILITY IMAP4rev1 LITERAL+ SASL-IR LOGIN-REFERRALS ID ENABLE IDLE STARTTLS LOGINDISABLED

I can't use Login function. And I don't understand how to use Authenticate

Thunderbird connects to server by STARTTLS using login and password w/o encryption.

Please, help me to connect to my imap server.

Encode UTF-8 strings to literals

Add a way to force quoted string

Thunderbird doesn't accept / as an atom for mailbox delimiter. Add a Quoted type that forces the use of quoted strings.

Exchange 2013: The specified charset is not supported.

It looks like ms exchange does not like searching with UTF-8. I have found a few pages out there talking about it.

https://social.technet.microsoft.com/Forums/en-US/00bb2ec5-9951-40b4-8ec3-97e5a8f1a59f/imap-search-with-utf8?forum=exchangesvrsecuremessaging
MatterMail (which wraps mxk/go-imap) is trying UTF-8 first and then falling back to US-ASCII. rodcorsi/mattermail#7

Block caused when error chan is not empty

I have this code:

func RetrieveFolders(c *client.Client, folder string) []string {
    var folders []string
    mailboxes := make(chan *imap.MailboxInfo)

    go func() {
        c.List("", folder, mailboxes)
    }()

    for mailbox := range mailboxes {
        folders = append(folders, mailbox.Name)
    }

    return folders
}

func RetrieveMessages(c *client.Client, folder string, start, end uint32) ([]*imap.Message, error) {
    var emails []*imap.Message
    _, err := c.Select(folder, true)
    if err != nil {
        return nil, err
    }

    seqset, _ := imap.NewSeqSet("")
    seqset.AddRange(start, end)

    messages := make(chan *imap.Message, end - start)
    err = c.Fetch(seqset, []string{"ENVELOPE"}, messages)
    if err != nil {
        return nil, err
    }

    for msg := range messages {
        emails = append(emails, msg)
    }

    return emails, nil
}

This code returns these error when fetch folders:

imap/client: 2016/09/08 17:25:52 response has not been handled:  &{* OK HIGHESTMODSEQ [268] Highest}
imap/client: 2016/09/08 17:25:56 response has not been handled:  &{* OK CLOSED [] Previous mailbox closed.}
imap/client: 2016/09/08 17:25:56 response has not been handled:  &{* OK HIGHESTMODSEQ [1178] Highest}

When I fetch emails from IMAP folder, this code remains blocked because code in this point remain in waiting state. There is a way to solve the problem?

Add CAPABILITY code to LOGIN response

Handle unilateral message updates

* 23 FETCH (FLAGS (\Seen))

Panic when sending a FETCH

7.810 UID FETCH 72,79:82 (BODY.PEEK[] BODYSTRUCTURE)
^Cpanic: runtime error: invalid memory address or nil pointer dereference
[signal 0xb code=0x1 addr=0x0 pc=0x4150c7c]

goroutine 31 [running]:
panic(0x46026a0, 0xc8200120c0)
    /usr/local/Cellar/go/1.6.2/libexec/src/runtime/panic.go:481 +0x3e6
github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap.(*Envelope).Format(0x0, 0x0, 0x0, 0x0)
    /Users/Yanfeng/.go/src/github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/message.go:513 +0x79c
github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap.(*BodyStructure).Format(0xc820309b20, 0xc820297420, 0x7, 0x7)
    /Users/Yanfeng/.go/src/github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/message.go:841 +0xc66
github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap.(*BodyStructure).Format(0xc820309960, 0xc820365ec0, 0x1, 0x1)
    /Users/Yanfeng/.go/src/github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/message.go:812 +0x106
github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap.(*Message).Format(0xc8201d60e0, 0x0, 0x0, 0x0)
    /Users/Yanfeng/.go/src/github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/message.go:144 +0x85e
github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/responses.(*Fetch).WriteTo(0xc8200ec098, 0x5605428, 0xc820394580, 0x0, 0x0)
    /Users/Yanfeng/.go/src/github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/responses/fetch.go:45 +0xc1
github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/server.(*conn).WriteResp(0xc820366c80, 0x545eb40, 0xc8200ec098, 0x0, 0x0)
    /Users/Yanfeng/.go/src/github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/server/conn.go:120 +0xe3
github.com/ProtonMail/secret-project/vendor/github.com/ProtonMail/go-imap-id.(*conn).WriteResp(0xc820394600, 0x545eb40, 0xc8200ec098, 0x0, 0x0)
    <autogenerated>:17 +0x6f
github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/server.(*Fetch).handle.func1(0xc820422300, 0x56056e8, 0xc820394600, 0xc8200ec098)
    /Users/Yanfeng/.go/src/github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/server/cmd_selected.go:161 +0x5c
created by github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/server.(*Fetch).handle
    /Users/Yanfeng/.go/src/github.com/ProtonMail/secret-project/vendor/github.com/emersion/go-imap/server/cmd_selected.go:163 +0x14a
exit status 2