tui

package
v0.36.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 3, 2026 License: MIT Imports: 30 Imported by: 0

README

tui

The tui package contains all terminal user interface components built with the Bubble Tea framework. Each file implements a self-contained view or component following the Bubble Tea Model-View-Update (MVU) pattern.

Architecture

The TUI layer is the interactive frontend of Matcha. Each view implements the tea.Model interface (Init, Update, View) and communicates with other views through typed messages. The main application (main.go) orchestrates navigation between views by swapping the active model.

Views
File Description
inbox.go Email inbox list with multi-account tab support. Handles pagination, keyboard navigation, and renders email items with sender, subject, and date. Supports different mailbox types (inbox, sent, trash, archive) and both multi-account and single-account modes.
email_view.go Full email display in a scrollable viewport. Shows headers (from, to, subject, date), rendered body content, attachment list, and S/MIME verification status. Manages inline image rendering through out-of-band stdout writes.
composer.go Email composition form with fields for To, CC, BCC, Subject, and Body. Features contact autocomplete, file attachment picker, signature insertion, account selection dropdown, and draft auto-saving. Supports reply mode with pre-filled headers and quoted text.
drafts.go Draft email list view. Displays saved drafts with subject, recipient, and timestamp. Allows opening drafts in the composer or deleting them.
folder_inbox.go Folder navigation sidebar with an email list. Displays IMAP folders in a left panel and the selected folder's emails in the main area. Handles folder selection and email loading per folder.
trash_archive.go Combined trash and archive view with tab-based switching between the two. Shares the inbox component structure but targets trash/archive mailboxes.
login.go Account login form supporting Gmail, iCloud, and custom IMAP/SMTP providers. Collects credentials, server settings, and optionally S/MIME certificate paths. Validates input before submission.
settings.go Settings panel for managing accounts (add/remove), configuring mailing lists, editing signatures, toggling image display, managing tips visibility, and setting up S/MIME certificates.
mailing_list.go Editor for creating and modifying mailing list groups (name + comma-separated email addresses).
choice.go Main menu / start screen. Presents account selection, navigation to inbox, compose, drafts, marketplace, sent, folders, trash/archive, and settings.
marketplace.go Plugin marketplace browser. Fetches the plugin registry from GitHub, displays a scrollable list with install status badges, and installs plugins on selection. Can run standalone (matcha marketplace) or from the main menu.
filepicker.go File browser for selecting email attachments. Navigates the filesystem with directory listing and file selection.
Supporting Files
File Description
styles.go Global Lip Gloss style definitions used across all views (dialog boxes, help text, tips, headings, body text). Also defines the Status component for spinner-based loading messages.
theme.go RebuildStyles function that updates all package-level style variables when the active theme changes, ensuring consistent colors across the UI.
messages.go Shared message types for inter-component communication: ViewEmailMsg, SendEmailMsg, Credentials, ChooseServiceMsg, EmailResultMsg, ClearStatusMsg, GoToMarketplaceMsg, and the MailboxKind enum.
signature.go Textarea-based editor for composing and saving email signatures.
Test Files
File Description
inbox_test.go Tests for inbox rendering and behavior.
email_view_test.go Tests for email view rendering.
composer_test.go Tests for email composition logic.
trash_archive_test.go Tests for trash/archive view behavior.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	DialogBoxStyle = lipgloss.NewStyle().
					Border(lipgloss.RoundedBorder()).
					BorderForeground(lipgloss.Color("#25A065")).
					Padding(1, 2).
					BorderTop(true).
					BorderLeft(true).
					BorderRight(true).
					BorderBottom(true)

	HelpStyle    = lipgloss.NewStyle().Foreground(lipgloss.Color("240"))
	TipStyle     = lipgloss.NewStyle().Foreground(lipgloss.Color("214")).Italic(true)
	SuccessStyle = lipgloss.NewStyle().Foreground(lipgloss.Color("42")).Bold(true)
	InfoStyle    = lipgloss.NewStyle().Foreground(lipgloss.Color("42")).Bold(true)

	H1Style = lipgloss.NewStyle().
			Foreground(lipgloss.Color("42")).
			Bold(true).
			Align(lipgloss.Center)

	H2Style = lipgloss.NewStyle().
			Foreground(lipgloss.Color("42")).
			Bold(false).
			Align(lipgloss.Center)

	BodyStyle = lipgloss.NewStyle().
				Bold(true) // A bit bold
)
View Source 
var DocStyle = lipgloss.NewStyle().Margin(1, 2)

Functions

func ClearKittyGraphics added in v0.21.1 

func ClearKittyGraphics()

ClearKittyGraphics sends the Kitty graphics protocol delete command directly to stdout.

func RebuildStyles added in v0.24.0 

func RebuildStyles()

RebuildStyles updates all package-level style variables to match the active theme. This must be called after theme.SetTheme() and at startup.

func ThemedTextAreaStyles added in v0.27.3 

func ThemedTextAreaStyles() textarea.Styles

ThemedTextAreaStyles returns textarea.Styles using the active theme colors.

func ThemedTextInputStyles added in v0.27.3 

func ThemedTextInputStyles() textinput.Styles

ThemedTextInputStyles returns textinput.Styles using the active theme colors.

Types

type AccountAddedMsg added in v0.8.0 

type AccountAddedMsg struct {
	AccountID string
	Err       error
}

AccountAddedMsg signals that an account was successfully added.

type AccountDeletedMsg added in v0.8.0 

type AccountDeletedMsg struct {
	AccountID string
	Err       error
}

AccountDeletedMsg signals that an account was successfully deleted.

type AccountTab added in v0.8.0 

type AccountTab struct {
	ID    string
	Label string
	Email string
}

AccountTab represents a tab for an account

type AddAccountMsg added in v0.8.0 

