package grpc

Get desktop application:
View/edit binary Protocol Buffers messages

********************************************************************************************************************** Service Declaration **********************************************************************************************************************≠––

• rpc CheckTokens (google.protobuf.StringValue, google.protobuf.StringValue)

  bridge.proto:33

  App related calls

• rpc AddLogEntry (AddLogEntryRequest, google.protobuf.Empty)

  bridge.proto:34

  message AddLogEntryRequest

  bridge.proto:132

  • LogLevel level = 1

  • string package = 2

    package is Go lingo but it identifies the component responsible for the log entry

  • string message = 3

• rpc GuiReady (google.protobuf.Empty, GuiReadyResponse)

  bridge.proto:35

  message GuiReadyResponse

  bridge.proto:142

  ********************************************************** GuiReady **********************************************************

  • bool showSplashScreen = 1

• rpc Quit (google.protobuf.Empty, google.protobuf.Empty)

  bridge.proto:36

• rpc Restart (google.protobuf.Empty, google.protobuf.Empty)

  bridge.proto:37

• rpc ShowOnStartup (google.protobuf.Empty, google.protobuf.BoolValue)

  bridge.proto:38

• rpc SetIsAutostartOn (google.protobuf.BoolValue, google.protobuf.Empty)

  bridge.proto:39

• rpc IsAutostartOn (google.protobuf.Empty, google.protobuf.BoolValue)

  bridge.proto:40

• rpc SetIsBetaEnabled (google.protobuf.BoolValue, google.protobuf.Empty)

  bridge.proto:41

• rpc IsBetaEnabled (google.protobuf.Empty, google.protobuf.BoolValue)

  bridge.proto:42

• rpc SetIsAllMailVisible (google.protobuf.BoolValue, google.protobuf.Empty)

  bridge.proto:43

• rpc IsAllMailVisible (google.protobuf.Empty, google.protobuf.BoolValue)

  bridge.proto:44

• rpc SetIsTelemetryDisabled (google.protobuf.BoolValue, google.protobuf.Empty)

  bridge.proto:45

• rpc IsTelemetryDisabled (google.protobuf.Empty, google.protobuf.BoolValue)

  bridge.proto:46

