config

package

v0.5.1 Latest Latest Go to latest Published: Jun 6, 2023 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bjw-s/kobomail

Links

Open Source Insights

Documentation ¶

Overview ¶

Package config implements all configuration aspects of KoboMail

Index ¶

Constants
type Config
- func LoadConfig(flags *flag.FlagSet) (*Config, error)
type EmailFlagType

Constants ¶

View Source

const (
	DefaultAddonPath   = "/mnt/onboard/.adds/kobomail"
	DefaultLibraryPath = "/mnt/onboard/KoboMailLibrary"
)

Set default paths

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶ added in v0.5.0

type Config struct {
	IMAPConfig        imapConfigSection        `koanf:"imap_config" validate:"required"`
	ProcessingConfig  processingConfigSection  `koanf:"processing_config" validate:"required"`
	ApplicationConfig applicationConfigSection `koanf:"application_config" validate:"required"`
	// contains filtered or unexported fields
}

Config config struct

func LoadConfig ¶ added in v0.5.0

func LoadConfig(flags *flag.FlagSet) (*Config, error)

LoadConfig instantiates a new Config

func (Config) Messages ¶ added in v0.5.0

func (c Config) Messages() map[string]string

func (*Config) Validate ¶ added in v0.5.0

func (c *Config) Validate() validate.Errors

Validate returns if the given configuration is valid and any validation errors

func (Config) ValidateFolder ¶ added in v0.5.0

func (c Config) ValidateFolder(val string) bool

ValidateFolder validates that the path is a valid folder

func (Config) ValidateLogLevel ¶ added in v0.5.0

func (c Config) ValidateLogLevel(val string) bool

ValidateLogLevel validates that the log level is one of the valid log levels

type EmailFlagType ¶

type EmailFlagType string

EmailFlagType enum

const (
	EmailFlagTypePlus    EmailFlagType = "plus"
	EmailFlagTypeSubject EmailFlagType = "subject"
)

EmailFlagType enum values

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL