configedit

Documentation

Overview

Package configedit makes small, comment-preserving changes to a mailctl config file. It edits the YAML node tree rather than round-tripping through the config structs, which would delete every comment in the file.

Comments, key order, and quoting all survive an edit, because the yaml.Node tree carries them. Blank lines do not: yaml.Node has no node representing a blank line, so re-encoding the tree drops every blank line in the file, not just ones near the edited section. Callers that edit a hand-formatted file should tell the operator; see main's noteConfigRewritten.

Index

• func AddAlias(path, domain, match string, to []string) error
• func AddMailbox(path, domain, address, passwordEnv string) error
• func RemoveAlias(path, domain, match string) error
• func RemoveMailbox(path, domain, address string) error

Functions

func AddAlias

func AddAlias(path, domain, match string, to []string) error

AddAlias appends an alias to a domain.

func AddMailbox

func AddMailbox(path, domain, address, passwordEnv string) error

AddMailbox appends a mailbox to a domain.

func RemoveAlias

func RemoveAlias(path, domain, match string) error

RemoveAlias drops an alias from a domain.

func RemoveMailbox

func RemoveMailbox(path, domain, address string) error

RemoveMailbox drops a mailbox from a domain. It does not delete the mailbox at the provider; that happens on the next apply with -prune.