• rpc GoOs (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:47

• rpc TriggerReset (google.protobuf.Empty, google.protobuf.Empty)

  bridge.proto:48

• rpc Version (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:49

• rpc LogsPath (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:50

• rpc LicensePath (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:51

• rpc ReleaseNotesPageLink (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:52

• rpc DependencyLicensesLink (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:53

• rpc LandingPageLink (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:54

• rpc SetColorSchemeName (google.protobuf.StringValue, google.protobuf.Empty)

  bridge.proto:55

• rpc ColorSchemeName (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:56

  TODO Color scheme should probably entirely be managed by the client.

• rpc CurrentEmailClient (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:57

• rpc ReportBug (ReportBugRequest, google.protobuf.Empty)

  bridge.proto:58

  message ReportBugRequest

  bridge.proto:150

  ********************************************************** Bug reporting related messages. **********************************************************

  • string osType = 1

  • string osVersion = 2

  • string title = 3

  • string description = 4

  • string address = 5

  • string emailClient = 6

  • bool includeLogs = 7

• rpc ForceLauncher (google.protobuf.StringValue, google.protobuf.Empty)

  bridge.proto:59

• rpc SetMainExecutable (google.protobuf.StringValue, google.protobuf.Empty)

  bridge.proto:60

• rpc RequestKnowledgeBaseSuggestions (google.protobuf.StringValue, google.protobuf.Empty)

  bridge.proto:61

• rpc Login (LoginRequest, google.protobuf.Empty)

  bridge.proto:64

  login

• rpc Login2FA (LoginRequest, google.protobuf.Empty)

  bridge.proto:65

• rpc Login2Passwords (LoginRequest, google.protobuf.Empty)

  bridge.proto:66

• rpc LoginAbort (LoginAbortRequest, google.protobuf.Empty)

  bridge.proto:67

  message LoginAbortRequest

  bridge.proto:172

  • string username = 1

• rpc CheckUpdate (google.protobuf.Empty, google.protobuf.Empty)

  bridge.proto:70

  update

• rpc InstallUpdate (google.protobuf.Empty, google.protobuf.Empty)

  bridge.proto:71

• rpc SetIsAutomaticUpdateOn (google.protobuf.BoolValue, google.protobuf.Empty)

  bridge.proto:72

• rpc IsAutomaticUpdateOn (google.protobuf.Empty, google.protobuf.BoolValue)

  bridge.proto:73

• rpc DiskCachePath (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:76

  cache

• rpc SetDiskCachePath (google.protobuf.StringValue, google.protobuf.Empty)

  bridge.proto:77

• rpc SetIsDoHEnabled (google.protobuf.BoolValue, google.protobuf.Empty)

  bridge.proto:80

  mail

• rpc IsDoHEnabled (google.protobuf.Empty, google.protobuf.BoolValue)

  bridge.proto:81

• rpc MailServerSettings (google.protobuf.Empty, ImapSmtpSettings)

  bridge.proto:82

• rpc SetMailServerSettings (ImapSmtpSettings, google.protobuf.Empty)

  bridge.proto:83

• rpc Hostname (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:84

• rpc IsPortFree (google.protobuf.Int32Value, google.protobuf.BoolValue)

  bridge.proto:85

• rpc AvailableKeychains (google.protobuf.Empty, AvailableKeychainsResponse)

  bridge.proto:88

  keychain

  message AvailableKeychainsResponse

  bridge.proto:189

  ********************************************************** Keychain related message **********************************************************

  • repeated string keychains = 1

• rpc SetCurrentKeychain (google.protobuf.StringValue, google.protobuf.Empty)

  bridge.proto:89

• rpc CurrentKeychain (google.protobuf.Empty, google.protobuf.StringValue)

  bridge.proto:90

• rpc GetUserList (google.protobuf.Empty, UserListResponse)

  bridge.proto:93

  User & user list

  message UserListResponse

  bridge.proto:225

  • repeated User users = 1

• rpc GetUser (google.protobuf.StringValue, User)

  bridge.proto:94

• rpc SetUserSplitMode (UserSplitModeRequest, google.protobuf.Empty)

  bridge.proto:95

  message UserSplitModeRequest

  bridge.proto:214

  • string userID = 1

  • bool active = 2

• rpc SendBadEventUserFeedback (UserBadEventFeedbackRequest, google.protobuf.Empty)

  bridge.proto:96

  message UserBadEventFeedbackRequest

  bridge.proto:219

  • string userID = 1

  • bool doResync = 2

• rpc LogoutUser (google.protobuf.StringValue, google.protobuf.Empty)

  bridge.proto:97

• rpc RemoveUser (google.protobuf.StringValue, google.protobuf.Empty)

  bridge.proto:98

• rpc ConfigureUserAppleMail (ConfigureAppleMailRequest, google.protobuf.Empty)

  bridge.proto:99

  message ConfigureAppleMailRequest

  bridge.proto:229

  • string userID = 1

  • string address = 2

• rpc IsTLSCertificateInstalled (google.protobuf.Empty, google.protobuf.BoolValue)

  bridge.proto:102

  TLS certificate related calls

• rpc InstallTLSCertificate (google.protobuf.Empty, google.protobuf.Empty)

  bridge.proto:103

• rpc ExportTLSCertificates (google.protobuf.StringValue, google.protobuf.Empty)

  bridge.proto:104

• rpc RunEventStream (EventStreamRequest, stream StreamEvent)

  bridge.proto:107

  Server -> Client event stream

  Keep streaming until StopEventStream is called.

  message EventStreamRequest

  bridge.proto:238

  • string ClientPlatform = 1

  message StreamEvent

  bridge.proto:242

  • oneof event

    • AppEvent app = 1

    • LoginEvent login = 2

    • UpdateEvent update = 3

    • DiskCacheEvent cache = 4

    • MailServerSettingsEvent mailServerSettings = 5

    • KeychainEvent keychain = 6

    • MailEvent mail = 7

    • UserEvent user = 8

    • GenericErrorEvent genericError = 9

• rpc StopEventStream (google.protobuf.Empty, google.protobuf.Empty)

  bridge.proto:108

• rpc TriggerRepair (google.protobuf.Empty, google.protobuf.Empty)

  bridge.proto:111

  Repair

Used in: MailEvent

• string address = 1

Used in: MailEvent

• string address = 1

Used in: AppEvent

(message has no fields)

Used in: MailEvent

(message has no fields)

********************************************************** App related events **********************************************************

Used in: StreamEvent

• oneof event

  • InternetStatusEvent internetStatus = 1

  • ToggleAutostartFinishedEvent toggleAutostartFinished = 2

  • ResetFinishedEvent resetFinished = 3

  • ReportBugFinishedEvent reportBugFinished = 4

  • ReportBugSuccessEvent reportBugSuccess = 5

  • ReportBugErrorEvent reportBugError = 6

  • ShowMainWindowEvent showMainWindow = 7

  • ReportBugFallbackEvent reportBugFallback = 8

  • CertificateInstallSuccessEvent certificateInstallSuccess = 9

  • CertificateInstallCanceledEvent certificateInstallCanceled = 10

  • CertificateInstallFailedEvent certificateInstallFailed = 11

  • KnowledgeBaseSuggestionsEvent knowledgeBaseSuggestions = 12

  • RepairStartedEvent repairStarted = 13

  • AllUsersLoadedEvent allUsersLoaded = 14

  • UserNotificationEvent userNotification = 15

Used in: AppEvent

(message has no fields)

Used in: AppEvent

(message has no fields)

Used in: AppEvent

(message has no fields)

Used in: KeychainEvent

(message has no fields)

Used in: MailServerSettingsEvent

(message has no fields)

Used in: DiskCacheEvent

• DiskCacheErrorType type = 1

Used in: DiskCacheErrorEvent

• CANT_MOVE_DISK_CACHE_ERROR = 0

********************************************************** Cache on disk related events **********************************************************

Used in: StreamEvent

• oneof event

  • DiskCacheErrorEvent error = 1

  • DiskCachePathChangedEvent pathChanged = 2

  • DiskCachePathChangeFinishedEvent pathChangeFinished = 3

Used in: DiskCacheEvent

(message has no fields)

Used in: DiskCacheEvent

• string path = 1

********************************************************** Generic errors **********************************************************

Used in: GenericErrorEvent

• UNKNOWN_ERROR = 0

• TLS_CERT_EXPORT_ERROR = 1

• TLS_KEY_EXPORT_ERROR = 2

Used in: StreamEvent

• ErrorCode code = 1

Used in: KeychainEvent

(message has no fields)

Used in: UserEvent

• string username = 1

********************************************************** IMAP/SMTP Mail Server settings **********************************************************

Used as request type in: Bridge.SetMailServerSettings

Used as response type in: Bridge.MailServerSettings

Used as field type in: MailServerSettingsChangedEvent

• int32 imapPort = 1

• int32 smtpPort = 2

• bool useSSLForImap = 3

• bool useSSLForSmtp = 4

Used in: AppEvent

• bool connected = 1

********************************************************** keychain related events **********************************************************

Used in: StreamEvent

• oneof event

  • ChangeKeychainFinishedEvent changeKeychainFinished = 1

  • HasNoKeychainEvent hasNoKeychain = 2

  • RebuildKeychainEvent rebuildKeychain = 3

Used in: KnowledgeBaseSuggestionsEvent

• string url = 1

• string title = 2

Used in: AppEvent

• repeated KnowledgeBaseSuggestion suggestions = 1

********************************************************** Log related message ********************************************************** Note: the enum values are prefixed with 'LOG_' to avoid a clash in C++ on Windows with the ERROR macro defined in wingdi.h

Used in: AddLogEntryRequest

• LOG_PANIC = 0

• LOG_FATAL = 1

• LOG_ERROR = 2

• LOG_WARN = 3

• LOG_INFO = 4

• LOG_DEBUG = 5

• LOG_TRACE = 6

Used in: LoginEvent

• LoginErrorType type = 1

• string message = 2

Used in: LoginErrorEvent

• USERNAME_PASSWORD_ERROR = 0

• FREE_USER = 1

• CONNECTION_ERROR = 2

• TFA_ERROR = 3

• TFA_ABORT = 4

• TWO_PASSWORDS_ERROR = 5

• TWO_PASSWORDS_ABORT = 6

• HV_ERROR = 7

********************************************************** Login related events **********************************************************

Used in: StreamEvent

• oneof event

  • LoginErrorEvent error = 1

  • LoginTfaRequestedEvent tfaRequested = 2

  • LoginTwoPasswordsRequestedEvent twoPasswordRequested = 3

  • LoginFinishedEvent finished = 4

  • LoginFinishedEvent alreadyLoggedIn = 5

  • LoginHvRequestedEvent hvRequested = 6

Used in: LoginEvent

• string userID = 1

• bool wasSignedOut = 2

Used in: LoginEvent

• string hvUrl = 1

Used as request type in: Bridge.Login, Bridge.Login2FA, Bridge.Login2Passwords

• string username = 1

• bytes password = 2

• optional bool useHvDetails = 3

Used in: LoginEvent

• string username = 1

Used in: LoginEvent

• string username = 1

********************************************************** Mail related events **********************************************************

Used in: StreamEvent

• oneof event

  • AddressChangedEvent addressChanged = 1

  • AddressChangedLogoutEvent addressChangedLogout = 2

  • ApiCertIssueEvent apiCertIssue = 3

Used in: MailServerSettingsEvent

• optional ImapSmtpSettings settings = 1

Used in: MailServerSettingsEvent

• MailServerSettingsErrorType type = 1

Used in: MailServerSettingsErrorEvent

• IMAP_PORT_STARTUP_ERROR = 0

• SMTP_PORT_STARTUP_ERROR = 1

• IMAP_PORT_CHANGE_ERROR = 2

• SMTP_PORT_CHANGE_ERROR = 3

• IMAP_CONNECTION_MODE_CHANGE_ERROR = 4

• SMTP_CONNECTION_MODE_CHANGE_ERROR = 5

********************************************************** Mail server settings related events **********************************************************

Used in: StreamEvent

• oneof event

  • MailServerSettingsErrorEvent error = 1

  • MailServerSettingsChangedEvent mailServerSettingsChanged = 2

  • ChangeMailServerSettingsFinishedEvent changeMailServerSettingsFinished = 3

Used in: KeychainEvent

(message has no fields)

Used in: AppEvent

(message has no fields)

Used in: AppEvent

(message has no fields)

Used in: AppEvent

(message has no fields)

Used in: AppEvent

(message has no fields)

Used in: AppEvent

(message has no fields)

Used in: AppEvent

(message has no fields)

Used in: AppEvent

(message has no fields)

Used in: UserEvent

• string userID = 1

Used in: UserEvent

• string userID = 1

• double progress = 2

• int64 elapsedMs = 3

• int64 remainingMs = 4

Used in: UserEvent

• string userID = 1

Used in: AppEvent

(message has no fields)

Used in: UserEvent

• string userID = 1

Used in: UpdateEvent

(message has no fields)

Used in: UpdateEvent

• UpdateErrorType type = 1

Used in: UpdateErrorEvent

• UPDATE_MANUAL_ERROR = 0

• UPDATE_FORCE_ERROR = 1

• UPDATE_SILENT_ERROR = 2

********************************************************** Update related events **********************************************************

Used in: StreamEvent

• oneof event

  • UpdateErrorEvent error = 1

  • UpdateManualReadyEvent manualReady = 2

  • UpdateManualRestartNeededEvent manualRestartNeeded = 3

  • UpdateForceEvent force = 4

  • UpdateSilentRestartNeeded silentRestartNeeded = 5

  • UpdateIsLatestVersion isLatestVersion = 6

  • UpdateCheckFinished checkFinished = 7

  • UpdateVersionChanged versionChanged = 8

Used in: UpdateEvent

• string version = 1

Used in: UpdateEvent

(message has no fields)

Used in: UpdateEvent

• string version = 1

Used in: UpdateEvent

(message has no fields)

Used in: UpdateEvent

(message has no fields)

Used in: UpdateEvent

(message has no fields)

Used in: UserEvent

• string userID = 1

• int64 usedBytes = 2

Used as response type in: Bridge.GetUser

Used as field type in: UserListResponse

• string id = 1

• string username = 2

• string avatarText = 3

• UserState state = 4

• bool splitMode = 5

• int64 usedBytes = 6

• int64 totalBytes = 7

• bytes password = 8

• repeated string addresses = 9

Used in: UserEvent

• string userID = 1

• string errorMessage = 2

Used in: UserEvent

• string userID = 1

Used in: UserEvent

• string username = 1

Used in: StreamEvent

• oneof event

  • ToggleSplitModeFinishedEvent toggleSplitModeFinished = 1

  • UserDisconnectedEvent userDisconnected = 2

  • UserChangedEvent userChanged = 3

  • UserBadEvent userBadEvent = 4

  • UsedBytesChangedEvent usedBytesChangedEvent = 5

  • ImapLoginFailedEvent imapLoginFailedEvent = 6

  • SyncStartedEvent syncStartedEvent = 7

  • SyncFinishedEvent syncFinishedEvent = 8

  • SyncProgressEvent syncProgressEvent = 9

Used in: AppEvent

• string title = 1

• string subtitle = 2

• string body = 3

• string userID = 4

********************************************************** user related messages **********************************************************

Used in: User

• SIGNED_OUT = 0

• LOCKED = 1

• CONNECTED = 2