type AddAccountMsg struct {
	Credentials Credentials
}

AddAccountMsg signals that a new account should be added.

type AllEmailsFetchedMsg added in v0.8.0 

type AllEmailsFetchedMsg struct {
	EmailsByAccount map[string][]fetcher.Email
	Mailbox         MailboxKind
}

AllEmailsFetchedMsg signals that emails from all accounts have been fetched.

type ApplySearchResultsMsg added in v0.36.0 

type ApplySearchResultsMsg struct {
	Query  backend.SearchQuery
	Emails []fetcher.Email
}

type ArchiveEmailMsg 

type ArchiveEmailMsg struct {
	UID       uint32
	AccountID string
	Mailbox   MailboxKind
}

type AttachmentDownloadedMsg 

type AttachmentDownloadedMsg struct {
	Path string
	Err  error
}

type BackToInboxMsg 

type BackToInboxMsg struct{}

type BackToMailboxMsg added in v0.10.0 

type BackToMailboxMsg struct {
	Mailbox MailboxKind
}

type BatchArchiveEmailsMsg added in v0.32.0 

type BatchArchiveEmailsMsg struct {
	UIDs      []uint32
	AccountID string
	Mailbox   MailboxKind
}

type BatchDeleteEmailsMsg added in v0.32.0 

type BatchDeleteEmailsMsg struct {
	UIDs      []uint32
	AccountID string
	Mailbox   MailboxKind
}

Batch operation messages

type BatchEmailActionDoneMsg added in v0.32.0 

type BatchEmailActionDoneMsg struct {
	Count        int
	SuccessCount int
	FailureCount int
	Action       string // "delete", "archive", or "move"
	Mailbox      MailboxKind
	Err          error
}

type BatchMoveEmailsMsg added in v0.32.0 

type BatchMoveEmailsMsg struct {
	UIDs         []uint32
	AccountID    string
	SourceFolder string
	DestFolder   string
}

type CachedEmailsLoadedMsg added in v0.8.0 

type CachedEmailsLoadedMsg struct {
	Cache *config.EmailCache
}

CachedEmailsLoadedMsg signals that cached emails were loaded from disk.

type CancelFilePickerMsg 

type CancelFilePickerMsg struct{}

type Choice 

type Choice struct {
	UpdateAvailable bool
	LatestVersion   string
	CurrentVersion  string
	// contains filtered or unexported fields
}

func NewChoice 

func NewChoice() Choice

func (Choice) Init 

func (m Choice) Init() tea.Cmd

func (Choice) Update 

func (m Choice) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Choice) View 

func (m Choice) View() tea.View

type ChooseServiceMsg 

type ChooseServiceMsg struct {
	Service string
}

type ClearStatusMsg 

type ClearStatusMsg struct{}

type Composer 

type Composer struct {
	// contains filtered or unexported fields
}

Composer model holds the state of the email composition UI.

func NewComposer 

func NewComposer(from, to, subject, body string, hideTips bool) *Composer

NewComposer initializes a new composer model.

func NewComposerFromDraft added in v0.8.0 

func NewComposerFromDraft(draft config.Draft, accounts []config.Account, hideTips bool) *Composer

NewComposerFromDraft creates a composer from an existing draft.

func NewComposerWithAccounts added in v0.8.0 

func NewComposerWithAccounts(accounts []config.Account, selectedAccountID string, to, subject, body string, hideTips bool) *Composer

NewComposerWithAccounts initializes a composer with multiple account support.

func (*Composer) GetAttachmentPaths added in v0.21.0 

func (m *Composer) GetAttachmentPaths() []string

GetAttachmentPaths returns the current attachment paths.

func (*Composer) GetBcc added in v0.30.0 

func (m *Composer) GetBcc() string

GetBcc returns the current Bcc field value.

func (*Composer) GetBody added in v0.8.0 

func (m *Composer) GetBody() string

GetBody returns the current Body field value.

func (*Composer) GetCc added in v0.30.0 

func (m *Composer) GetCc() string

GetCc returns the current Cc field value.

func (*Composer) GetDraftID added in v0.8.0 

func (m *Composer) GetDraftID() string

GetDraftID returns the draft ID for this composer.

func (*Composer) GetInReplyTo added in v0.8.0 

func (m *Composer) GetInReplyTo() string

GetInReplyTo returns the In-Reply-To header value.

func (*Composer) GetQuotedText added in v0.13.5 

func (m *Composer) GetQuotedText() string

GetQuotedText returns the hidden quoted text.

func (*Composer) GetReferences added in v0.8.0 

func (m *Composer) GetReferences() []string

GetReferences returns the References header values.

func (*Composer) GetSelectedAccountID added in v0.8.0 

func (m *Composer) GetSelectedAccountID() string

GetSelectedAccountID returns the ID of the currently selected account.

func (*Composer) GetSignature added in v0.15.0 

func (m *Composer) GetSignature() string

GetSignature returns the current signature value.

func (*Composer) GetSubject added in v0.8.0 

func (m *Composer) GetSubject() string

GetSubject returns the current Subject field value.

func (*Composer) GetTo added in v0.8.0 

func (m *Composer) GetTo() string

GetTo returns the current To field value.

func (*Composer) HidePluginPrompt added in v0.31.0 

func (m *Composer) HidePluginPrompt()

HidePluginPrompt deactivates the plugin prompt overlay.

func (*Composer) Init 

func (m *Composer) Init() tea.Cmd

func (*Composer) ResetConfirmation 

func (m *Composer) ResetConfirmation()

ResetConfirmation ensures a restored draft isnt stuck in the exit prompt.

func (*Composer) SetAccounts added in v0.8.0 

func (m *Composer) SetAccounts(accounts []config.Account)

SetAccounts sets the available accounts for sending.

func (*Composer) SetBcc added in v0.30.0 

