bridge

Documentation

Overview

Package bridge provides core functionality of Bridge app.

Index

• Constants
• type Bridge
  • func New(config Configer, pref PreferenceProvider, panicHandler users.PanicHandler, ...) *Bridge
  • func (b *Bridge) GetCurrentClient() string
  • func (b *Bridge) ReportBug(osType, osVersion, description, accountName, address, emailClient string) error
  • func (b *Bridge) SetCurrentClient(clientName, clientVersion string)
  • func (b *Bridge) SetCurrentOS(os string)
• type Configer
• type PreferenceProvider
• type StoreFactoryConfiger

Constants

const Credits = "" /* 1980-byte string literal not displayed */

const (
	Host = "127.0.0.1"
)

Host settings.

const ReleaseFixedBugs = `• AppleMail crashes (timestamp related)
• Encoding errors
• Installation issues on linux
`

const ReleaseNotes = `• Support read confirmations
• Adding GPLv3 licence button to the GUI
• Improved testing
`

Types

type Bridge

type Bridge struct {
	*users.Users
	// contains filtered or unexported fields
}

func New

func New(
	config Configer,
	pref PreferenceProvider,
	panicHandler users.PanicHandler,
	eventListener listener.Listener,
	clientManager users.ClientManager,
	credStorer users.CredentialsStorer,
) *Bridge

func (*Bridge) GetCurrentClient

func (b *Bridge) GetCurrentClient() string

GetCurrentClient returns currently connected client (e.g. Thunderbird).

func (*Bridge) ReportBug

func (b *Bridge) ReportBug(osType, osVersion, description, accountName, address, emailClient string) error

ReportBug reports a new bug from the user.

func (*Bridge) SetCurrentClient

func (b *Bridge) SetCurrentClient(clientName, clientVersion string)

SetCurrentClient updates client info (e.g. Thunderbird) and sets the user agent on pmapi. By default no client is used, IMAP has to detect it on first login.

func (*Bridge) SetCurrentOS

func (b *Bridge) SetCurrentOS(os string)

SetCurrentOS updates OS and sets the user agent on pmapi. By default we use `runtime.GOOS`, but this can be overridden in case of better detection.

type Configer

type Configer interface {
	users.Configer
	StoreFactoryConfiger
}

type PreferenceProvider

type PreferenceProvider interface {
	Get(key string) string
	GetBool(key string) bool
	SetBool(key string, val bool)
	GetInt(key string) int
	Set(key string, value string)
}

type StoreFactoryConfiger

type StoreFactoryConfiger interface {
	GetDBDir() string
	GetIMAPCachePath() string
}