README
¶
POPgun
POPgun is a lightweight POP3 server implementation in Go. POPgun meets RFC1939 and was mainly created for develmail.com.
Getting Started
POPgun is meant to be used as a package and you need to create your own implementations
of Authorizator and Backend interfaces.
1. Import the POPgun package
import (
"github.com/DevelHell/popgun"
)
2. Implement Authorizator and Backend interfaces
Authorizator is used for user authorization and there's only one function Authorize(user, pass string). Be aware that single instance is shared
across all client connections.
Backend is used for mail storage access, e.g. database storage. Single Backend instance is shared across all client connections connections as well.
Example dummy implementations can be found in backend package, see comments in these files for more information. When your're done, create an instance of both of them:
backend := backends.DummyBackend{}
authorizator := backends.DummyAuthorizator{}
3. Configure and run the server
There is only one configuration field for now - ListenInterface, which defines interface (ip address) and port to listen on.
Server is started in separate go routine, so be sure to keep the server busy, e.g. using wait groups:
cfg := popgun.Config{
ListenInterface: "localhost:1100",
}
var wg sync.WaitGroup
wg.Add(1)
server := NewServer(cfg, authorizator, backend)
err := server.Start()
if err != nil {
log.Fatal(err)
return
}
wg.Wait()
Server is logging to stderr using log package.
License and Contribution
POPgun is released under MIT license. Feel free to fork, redistribute or contribute!
Documentation
¶
Index ¶
- Constants
- Variables
- type Authorizator
- type Backend
- type CapaCommand
- type Client
- type Config
- type DeleCommand
- type Executable
- type ListCommand
- type NoopCommand
- type PassCommand
- type Printer
- type QuitCommand
- type RetrCommand
- type RsetCommand
- type Server
- type StatCommand
- type UidlCommand
- type UserCommand
Constants ¶
const ( STATE_AUTHORIZATION = iota + 1 STATE_TRANSACTION STATE_UPDATE )
Variables ¶
var (
ErrInvalidState = fmt.Errorf("Invalid state")
)
Functions ¶
This section is empty.
Types ¶
type Authorizator ¶
type Backend ¶
type Backend interface {
Stat(user string) (messages, octets int, err error)
List(user string) (octets []int, err error)
ListMessage(user string, msgId int) (exists bool, octets int, err error)
Retr(user string, msgId int) (message string, err error)
Dele(user string, msgId int) error
Rset(user string) error
Uidl(user string) (uids []string, err error)
UidlMessage(user string, msgId int) (exists bool, uid string, err error)
Update(user string) error
Lock(user string) error
Unlock(user string) error
}
type CapaCommand ¶
type CapaCommand struct{}
type DeleCommand ¶
type DeleCommand struct{}
type ListCommand ¶
type ListCommand struct{}
type NoopCommand ¶
type NoopCommand struct{}
type PassCommand ¶
type PassCommand struct{}
type QuitCommand ¶
type QuitCommand struct{}
type RetrCommand ¶
type RetrCommand struct{}
type RsetCommand ¶
type RsetCommand struct{}
type StatCommand ¶
type StatCommand struct{}
type UidlCommand ¶
type UidlCommand struct{}
type UserCommand ¶
type UserCommand struct{}
Source Files
Directories