func (m *Composer) SetBcc(bcc string)

SetBcc updates the Bcc field with new content.

func (*Composer) SetBody added in v0.28.0 

func (m *Composer) SetBody(body string)

SetBody updates the Body field with new content.

func (*Composer) SetCc added in v0.30.0 

func (m *Composer) SetCc(cc string)

SetCc updates the Cc field with new content.

func (*Composer) SetDraftID added in v0.8.0 

func (m *Composer) SetDraftID(id string)

SetDraftID sets the draft ID (for loading existing drafts).

func (*Composer) SetFromOverride added in v0.36.1 

func (m *Composer) SetFromOverride(addr string)

SetFromOverride pre-fills the editable From field (used for catch-all replies).

func (*Composer) SetPluginKeyBindings added in v0.30.0 

func (m *Composer) SetPluginKeyBindings(bindings []PluginKeyBinding)

SetPluginKeyBindings sets the plugin-registered key bindings for display in the help bar.

func (*Composer) SetPluginStatus added in v0.28.0 

func (m *Composer) SetPluginStatus(status string)

SetPluginStatus sets a persistent status string from plugins, shown in the help bar.

func (*Composer) SetQuotedText added in v0.13.5 

func (m *Composer) SetQuotedText(text string)

SetQuotedText sets the hidden quoted text that will be appended when sending.

func (*Composer) SetReplyContext added in v0.8.0 

func (m *Composer) SetReplyContext(inReplyTo string, references []string)

SetReplyContext sets the reply context for the draft.

func (*Composer) SetSelectedAccount added in v0.8.0 

func (m *Composer) SetSelectedAccount(accountID string)

SetSelectedAccount sets the selected account by ID.

func (*Composer) SetSubject added in v0.30.0 

func (m *Composer) SetSubject(subject string)

SetSubject updates the Subject field with new content.

func (*Composer) SetTo added in v0.30.0 

func (m *Composer) SetTo(to string)

SetTo updates the To field with new content.

func (*Composer) ShowPluginPrompt added in v0.31.0 

func (m *Composer) ShowPluginPrompt(placeholder string)

ShowPluginPrompt activates the plugin prompt overlay with the given placeholder text.

func (*Composer) ToDraft added in v0.8.0 

func (m *Composer) ToDraft() config.Draft

ToDraft converts the composer state to a Draft for saving.

func (*Composer) Update 

func (m *Composer) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*Composer) View 

func (m *Composer) View() tea.View

type ConfigSavedMsg added in v0.36.0 

type ConfigSavedMsg struct{}

ConfigSavedMsg signals the config was written to disk and downstream consumers (notably the daemon) should reload it.

type Credentials 

type Credentials struct {
	Provider     string
	Name         string
	Host         string // Host (this was the previous "Email Address" field in the UI)
	FetchEmail   string // Single email address to fetch messages for. If empty, code should default this to Host when creating the account.
	SendAsEmail  string // Optional From header email. If empty, sending falls back to FetchEmail, then Host.
	CatchAll     bool   // Show all inbox messages regardless of To address.
	Password     string
	IMAPServer   string
	IMAPPort     int
	SMTPServer   string
	SMTPPort     int
	Insecure     bool
	AuthMethod   string // "password" or "oauth2"
	Protocol     string // "imap" (default), "jmap", or "pop3"
	JMAPEndpoint string // JMAP session URL
	POP3Server   string // POP3 server hostname
	POP3Port     int    // POP3 server port
}

type DaemonEventMsg added in v0.34.0 

type DaemonEventMsg struct {
	Event *daemonrpc.Event
}

DaemonEventMsg wraps an event pushed from the daemon process.

type DeleteAccountMsg added in v0.8.0 

type DeleteAccountMsg struct {
	AccountID string
}

DeleteAccountMsg signals that an account should be deleted.

type DeleteEmailMsg 

type DeleteEmailMsg struct {
	UID       uint32
	AccountID string
	Mailbox   MailboxKind
}

type DeleteSavedDraftMsg added in v0.8.0 

type DeleteSavedDraftMsg struct {
	DraftID string
}

DeleteDraftMsg signals that a draft should be deleted.

type DiscardDraftMsg 

type DiscardDraftMsg struct {
	ComposerState *Composer
}

DiscardDraftMsg signals that a draft should be cached.

type DownloadAttachmentMsg 

type DownloadAttachmentMsg struct {
	Index     int
	Filename  string
	PartID    string
	Data      []byte
	AccountID string
	Encoding  string
	Mailbox   MailboxKind
}

type DraftDeletedMsg added in v0.8.0 

type DraftDeletedMsg struct {
	DraftID string
	Err     error
}

DraftDeletedMsg signals that a draft was deleted.

type DraftSavedMsg added in v0.8.0 

type DraftSavedMsg struct {
	DraftID string
	Err     error
}

DraftSavedMsg signals that a draft was saved successfully.

type Drafts added in v0.8.0 

type Drafts struct {
	// contains filtered or unexported fields
}

Drafts is the model for the drafts list view

func NewDrafts added in v0.8.0 

func NewDrafts(drafts []config.Draft) *Drafts

NewDrafts creates a new drafts list view

func (*Drafts) Init added in v0.8.0 

func (m *Drafts) Init() tea.Cmd

func (*Drafts) SetDrafts added in v0.8.0 

func (m *Drafts) SetDrafts(drafts []config.Draft)

SetDrafts updates the drafts list

func (*Drafts) Update added in v0.8.0 

func (m *Drafts) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*Drafts) View added in v0.8.0 

func (m *Drafts) View() tea.View

type DraftsLoadedMsg added in v0.8.0 

type DraftsLoadedMsg struct {
	Drafts []config.Draft
}

DraftsLoadedMsg signals that drafts were loaded from disk.

