blacklight/aerc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

commands: add check-mail command

Browse source 
Add :check-mail command for ad-hoc checking of mail. Reset timer for
automatic checking if it is enabled.

Suggested-by: staceee
Signed-off-by: Tim Culverhouse <tim@timculverhouse.com>
Acked-by: Robin Jarry <robin@jarry.cc>
This commit is contained in:
Tim Culverhouse 2022-07-29 13:30:02 -05:00 committed by Robin Jarry
parent 44651b43b3
commit db195bebf0
4 changed files with 56 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- Read-only mbox backend support. - Read-only mbox backend support.
- Import/Export mbox files with `:import-mbox` and `:export-mbox`. - Import/Export mbox files with `:import-mbox` and `:export-mbox`.
- `address-book-cmd` can now also be specified in `accounts.conf`. - `address-book-cmd` can now also be specified in `accounts.conf`.
- Run `check-mail-cmd` with `:check-mail`.
### Changed ### Changed

31
commands/account/check-mail.go Normal file
View file

@ -0,0 +1,31 @@
package account
import (
"errors"
"git.sr.ht/~rjarry/aerc/widgets"
)
type CheckMail struct{}
func init() {
register(CheckMail{})
}
func (CheckMail) Aliases() []string {
return []string{"check-mail"}
}
func (CheckMail) Complete(aerc *widgets.Aerc, args []string) []string {
return nil
}
func (CheckMail) Execute(aerc *widgets.Aerc, args []string) error {
acct := aerc.SelectedAccount()
if acct == nil {
return errors.New("No account selected")
}
acct.CheckMailReset()
acct.CheckMail()
return nil
}

5
doc/aerc.1.scd
View file

@ -259,6 +259,11 @@ message list, the message in the message viewer, etc).
*cf* <folder> *cf* <folder>
Change the folder shown in the message list. Change the folder shown in the message list.
*check-mail*
Check for new mail on the selected account. Non-imap backends require
check-mail-cmd in order to check for new mail. Issuing a manual
:check-mail command will reset the timer for automatic checking.
*compose* [-H] [<body>] [-T <template-file>] *compose* [-H] [<body>] [-T <template-file>]
Open the compose window to send a new email. The new email will be sent with Open the compose window to send a new email. The new email will be sent with
the current account's outgoing transport configuration. For details on the current account's outgoing transport configuration. For details on

21
widgets/account.go
View file

@ -33,6 +33,10 @@ type AccountView struct {
state *statusline.State state *statusline.State
newConn bool // True if this is a first run after a new connection/reconnection newConn bool // True if this is a first run after a new connection/reconnection
uiConf *config.UIConfig uiConf *config.UIConfig
// Check-mail ticker
ticker *time.Ticker
checkingMail bool
} }
func (acct *AccountView) UiConfig() *config.UIConfig { func (acct *AccountView) UiConfig() *config.UIConfig {
@ -407,6 +411,9 @@ func (acct *AccountView) GetSortCriteria() []*types.SortCriterion {
} }
func (acct *AccountView) CheckMail() { func (acct *AccountView) CheckMail() {
if acct.checkingMail {
return
}
// Exclude selected mailbox, per IMAP specification // Exclude selected mailbox, per IMAP specification
exclude := append(acct.AccountConfig().CheckMailExclude, acct.dirlist.Selected()) exclude := append(acct.AccountConfig().CheckMailExclude, acct.dirlist.Selected())
dirs := acct.dirlist.List() dirs := acct.dirlist.List()
@ -419,11 +426,21 @@ func (acct *AccountView) CheckMail() {
Command: acct.acct.CheckMailCmd, Command: acct.acct.CheckMailCmd,
Timeout: acct.acct.CheckMailTimeout, Timeout: acct.acct.CheckMailTimeout,
} }
acct.checkingMail = true
acct.worker.PostAction(msg, func(_ types.WorkerMessage) { acct.worker.PostAction(msg, func(_ types.WorkerMessage) {
acct.SetStatus(statusline.ConnectionActivity("")) acct.SetStatus(statusline.ConnectionActivity(""))
acct.checkingMail = false
}) })
} }
// CheckMailReset resets the check-mail timer
func (acct *AccountView) CheckMailReset() {
if acct.ticker != nil {
d := acct.AccountConfig().CheckMail
acct.ticker = time.NewTicker(d)
}
}
func (acct *AccountView) checkMailOnStartup() { func (acct *AccountView) checkMailOnStartup() {
if acct.AccountConfig().CheckMail.Minutes() > 0 { if acct.AccountConfig().CheckMail.Minutes() > 0 {
acct.newConn = false acct.newConn = false
@ -432,9 +449,9 @@ func (acct *AccountView) checkMailOnStartup() {
} }
func (acct *AccountView) CheckMailTimer(d time.Duration) { func (acct *AccountView) CheckMailTimer(d time.Duration) {
ticker := time.NewTicker(d) acct.ticker = time.NewTicker(d)
go func() { go func() {
for range ticker.C { for range acct.ticker.C {
if !acct.state.Connected() { if !acct.state.Connected() {
continue continue
} }