Feature/signatures and folders per account

[notthatjesus]

What is it about

Support per account overrides of signatures and folders.

Signatures

This aims to support #16.

Config

A new block is supported under [[accounts]] called [accounts.signature_block]. If present, it will override the default signature block under [ui] and the legacy signature.
Example:

[[accounts]]
name = "Personal"
#... rest of configuration

[accounts.signature_block]
text = "*This is my Personal account signature*"
html = "<b>This is my personal HTML signature</b>"

New signature resolver method

A new method to resolve the signature is added to Config:

func (c *Config) Signature(a AccountConfig) SignatureConfig {
	if a.Signature.Text != "" || a.Signature.HTML != "" {
		return a.Signature
	}
	if c.UI.SignatureBlock.Text != "" || c.UI.SignatureBlock.HTML != "" {
		return c.UI.SignatureBlock
	}
	return SignatureConfig{Text: c.UI.Signature}
}

It returns a SignatureConfig with both text and html so the caller can decide which one to use.
Because account signature depends on the active account, the caller must pass the current active account.
The previous methods created in the UI to get the signature have been removed as this is covered directly by the new Config.Signature method.

Callers replacement

All the callers exist in model.go. These have been refactored to use the new Signature method.

Testing

I have added additional test cases to cover the resolution of the signature as well as the fall back to defaults.

Breaking changes

None. It fully supports previous configurations.

Folders

This supports overriding the name of the folders per-account. This feature is required due to the different naming between IMAP providers like Gmail using tags or Microsoft calling Sent folder Sent Items instead. When using multiple accounts, this is an issue.
This has been a bit more complex change due to two key points:

• The folders implementation was wired to the UI and not dependent on the active account.
• Folders are used all over the code, having to refactor many files.

Config file

A new block is supported under [[accounts]] called [accounts.folders]. If present, it will override the default [folders] for any specific folder defined. Currently only the following folders are possible to override:

• Sent
• Trash
• Drafts
• Spam

Example:

[[accounts]]
name = "Personal"
# ... rest of the config
[accounts.folders]
sent = "[Gmail]/Sent Mail"
trash = "[Gmail]/Trash"
drafts = "[Gmail]/Drafts"
spam = "[Gmail]/Spam"

# ...

[folders]
inbox = "INBOX"
sent = "Sent"
trash = "Trash"
drafts = "Drafts"
to_screen = "ToScreen"
feed = "Feed"
papertrail = "PaperTrail"
screened_out = "ScreenedOut"
archive = "Archive"
waiting = "Waiting"
scheduled = "Scheduled"
someday = "Someday"
spam = "Spam"

New Folders type and folders resolver method

A new type was created to represent the folders supported under the AccountConfig:

type AccountFoldersConfig struct {
	Sent   string `toml:"sent"`
	Trash  string `toml:"trash"`
	Drafts string `toml:"drafts"`
	Spam   string `toml:"spam"`
}

Additionally a new method is created under Config to resolve the folders for the account:

func (c *Config) ResolveFolders(a AccountConfig) FoldersConfig {
	out := c.Folders
	if a.Folders.Sent != "" {
		out.Sent = a.Folders.Sent
	}
	if a.Folders.Trash != "" {
		out.Trash = a.Folders.Trash
	}
	if a.Folders.Drafts != "" {
		out.Drafts = a.Folders.Drafts
	}
	if a.Folders.Spam != "" {
		out.Spam = a.Folders.Spam
	}
	return out
}

This resolver, given the account, will read the [folders] block and then override any folder that has been defined under [accounts.folders].

Callers replacement

This is quite a wide change given that folders are referenced in many places. I'll explain below the approach to this:

• Most of the callers, while not explicitly defined it, need to know what is the active account. Because the new feature requires it, the caller have been wrapped around ResolveFolders(), as an example, activeFolder().
• All M, gX motions as well as :go- commands have been refactored to go through the resolver.
• Trash and spam specific motions have been refactored to use the resolver.
• saveDraftCmd is modified to take config.AccountConfig instead of *imap.Client
• Fixed a small bug when switching between accounts as the active account was not passed properly.

Testing

I have covered all the folders affected and callers to make sure nothing breaks. Additionally ran smoke tests with two accounts and different folders setup. All seem OK but I'd appreciate to double check.

Breaking changes

None. Previous configuration is fully supported.

Notes

Fixed a small bug in the activeFolder() tab-labels. Drafts were missing.

[sspaeti]

Love it, thank you so much ! I'm a little short in time, but I will def. merge that

[notthatjesus]

Love it, thank you so much ! I'm a little short in time, but I will def. merge that

Take your time! You may want to have a look at the last commit. I thought it was a bug but I think you did that intentionally. However, the behavior was a bit odd, it was showing it was in Drafts while the inbox content was displayed.

[sspaeti]

Love it, thank you so much ! I'm a little short in time, but I will def. merge that

Take your time! You may want to have a look at the last commit. I thought it was a bug but I think you did that intentionally. However, the behavior was a bit odd, it was showing it was in Drafts while the inbox content was displayed.

Ahh yes, that was intentional that Draft and Spam do not show up as regular tabs (to make it minimal and to the most important folders). But you can always go to drafts with gd (or move Md) or to Spam with gS (or move/mark spam with $).

I think it's a bit hidden, tough once you know, or check the ? (help), you will find it. Hope that make sense? 😃