type EditorFinishedMsg added in v0.28.0 

type EditorFinishedMsg struct {
	Body string
	Err  error
}

EditorFinishedMsg signals that the external editor has closed.

type EmailActionDoneMsg 

type EmailActionDoneMsg struct {
	UID       uint32
	AccountID string
	Mailbox   MailboxKind
	Err       error
}

type EmailBodyFetchedMsg 

type EmailBodyFetchedMsg struct {
	UID         uint32
	Body        string
	Attachments []fetcher.Attachment
	Err         error
	AccountID   string
	Mailbox     MailboxKind
}

type EmailMarkedReadMsg added in v0.26.0 

type EmailMarkedReadMsg struct {
	UID       uint32
	AccountID string
	Err       error
}

EmailMarkedReadMsg signals that an email was marked as read.

type EmailMovedMsg added in v0.22.0 

type EmailMovedMsg struct {
	UID          uint32
	AccountID    string
	SourceFolder string
	DestFolder   string
	Err          error
}

EmailMovedMsg signals that an email was moved to a folder.

type EmailResultMsg 

type EmailResultMsg struct {
	Err error
}

type EmailView 

type EmailView struct {
	// contains filtered or unexported fields
}

func NewEmailView 

func NewEmailView(email fetcher.Email, emailIndex, width, height int, mailbox MailboxKind, disableImages bool) *EmailView

func NewEmailViewPreview added in v0.35.0 

func NewEmailViewPreview(email fetcher.Email, width, height, colOffset int, disableImages bool) *EmailView

NewEmailViewPreview creates EmailView in preview mode with column offset for images

func (*EmailView) GetAccountID added in v0.8.0 

func (m *EmailView) GetAccountID() string

GetAccountID returns the account ID for this email

func (*EmailView) GetEmail added in v0.8.0 

func (m *EmailView) GetEmail() fetcher.Email

GetEmail returns the email being viewed

func (*EmailView) Init 

func (m *EmailView) Init() tea.Cmd

func (*EmailView) SetPluginKeyBindings added in v0.30.0 

func (m *EmailView) SetPluginKeyBindings(bindings []PluginKeyBinding)

SetPluginKeyBindings sets the plugin-registered key bindings for display in the help bar.

func (*EmailView) SetPluginStatus added in v0.28.0 

func (m *EmailView) SetPluginStatus(status string)

SetPluginStatus sets a persistent status string from plugins, shown in the help bar.

func (*EmailView) Update 

func (m *EmailView) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*EmailView) View 

func (m *EmailView) View() tea.View

type EmailsAppendedMsg 

type EmailsAppendedMsg struct {
	Emails    []fetcher.Email
	AccountID string
	Mailbox   MailboxKind
}

type EmailsFetchedMsg 

type EmailsFetchedMsg struct {
	Emails    []fetcher.Email
	AccountID string
	Mailbox   MailboxKind
}

type EmailsRefreshedMsg added in v0.8.0 

type EmailsRefreshedMsg struct {
	EmailsByAccount map[string][]fetcher.Email
	Mailbox         MailboxKind
}

EmailsRefreshedMsg signals that fresh emails have been fetched in the background.

type FetchErr 

type FetchErr error

type FetchFolderMoreEmailsMsg added in v0.22.0 

type FetchFolderMoreEmailsMsg struct {
	Offset     uint32
	AccountID  string
	FolderName string
	Limit      uint32
}

FetchFolderMoreEmailsMsg signals a request to fetch more emails from a folder (pagination).

type FetchMoreEmailsMsg 

type FetchMoreEmailsMsg struct {
	Offset    uint32
	AccountID string
	Mailbox   MailboxKind
	Limit     uint32
}

type FetchingMoreEmailsMsg 

type FetchingMoreEmailsMsg struct{}

type FilePicker 

type FilePicker struct {
	// contains filtered or unexported fields
}

func NewFilePicker 

func NewFilePicker(startPath string) *FilePicker

func (*FilePicker) Init 

func (m *FilePicker) Init() tea.Cmd

func (*FilePicker) Update 

func (m *FilePicker) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*FilePicker) View 

func (m *FilePicker) View() tea.View

type FileSelectedMsg 

type FileSelectedMsg struct {
	Paths []string
}

type FolderEmailsAppendedMsg added in v0.22.0 

type FolderEmailsAppendedMsg struct {
	Emails     []fetcher.Email
	AccountID  string
	FolderName string
}

FolderEmailsAppendedMsg signals that more emails from a folder have been fetched (pagination).

type FolderEmailsFetchedMsg added in v0.22.0 

type FolderEmailsFetchedMsg struct {
	Emails     []fetcher.Email
	AccountID  string
	FolderName string
}

FolderEmailsFetchedMsg signals that emails from a folder have been fetched.

type FolderInbox added in v0.22.0 

type FolderInbox struct {
	// contains filtered or unexported fields
}

FolderInbox combines a folder sidebar with an email list.

func NewFolderInbox added in v0.22.0 

func NewFolderInbox(folders []string, accounts []config.Account) *FolderInbox

NewFolderInbox creates a new FolderInbox with the given folders and accounts.

func (*FolderInbox) GetAccounts added in v0.22.0 

func (m *FolderInbox) GetAccounts() []config.Account

GetAccounts returns the accounts.

func (*FolderInbox) GetCurrentFolder added in v0.22.0 

func (m *FolderInbox) GetCurrentFolder() string

GetCurrentFolder returns the currently selected folder name.

func (*FolderInbox) GetFolders added in v0.22.0 

func (m *FolderInbox) GetFolders() []string

GetFolders returns the current folder list.

func (*FolderInbox) GetInbox added in v0.22.0 

func (m *FolderInbox) GetInbox() *Inbox

GetInbox returns the embedded inbox.

