gozeloglu / gop-3

POP-3 client package for Go.

gop-3

Post Office Protocol - Version 3 (POP3) Go Client

GOP-3 (Go + POP-3) is a POP-3 client for Go. It has experimental purpose and it is still under development. RFC 1939 document has been followed while developing package.

Features - Commands

• USER
• PASS
• STAT
• LIST
• DELE
• RETR
• NOOP
• RSET
• QUIT
• TOP

Installation

You can download with the following command.

go get github.com/gozeloglu/gop-3

Example

package main

import (
	"fmt"
	"github.com/gozeloglu/gop-3"
	"log"
	"os"
)

func main() {
	pop, err := pop3.Connect("mail.pop3.com:110", nil, false)
	if err != nil {
		log.Fatalf(err.Error())
	}

	fmt.Println(pop.GreetingMsg())  // Message starts with "+OK"
	fmt.Println(pop.IsAuthorized()) // true
	fmt.Println(pop.IsEncrypted())  // false

	// USER command
	username := os.Getenv("POP3_USER") // Read from env
	u, err := pop.User(username)
	if err != nil {
		log.Fatalf(err.Error())
	}
	fmt.Println(u)

	// PASS command
	password := os.Getenv("POP3_PASSWORD") // Read from env
	pass, err := pop.Pass(password)
	if err != nil {
		log.Fatalf(err.Error())
	}
	fmt.Println(pass)

	// STAT command
	stat, err := pop.Stat()
	if err != nil {
		log.Fatalf(err.Error())
	}
	fmt.Println(stat)

	// LIST command
	l, _ := pop.List()
	if len(l) == 0 {
		fmt.Println(l)
	}

	// LIST <mail-num> command
	ll, _ := pop.List(1)
	fmt.Println(ll[0])
	
	// TOP msgNum n 
	top, _ := pop.Top(1, 10)
	fmt.Println(top)

	// DELE command
	dele, err := pop.Dele("1")
	if err != nil {
		log.Fatalf(err.Error())
	}
	fmt.Println(dele)

	// RETR command 
	retr, err := pop.Retr("1")
	if err != nil {
		log.Fatalf(err.Error())
	}
	for _, m := range retr {
		fmt.Println(m)
	}

	// NOOP command
	noop, err := pop.Noop()
	if err != nil {
		log.Fatalf(err.Error())
	}
	fmt.Println(noop)

	// RSET command
	rset, err := pop.Rset()
	if err != nil {
		log.Fatalf(err.Error())
	}
	fmt.Println(rset)

	// QUIT state
	q, err := pop.Quit()
	if err != nil {
		log.Fatalf(err.Error())
	}
	fmt.Println(q) // Prints: "QUIT"
}

Run & Test

Note: If you run the tests, you firstly need to have a GMail account that enables POP3 connections. Also, you have to save mail address and password in your local environment.

If you make changes, make sure that all tests are passed. You can run the tests with the following command.

go test pop3/* -v 

If you want to run only one test, you can type the following command.

go test pop3/* -v -run <test_function_name>

Example:

go test pop3/* -v -run TestStat

References

• RFC 1939 POP3

LICENSE

MIT

gop-3's Issues

Check TRANSACTION state

Some commands have a restriction that the command only returns the response in the TRANSACTION state.

Example Commands

• STAT, LIST, TOP, etc.

Reference

• https://www.ietf.org/rfc/rfc1939.txt