config

Documentation

Index

• Variables
• func GetLogLevel() string
• 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 (
	// Version of this build, set by main
	Version = ""

	// BuildDate for this build, set by main
	BuildDate = ""

	// Config is our global robfig/config object
	Config *config.Config
)

Functions

func GetLogLevel

func GetLogLevel() string

GetLogLevel returns the configured log level

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
}

DataStoreConfig contains the mail store configuration

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
}

POP3Config contains the POP3 server configuration

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 contains the SMTP server configuration - not using pointers so that we 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
	MailboxPrompt  string
	CookieAuthKey  string
	MonitorVisible bool
	MonitorHistory int
}

WebConfig contains the HTTP server configuration

func GetWebConfig

func GetWebConfig() WebConfig

GetWebConfig returns a copy of the WebConfig object