func (*FolderInbox) Init added in v0.22.0 

func (m *FolderInbox) Init() tea.Cmd

func (*FolderInbox) OpenSplitPreview added in v0.35.0 

func (m *FolderInbox) OpenSplitPreview(uid uint32, accountID string, email *fetcher.Email)

OpenSplitPreview opens the split preview pane for a specific email. email may be non-nil for hits coming from search results (which are not in m.inbox.allEmails); when set, it is used as a fallback by findEmailByUID so the preview can render without a follow-up lookup.

func (*FolderInbox) RemoveEmail added in v0.22.0 

func (m *FolderInbox) RemoveEmail(uid uint32, accountID string)

RemoveEmail removes an email from the embedded inbox.

func (*FolderInbox) SetDateFormat added in v0.33.0 

func (m *FolderInbox) SetDateFormat(layout string)

SetDateFormat propagates the configured date layout to the inner inbox.

func (*FolderInbox) SetEmails added in v0.22.0 

func (m *FolderInbox) SetEmails(emails []fetcher.Email, accounts []config.Account)

SetEmails updates the inbox emails.

func (*FolderInbox) SetFolders added in v0.22.0 

func (m *FolderInbox) SetFolders(folders []string)

SetFolders updates the folder list.

func (*FolderInbox) SetLoadingEmails added in v0.22.0 

func (m *FolderInbox) SetLoadingEmails(loading bool)

SetLoadingEmails sets the loading state.

func (*FolderInbox) SetRefreshing added in v0.23.1 

func (m *FolderInbox) SetRefreshing(refreshing bool)

SetRefreshing sets the refreshing state (used when user presses "r").

func (*FolderInbox) Update added in v0.22.0 

func (m *FolderInbox) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*FolderInbox) View added in v0.22.0 

func (m *FolderInbox) View() tea.View

type FoldersFetchedMsg added in v0.22.0 

type FoldersFetchedMsg struct {
	FoldersByAccount map[string][]fetcher.Folder // accountID -> folders
	MergedFolders    []fetcher.Folder            // unique folders across all accounts
}

FoldersFetchedMsg signals that IMAP folders have been fetched for all accounts.

type ForwardEmailMsg added in v0.17.0 

type ForwardEmailMsg struct {
	Email fetcher.Email
}

type GoToAccountListMsg added in v0.8.0 

type GoToAccountListMsg struct{}

GoToAccountListMsg signals navigation to the account list in settings.

type GoToAddAccountMsg added in v0.8.0 

type GoToAddAccountMsg struct{}

GoToAddAccountMsg signals navigation to the add account screen.

type GoToAddMailingListMsg added in v0.20.0 

type GoToAddMailingListMsg struct{}

GoToAddMailingListMsg signals navigation to the add mailing list screen.

type GoToChoiceMenuMsg 

type GoToChoiceMenuMsg struct{}

type GoToDraftsMsg added in v0.8.0 

type GoToDraftsMsg struct{}

GoToDraftsMsg signals navigation to the drafts list.

type GoToEditAccountMsg added in v0.26.0 

type GoToEditAccountMsg struct {
	AccountID    string
	Provider     string
	Name         string
	Email        string
	FetchEmail   string
	SendAsEmail  string
	CatchAll     bool
	IMAPServer   string
	IMAPPort     int
	SMTPServer   string
	SMTPPort     int
	Insecure     bool
	Protocol     string
	JMAPEndpoint string
	POP3Server   string
	POP3Port     int
}

GoToEditAccountMsg signals navigation to edit an existing account.

type GoToEditMailingListMsg added in v0.26.0 

type GoToEditMailingListMsg struct {
	Index     int
	Name      string
	Addresses string
}

GoToEditMailingListMsg signals navigation to edit an existing mailing list.

type GoToFilePickerMsg 

type GoToFilePickerMsg struct{}

type GoToInboxMsg 

type GoToInboxMsg struct{}

type GoToMarketplaceMsg added in v0.31.0 

type GoToMarketplaceMsg struct{}

GoToMarketplaceMsg signals navigation to the plugin marketplace.

type GoToSendMsg 

type GoToSendMsg struct {
	To      string
	Subject string
	Body    string
}

type GoToSentInboxMsg added in v0.10.0 

type GoToSentInboxMsg struct{}

type GoToSettingsMsg 

type GoToSettingsMsg struct{}

type GoToSignatureEditorMsg added in v0.15.0 

type GoToSignatureEditorMsg struct {
	AccountID string
}

type GoToTrashArchiveMsg added in v0.16.0 

type GoToTrashArchiveMsg struct{}

type IdleNewMailMsg added in v0.28.0 

type IdleNewMailMsg struct {
	AccountID  string
	FolderName string
}

IdleNewMailMsg signals that IMAP IDLE detected new mail for an account/folder.

type Inbox 

type Inbox struct {
	// contains filtered or unexported fields
}

func NewArchiveInbox added in v0.16.0 

func NewArchiveInbox(emails []fetcher.Email, accounts []config.Account) *Inbox

func NewInbox 

func NewInbox(emails []fetcher.Email, accounts []config.Account) *Inbox

func NewInboxSingleAccount added in v0.8.0 

func NewInboxSingleAccount(emails []fetcher.Email) *Inbox

NewInboxSingleAccount creates an inbox for a single account (legacy support)

func NewInboxWithMailbox added in v0.10.0 

func NewInboxWithMailbox(emails []fetcher.Email, accounts []config.Account, mailbox MailboxKind) *Inbox

func NewSentInbox added in v0.10.0 

func NewSentInbox(emails []fetcher.Email, accounts []config.Account) *Inbox

func NewTrashInbox added in v0.16.0 

func NewTrashInbox(emails []fetcher.Email, accounts []config.Account) *Inbox

