sisito

Documentation

Index

• Constants
• func MergeRecipientAliases(recipientAlieses []Recipient) (merged []string)
• func NormalizeRecipient(recipient string) (normalized string)
• type AuthzConfig
• type BounceMail
• type Config
  • func LoadConfig(flags *Flags) (config *Config, err error)
• type DatabaseConfig
• type Driver
  • func NewDriver(config *Config, debug bool, out io.Writer) (driver *Driver, err error)
  • func (driver *Driver) BlacklistRecipients(senderdomain string, reasons []string, softbounce *bool, limit uint64, ...) (recipients []string, err error)
  • func (driver *Driver) Close()
  • func (driver *Driver) Listed(name string, value string, senderdomain string, useFilter bool) (listed bool, err error)
  • func (driver *Driver) RecentlyListed(name string, value string, senderdomain string, useFilter bool) (listed []BounceMail, err error)
• type FilterConfig
• type Flags
  • func ParseFlag() (flags *Flags)
• type Recipient
• type Server
  • func NewServer(config *Config, driver *Driver, out io.Writer) (server *Server)
  • func (server *Server) Blacklist(c *gin.Context)
  • func (server *Server) Listed(c *gin.Context)
  • func (server *Server) Ping(c *gin.Context)
  • func (server *Server) Recent(c *gin.Context)
  • func (server *Server) Run()
• type ServerConfig
• type UserConfig

Constants

const (
	DefaultConfig = "sisito-api.toml"
)

Functions

func MergeRecipientAliases

func MergeRecipientAliases(recipientAlieses []Recipient) (merged []string)

func NormalizeRecipient

func NormalizeRecipient(recipient string) (normalized string)

Types

type AuthzConfig

type AuthzConfig struct {
	Recent    bool
	Listed    bool
	Blacklist bool
}

type BounceMail

type BounceMail struct {
	Id             int32
	Timestamp      time.Time
	Lhost          string
	Rhost          string
	Alias          string
	Listid         string
	Reason         string
	Action         string
	Subject        string
	Messageid      string
	Smtpagent      string
	Softbounce     uint8
	Smtpcommand    string
	Destination    string
	Senderdomain   string
	Feedbacktype   string
	Diagnosticcode string
	Deliverystatus string
	Timezoneoffset string
	Addresser      string
	Addresseralias string
	Recipient      string
	Digest         string
	CreatedAt      time.Time `db:"created_at"`
	UpdatedAt      time.Time `db:"updated_at"`
	Whitelisted    uint8
}

type Config

type Config struct {
	Server   ServerConfig
	Database DatabaseConfig
	User     []UserConfig
	Filter   []FilterConfig
	Authz    AuthzConfig
}

func LoadConfig

func LoadConfig(flags *Flags) (config *Config, err error)

type DatabaseConfig

type DatabaseConfig struct {
	Host     string
	Port     int64
	Database string
	Username string
	Password string
	Timezone string
}

type Driver

type Driver struct {
	Config *Config
	DbMap  *gorp.DbMap
}

func NewDriver

func NewDriver(config *Config, debug bool, out io.Writer) (driver *Driver, err error)

func (*Driver) BlacklistRecipients

func (driver *Driver) BlacklistRecipients(senderdomain string, reasons []string, softbounce *bool, limit uint64, offset uint64, useFilter bool) (recipients []string, err error)

func (*Driver) Close

func (driver *Driver) Close()

func (*Driver) Listed

func (driver *Driver) Listed(name string, value string, senderdomain string, useFilter bool) (listed bool, err error)

func (*Driver) RecentlyListed

func (driver *Driver) RecentlyListed(name string, value string, senderdomain string, useFilter bool) (listed []BounceMail, err error)

type FilterConfig

type FilterConfig struct {
	Key      string
	Operator string
	Value    string
	Values   []string
	Join     string
	Sql      string
}

type Flags

type Flags struct {
	Config string
}

func ParseFlag

func ParseFlag() (flags *Flags)

type Recipient

type Recipient struct {
	Recipient string
	Alias     string
}

type Server

type Server struct {
	Engine *gin.Engine
	Driver *Driver
}

func NewServer

func NewServer(config *Config, driver *Driver, out io.Writer) (server *Server)

func (*Server) Blacklist

func (server *Server) Blacklist(c *gin.Context)

func (*Server) Listed

func (server *Server) Listed(c *gin.Context)

func (*Server) Ping

func (server *Server) Ping(c *gin.Context)

func (*Server) Recent

func (server *Server) Recent(c *gin.Context)

func (*Server) Run

func (server *Server) Run()

type ServerConfig

type ServerConfig struct {
	Log    string
	Gzip   bool
	Prefix string
}

type UserConfig

type UserConfig struct {
	Userid   string
	Password string
}