config

Documentation

Index

• Variables
• func LoadConfig(filename string) error
• type DataStoreConfig
  • func GetDataStoreConfig() DataStoreConfig
• type Pop3Config
  • func GetPop3Config() Pop3Config
• type SmtpConfig
  • func GetSmtpConfig() SmtpConfig
• type WebConfig
  • func GetWebConfig() WebConfig

Variables

var (
	// Build info, set by main
	VERSION    = ""
	BUILD_DATE = ""

	// Global goconfig object
	Config *config.Config
)

Functions

func LoadConfig

func LoadConfig(filename string) error

LoadConfig loads the specified configuration file into inbucket.Config and performs validations on it.

Types

type DataStoreConfig

type DataStoreConfig struct {
	Path             string
	RetentionMinutes int
	RetentionSleep   int
	MailboxMsgCap    int
}

func GetDataStoreConfig

func GetDataStoreConfig() DataStoreConfig

GetDataStoreConfig returns a copy of the DataStoreConfig object

type Pop3Config

type Pop3Config struct {
	Ip4address     net.IP
	Ip4port        int
	Domain         string
	MaxIdleSeconds int
}

func GetPop3Config

func GetPop3Config() Pop3Config

GetPop3Config returns a copy of the Pop3Config object

type SmtpConfig

type SmtpConfig struct {
	Ip4address      net.IP
	Ip4port         int
	Domain          string
	DomainNoStore   string
	MaxRecipients   int
	MaxIdleSeconds  int
	MaxMessageBytes int
	StoreMessages   bool
}

SmtpConfig houses the SMTP server configuration - not using pointers so that I can pass around copies of the object safely.

func GetSmtpConfig

func GetSmtpConfig() SmtpConfig

GetSmtpConfig returns a copy of the SmtpConfig object

type WebConfig

type WebConfig struct {
	Ip4address    net.IP
	Ip4port       int
	TemplateDir   string
	TemplateCache bool
	PublicDir     string
	GreetingFile  string
}

func GetWebConfig

func GetWebConfig() WebConfig

GetWebConfig returns a copy of the WebConfig object