func (*Inbox) GetCurrentAccountID added in v0.8.0 

func (m *Inbox) GetCurrentAccountID() string

GetCurrentAccountID returns the currently selected account ID

func (*Inbox) GetEmailAtIndex added in v0.8.0 

func (m *Inbox) GetEmailAtIndex(index int) *fetcher.Email

GetEmailAtIndex returns the email at the given index for the current view

func (*Inbox) GetMailbox added in v0.10.0 

func (m *Inbox) GetMailbox() MailboxKind

func (*Inbox) GetSelectedEmail added in v0.30.0 

func (m *Inbox) GetSelectedEmail() *fetcher.Email

GetSelectedEmail returns the currently selected email, or nil if none is selected.

func (*Inbox) Init 

func (m *Inbox) Init() tea.Cmd

func (*Inbox) IsFilterActive added in v0.36.0 

func (m *Inbox) IsFilterActive() bool

func (*Inbox) IsSearchActive added in v0.36.0 

func (m *Inbox) IsSearchActive() bool

func (*Inbox) MarkEmailAsRead added in v0.26.0 

func (m *Inbox) MarkEmailAsRead(uid uint32, accountID string)

MarkEmailAsRead marks an email as read by UID and account ID, updating it in all stores.

func (*Inbox) RemoveEmail added in v0.8.0 

func (m *Inbox) RemoveEmail(uid uint32, accountID string)

RemoveEmail removes an email by UID and account ID

func (*Inbox) RemoveEmails added in v0.32.0 

func (m *Inbox) RemoveEmails(uids []uint32, accountID string)

RemoveEmails removes multiple emails by UID and account ID (batch operation)

func (*Inbox) SetDateFormat added in v0.33.0 

func (m *Inbox) SetDateFormat(layout string)

SetDateFormat configures the Go time layout used to render absolute dates in the email list. Pass the value returned by config.Config.GetDateFormat.

func (*Inbox) SetEmails added in v0.8.0 

func (m *Inbox) SetEmails(emails []fetcher.Email, accounts []config.Account)

SetEmails updates all emails (used after fetch)

func (*Inbox) SetFolderName added in v0.22.0 

func (m *Inbox) SetFolderName(name string)

SetFolderName sets a custom folder name for the inbox title.

func (*Inbox) SetPluginKeyBindings added in v0.30.0 

func (m *Inbox) SetPluginKeyBindings(bindings []PluginKeyBinding)

SetPluginKeyBindings sets the plugin-registered key bindings for display in the help bar.

func (*Inbox) SetPluginStatus added in v0.28.0 

func (m *Inbox) SetPluginStatus(status string)

SetPluginStatus sets a persistent status string from plugins, shown in the title.

func (*Inbox) SetSize added in v0.22.0 

func (m *Inbox) SetSize(width, height int)

SetSize sets the width and height of the inbox, then updates the list.

func (*Inbox) Update 

func (m *Inbox) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*Inbox) View 

func (m *Inbox) View() tea.View

type LanguageChangedMsg added in v0.35.0 

type LanguageChangedMsg struct{}

RSVPResultMsg signals that RSVP was sent (or failed)

type LoadDraftsMsg added in v0.8.0 

type LoadDraftsMsg struct{}

LoadDraftsMsg signals a request to load all saved drafts.

type Login 

type Login struct {
	// contains filtered or unexported fields
}

Login holds the state for the login/add account form.

func NewLogin 

func NewLogin(hideTips bool) *Login

NewLogin creates a new login model for adding accounts.

func (*Login) GetAccountID added in v0.8.0 

func (m *Login) GetAccountID() string

GetAccountID returns the account ID being edited (if in edit mode).

func (*Login) Init 

func (m *Login) Init() tea.Cmd

Init initializes the login model.

func (*Login) IsEditMode added in v0.8.0 

func (m *Login) IsEditMode() bool

IsEditMode returns whether the form is in edit mode.

func (*Login) SetEditMode added in v0.8.0 

func (m *Login) SetEditMode(accountID, protocol, provider, name, email, fetchEmail, sendAsEmail, imapServer string, imapPort int, smtpServer string, smtpPort int, insecure bool, jmapEndpoint, pop3Server string, pop3Port int, catchAll bool)

SetEditMode sets the login form to edit an existing account.

func (*Login) Update 

func (m *Login) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update handles messages for the login model.

func (*Login) View 

func (m *Login) View() tea.View

View renders the login form.

type MailboxKind added in v0.10.0 

type MailboxKind string
const (
	MailboxInbox   MailboxKind = "inbox"
	MailboxSent    MailboxKind = "sent"
	MailboxTrash   MailboxKind = "trash"
	MailboxArchive MailboxKind = "archive"
)

type MailingListEditor added in v0.20.0 

type MailingListEditor struct {
	// contains filtered or unexported fields
}

MailingListEditor displays the screen to add or edit a mailing list.

func NewMailingListEditor added in v0.20.0 

func NewMailingListEditor() *MailingListEditor

NewMailingListEditor creates a new mailing list editor model.

func (*MailingListEditor) Init added in v0.20.0 

func (m *MailingListEditor) Init() tea.Cmd

Init initializes the mailing list editor model.

func (*MailingListEditor) SetEditMode added in v0.26.0 

func (m *MailingListEditor) SetEditMode(index int, name, addresses string)

SetEditMode sets the editor to edit an existing mailing list.

func (*MailingListEditor) Update added in v0.20.0 

func (m *MailingListEditor) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update handles messages for the mailing list editor model.

func (*MailingListEditor) View added in v0.20.0 

func (m *MailingListEditor) View() tea.View

View renders the mailing list editor screen.

type MarkEmailAsReadMsg added in v0.26.0 

type MarkEmailAsReadMsg struct {
	UID        uint32
	AccountID  string
	FolderName string
}

MarkEmailAsReadMsg signals that an email should be marked as read on the server.

type Marketplace added in v0.31.0 

type Marketplace struct {
	// contains filtered or unexported fields
}

func NewMarketplace added in v0.31.0 

func NewMarketplace(standalone bool) Marketplace

func (Marketplace) Init added in v0.31.0 

func (m Marketplace) Init() tea.Cmd

func (Marketplace) Update added in v0.31.0 

func (m Marketplace) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Marketplace) View added in v0.31.0 

func (m Marketplace) View() tea.View

type MoveEmailMsg added in v0.22.0 

type MoveEmailMsg struct {
	UID          uint32
	AccountID    string
	SourceFolder string
}

MoveEmailMsg signals a request to show the move-to-folder picker.

type MoveEmailToFolderMsg added in v0.22.0 

type MoveEmailToFolderMsg struct {
	UID          uint32
	AccountID    string
	SourceFolder string
	DestFolder   string
}

MoveEmailToFolderMsg signals that an email should be moved to a folder.

type OAuth2CompleteMsg added in v0.28.0 

type OAuth2CompleteMsg struct {
	Email string
	Err   error
}

OAuth2CompleteMsg is sent when OAuth2 authorization completes.

type OpenDraftMsg added in v0.8.0 

type OpenDraftMsg struct {
	Draft config.Draft
}

OpenDraftMsg signals that a specific draft should be opened in the composer.

type OpenEditorMsg added in v0.28.0 

type OpenEditorMsg struct{}

OpenEditorMsg signals that the composer body should be opened in $EDITOR.

type PaneType added in v0.35.0 

type PaneType int
const (
	FocusInbox PaneType = iota
	FocusPreview
)

type PasswordPrompt added in v0.32.0 

type PasswordPrompt struct {
	// contains filtered or unexported fields
}

PasswordPrompt asks the user for their encryption password to unlock the app.

func NewPasswordPrompt added in v0.32.0 

func NewPasswordPrompt() *PasswordPrompt

NewPasswordPrompt creates a new password prompt screen.

func (*PasswordPrompt) Init added in v0.32.0 

func (m *PasswordPrompt) Init() tea.Cmd

func (*PasswordPrompt) Update added in v0.32.0 

func (m *PasswordPrompt) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*PasswordPrompt) View added in v0.32.0 

func (m *PasswordPrompt) View() tea.View

type PasswordVerifiedMsg added in v0.32.0 

type PasswordVerifiedMsg struct {
	Key []byte // The derived encryption key (nil on failure)
	Err error  // Non-nil if verification failed
}

PasswordVerifiedMsg signals that the encryption password was verified (or failed).

type PluginInstalledMsg added in v0.31.0 

type PluginInstalledMsg struct {
	Name string
	Err  error
}

PluginInstalledMsg signals that a plugin was installed from the marketplace.

type PluginKeyBinding added in v0.30.0 

type PluginKeyBinding struct {
	Key         string
	Description string
}

PluginKeyBinding describes a plugin-registered keyboard shortcut for display in the help bar.

type PluginNotifyMsg added in v0.28.0 

type PluginNotifyMsg struct {
	Message  string
	Duration float64 // Duration in seconds (default 2)
}

PluginNotifyMsg signals that a plugin wants to show a notification.

type PluginPromptCancelMsg added in v0.31.0 

type PluginPromptCancelMsg struct{}

PluginPromptCancelMsg signals that the user cancelled a plugin prompt input.

type PluginPromptSubmitMsg added in v0.31.0 

type PluginPromptSubmitMsg struct {
	Value string
}

PluginPromptSubmitMsg signals that the user submitted a plugin prompt input.

type PreviewBodyFetchedMsg added in v0.35.0 

type PreviewBodyFetchedMsg struct {
	UID         uint32
	AccountID   string
	Body        string
	Attachments []fetcher.Attachment
	Err         error
}

type RSVPResultMsg added in v0.33.0 

type RSVPResultMsg struct {
	Err       error
	Response  string // "ACCEPTED", "DECLINED", "TENTATIVE"
	Organizer string // organizer email for Google Calendar note
}

type RefreshingEmailsMsg added in v0.8.0 

type RefreshingEmailsMsg struct {
	Mailbox MailboxKind
}

RefreshingEmailsMsg signals that a background refresh is in progress.

type RegistryFetchedMsg added in v0.31.0 

type RegistryFetchedMsg struct {
	Entries []plugins.PluginEntry
	Err     error
}

RegistryFetchedMsg signals that the plugin registry was fetched.

type ReplyToEmailMsg 

type ReplyToEmailMsg struct {
	Email fetcher.Email
}

type RequestRefreshMsg added in v0.13.0 

type RequestRefreshMsg struct {
	Mailbox    MailboxKind
	Counts     map[string]int
	FolderName string
}

RequestRefreshMsg signals a request to refresh emails from the server.

type RestoreViewMsg 

type RestoreViewMsg struct{}

type SaveDraftMsg added in v0.8.0 

type SaveDraftMsg struct {
	Draft config.Draft
}

SaveDraftMsg signals that the current draft should be saved to disk.

type SaveMailingListMsg added in v0.20.0 

type SaveMailingListMsg struct {
	Name      string
	Addresses string
	EditIndex int // -1 means new, >= 0 means editing existing
}

SaveMailingListMsg signals that a new or edited mailing list should be saved.

type SearchOverlay added in v0.36.0 

type SearchOverlay struct {
	// contains filtered or unexported fields
}

func NewSearchOverlay added in v0.36.0 

func NewSearchOverlay(width, height int) *SearchOverlay

func (*SearchOverlay) Init added in v0.36.0 

func (o *SearchOverlay) Init() tea.Cmd

func (*SearchOverlay) Update added in v0.36.0 

func (o *SearchOverlay) Update(msg tea.Msg, mailbox MailboxKind, accountID string) tea.Cmd

func (*SearchOverlay) View added in v0.36.0 

func (o *SearchOverlay) View() string

type SearchRequestedMsg added in v0.36.0 

type SearchRequestedMsg struct {
	Query      backend.SearchQuery
	Mailbox    MailboxKind
	FolderName string
	AccountID  string
}

type SearchResultsMsg added in v0.36.0 

type SearchResultsMsg struct {
	Query  backend.SearchQuery
	Emails []fetcher.Email
	Err    error
}

type SecureModeDisabledMsg added in v0.32.0 

type SecureModeDisabledMsg struct {
	Err error
}

SecureModeDisabledMsg signals that encryption was disabled from settings.

type SecureModeEnabledMsg added in v0.32.0 

type SecureModeEnabledMsg struct {
	Err error
}

SecureModeEnabledMsg signals that encryption was enabled from settings.

type SendEmailMsg 

type SendEmailMsg struct {
	To              string
	Cc              string // Cc recipient(s)
	Bcc             string // Bcc recipient(s)
	Subject         string
	Body            string
	AttachmentPaths []string
	InReplyTo       string
	References      []string
	AccountID       string // ID of the account to send from
	FromOverride    string // Custom From address (used when account is catch-all)
	QuotedText      string // Hidden quoted text appended when sending
	Signature       string // Signature to append to email body
	SignSMIME       bool   // Whether to sign the email using S/MIME
	EncryptSMIME    bool   // Whether to encrypt the email using S/MIME
	SignPGP         bool   // Whether to sign the email using PGP
}

type SendRSVPMsg added in v0.33.0 

type SendRSVPMsg struct {
	OriginalICS []byte
	Event       *calendar.Event
	Response    string // "ACCEPTED", "DECLINED", "TENTATIVE"
	AccountID   string
	InReplyTo   string
	References  []string
}

SendRSVPMsg signals that user wants to send RSVP to calendar invite

type SetComposerCursorToStartMsg 

type SetComposerCursorToStartMsg struct{}

type Settings added in v0.8.0 

type Settings struct {
	// contains filtered or unexported fields
}

func NewSettings added in v0.8.0 

func NewSettings(cfg *config.Config) *Settings

func (*Settings) GetState added in v0.35.0 

func (m *Settings) GetState() SettingsState

func (*Settings) Init added in v0.8.0 

func (m *Settings) Init() tea.Cmd

func (*Settings) RestoreState added in v0.35.0 

func (m *Settings) RestoreState(state SettingsState)

func (*Settings) Update added in v0.8.0 

func (m *Settings) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (*Settings) UpdateConfig added in v0.18.0 

func (m *Settings) UpdateConfig(cfg *config.Config)

func (*Settings) View added in v0.8.0 

func (m *Settings) View() tea.View

type SettingsCategory added in v0.34.0 

type SettingsCategory int
const (
	CategoryGeneral SettingsCategory = iota
	CategoryAccounts
	CategoryTheme
	CategoryMailingLists
	CategoryEncryption
)

type SettingsPane added in v0.34.0 

type SettingsPane int
const (
	PaneMenu SettingsPane = iota
	PaneContent
)

type SettingsState added in v0.18.0 

type SettingsState struct {
	ActivePane     SettingsPane
	ActiveCategory SettingsCategory
	MenuCursor     int
	GeneralCursor  int
	AccountsCursor int
	ThemeCursor    int
	ListsCursor    int
}

type SignatureEditor added in v0.15.0 

type SignatureEditor struct {
	// contains filtered or unexported fields
}

SignatureEditor displays the signature editing screen.

func NewSignatureEditor added in v0.15.0 

func NewSignatureEditor(accountID string) *SignatureEditor

NewSignatureEditor creates a new signature editor model.

func (*SignatureEditor) Init added in v0.15.0 

func (m *SignatureEditor) Init() tea.Cmd

Init initializes the signature editor model.

func (*SignatureEditor) Update added in v0.15.0 

func (m *SignatureEditor) Update(msg tea.Msg) (tea.Model, tea.Cmd)

Update handles messages for the signature editor model.

func (*SignatureEditor) View added in v0.15.0 

func (m *SignatureEditor) View() tea.View

View renders the signature editor screen.

type StartOAuth2Msg added in v0.28.0 

type StartOAuth2Msg struct {
	Email string
}

StartOAuth2Msg is sent when the user requests OAuth2 authorization for a Gmail account.

type Status 

type Status struct {
	// contains filtered or unexported fields
}

A simple model for showing a status message

func NewStatus 

func NewStatus(msg string) Status

func (Status) Init 

func (m Status) Init() tea.Cmd

func (Status) Update 

func (m Status) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Status) View 

func (m Status) View() tea.View

type SwitchAccountMsg added in v0.8.0 

type SwitchAccountMsg struct {
	AccountID string // Empty string means "ALL" accounts
}

SwitchAccountMsg signals switching to view a specific account's inbox.

type SwitchFolderMsg added in v0.22.0 

type SwitchFolderMsg struct {
	FolderName     string
	PreviousFolder string
	AccountID      string
}

SwitchFolderMsg signals switching to a different IMAP folder.

type SwitchFromAccountMsg added in v0.8.0 

type SwitchFromAccountMsg struct {
	AccountID string
}

SwitchFromAccountMsg signals changing the "From" account in composer.

type UpdatePreviewMsg added in v0.35.0 

type UpdatePreviewMsg struct {
	UID       uint32
	AccountID string
}

type ViewEmailMsg 

type ViewEmailMsg struct {
	Index     int
	UID       uint32
	AccountID string
	Mailbox   MailboxKind
	Email     *fetcher.Email
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.