Categorygithub.com/ProtonMail/go-proton-api

modulepackage

0.4.0

Repository: https://github.com/protonmail/go-proton-api.git

Documentation: pkg.go.dev

# README

Go Proton API

This repository holds Go Proton API, a Go library implementing a client and development server for (a subset of) the Proton REST API.

The license can be found in the LICENSE file.

For the contribution policy, see CONTRIBUTING.

Environment variables

Most of the integration tests run locally. The ones that interact with Proton servers require the following environment variables set:

GO_PROTON_API_TEST_USERNAME
GO_PROTON_API_TEST_PASSWORD

Contribution

The library is maintained by Proton AG, and is not actively looking for contributors.

# Packages

server

No description provided by the author

# Functions

BuildRFC822

No description provided by the author

ClientIDFromContext

ClientIDFromContext returns true if this context was marked as originating from a client.

DecodeKeyPacket

No description provided by the author

EncryptRFC822

EncryptRFC822 encrypts the given message literal as a PGP attachment.

ExtractSignatures

No description provided by the author

InsecureTransport

InsecureTransport returns an http.Transport with InsecureSkipVerify set to true.

New

No description provided by the author

NewCard

No description provided by the author

NewDefaultAttachmentAllocator

No description provided by the author

NewDropConn

No description provided by the author

NewFuture

No description provided by the author

NewGroup

No description provided by the author

NewHangConn

No description provided by the author

NewKeyList

No description provided by the author

NewListener

NewListener returns a new DropListener.

NewNetCtl

NewNetCtl returns a new ctl with all fields set to true.

NewParallelScheduler

No description provided by the author

NewPool

New returns a new pool.

NewSequentialScheduler

No description provided by the author

NewTicker

NewTicker returns a new ticker that ticks at a random time between period and period+jitter.

Unlock

No description provided by the author

WithAppVersion

No description provided by the author

WithClient

WithClient marks this context as originating from the client with the given ID.

WithCookieJar

No description provided by the author

WithDebug

No description provided by the author

WithHostURL

No description provided by the author

WithLogger

No description provided by the author

WithRetryCount

No description provided by the author

WithSkipVerifyProofs

No description provided by the author

WithTransport

No description provided by the author

# Constants

ActiveLinkState

No description provided by the author

ActiveRevisionState

No description provided by the author

AddressStatusDeleting

No description provided by the author

AddressStatusDisabled

No description provided by the author

AddressStatusEnabled

No description provided by the author

AdministerMembersPermission

No description provided by the author

AdminPermission

No description provided by the author

AllDraftsLabel

No description provided by the author

AllMailLabel

No description provided by the author

AllScheduledLabel

No description provided by the author

AllSentLabel

No description provided by the author

APIFalse

No description provided by the author

APITrue

No description provided by the author

AppVersionBadCode

No description provided by the author

AppVersionMissingCode

No description provided by the author

ArchiveLabel

No description provided by the author

AttachedSignature

No description provided by the author

AttachmentDisposition

No description provided by the author

AuthRefreshTokenInvalid

No description provided by the author

AutoResponseAction

No description provided by the author

CalendarAttendeeStatusMaybe

No description provided by the author

CalendarAttendeeStatusNo

No description provided by the author

CalendarAttendeeStatusPending

No description provided by the author

CalendarAttendeeStatusYes

No description provided by the author

CalendarEventTypeClear

No description provided by the author

CalendarEventTypeEncrypted

No description provided by the author

CalendarEventTypeSigned

No description provided by the author

CalendarFlagActive

No description provided by the author

CalendarFlagIncompleteSetup

No description provided by the author

CalendarFlagLostAccess

No description provided by the author

CalendarFlagResetNeeded

No description provided by the author

CalendarFlagUpdatePassphrase

No description provided by the author

CalendarKeyFlagActive

No description provided by the author

CalendarKeyFlagPrimary

No description provided by the author

CalendarTypeNormal

No description provided by the author

CalendarTypeSubscribed

No description provided by the author

CardTypeClear

No description provided by the author

CardTypeEncrypted

No description provided by the author

CardTypeSigned

No description provided by the author

ClearMIMEScheme

No description provided by the author

ClearScheme

No description provided by the author

ClientTypeCalendar

No description provided by the author

ClientTypeDrive

No description provided by the author

ClientTypeEmail

No description provided by the author

ClientTypeVPN

No description provided by the author

CreateLinkEvent

No description provided by the author

DefaultAppVersion

DefaultAppVersion is the default app version used to communicate with the API.

DefaultHostURL

DefaultHostURL is the default host of the API.

DeletedLinkState

No description provided by the author

DeleteLinkEvent

No description provided by the author

DetachedSignature

No description provided by the author

DraftLinkState

No description provided by the author

DraftRevisionState

No description provided by the author

DraftsLabel

No description provided by the author

EmailTokenType

No description provided by the author

EncryptedOutsideScheme

No description provided by the author

EventCreate

No description provided by the author

EventDelete

No description provided by the author

EventUpdate

No description provided by the author

EventUpdateFlags

No description provided by the author

FieldPMEncrypt

No description provided by the author

FieldPMMIMEType

No description provided by the author

FieldPMScheme

No description provided by the author

FieldPMSign

No description provided by the author

FileLinkType

No description provided by the author

FolderLinkType

No description provided by the author

ForwardAction

No description provided by the author

HasFIDO2

No description provided by the author

HasTOTP

No description provided by the author

HumanVerificationRequired

No description provided by the author

InboxLabel

No description provided by the author

InlineDisposition

No description provided by the author

InternalScheme

No description provided by the author

InvalidValue

No description provided by the author

KeyStateActive

2^1 = 2 means the key is still in use (i.e.

KeyStateTrusted

2^0 = 1 means the key is not compromised (i.e.

LabelTypeContactGroup

No description provided by the author

LabelTypeFolder

No description provided by the author

LabelTypeLabel

No description provided by the author

LabelTypeSystem

No description provided by the author

MailUserType

No description provided by the author

MessageFlagAlias

No description provided by the author

MessageFlagAuto

No description provided by the author

MessageFlagAutoReplied

No description provided by the author

MessageFlagDKIMFail

No description provided by the author

MessageFlagDMARCFail

No description provided by the author

MessageFlagDMARCPass

No description provided by the author

MessageFlagE2E

No description provided by the author

MessageFlagForwarded

No description provided by the author

MessageFlagHamManual

No description provided by the author

MessageFlagImported

No description provided by the author

MessageFlagInternal

No description provided by the author

MessageFlagNotified

No description provided by the author

MessageFlagOpened

No description provided by the author

MessageFlagPhishingAuto

No description provided by the author

MessageFlagPhishingManual

No description provided by the author

MessageFlagPublicKey

No description provided by the author

MessageFlagReceipt

No description provided by the author

MessageFlagReceiptRequest

No description provided by the author

MessageFlagReceiptSent

No description provided by the author

MessageFlagReceived

No description provided by the author

MessageFlagReplied

No description provided by the author

MessageFlagRepliedAll

No description provided by the author

MessageFlagScheduledSend

No description provided by the author

MessageFlagSent

No description provided by the author

MessageFlagSign

No description provided by the author

MessageFlagSpamAuto

No description provided by the author

MessageFlagSpamManual

No description provided by the author

MessageFlagSPFFail

No description provided by the author

MessageFlagTouched

No description provided by the author

MessageFlagUnsubscribed

No description provided by the author

MultiCode

No description provided by the author

NoFlags

No description provided by the author

NoPermissions

No description provided by the author

NoSignature

No description provided by the author

ObsoleteRevisionState

No description provided by the author

OnePasswordMode

No description provided by the author

OutboxLabel

No description provided by the author

PaidPlanRequired

No description provided by the author

PasswordWrong

No description provided by the author

PGPInlineScheme

No description provided by the author

PGPMIMEScheme

No description provided by the author

PrimaryShare

No description provided by the author

ReadPermission

No description provided by the author

ReadReceiptAction

No description provided by the author

RecipientTypeExternal

No description provided by the author

RecipientTypeInternal

No description provided by the author

RefreshAll

1<<8 - 1 = 255.

RefreshMail

1<<0 = 1.

ReplyAction

No description provided by the author

ReplyAllAction

No description provided by the author

SentLabel

No description provided by the author

SignExternalMessagesDisabled

No description provided by the author

SignExternalMessagesEnabled

No description provided by the author

SMSTokenType

No description provided by the author

SpamLabel

No description provided by the author

StarredLabel

No description provided by the author

StatusDown

No description provided by the author

StatusUp

No description provided by the author

SuccessCode

No description provided by the author

SuperAdminPermission

No description provided by the author

TrashedLinkState

No description provided by the author

TrashLabel

No description provided by the author

TwoPasswordMode

No description provided by the author

UpdateContentsLinkEvent

No description provided by the author

UpdateMetadataLinkEvent

No description provided by the author

UsernameInvalid

Deprecated, but still used.

VPNUserType

No description provided by the author

WritePermission

No description provided by the author

# Variables

CharsetReader

CharsetReader returns a charset decoder for the given charset.

ErrBadHeader

No description provided by the author

ErrInvalidProof

No description provided by the author

ErrJobCancelled

ErrJobCancelled indicates the job was cancelled.

ErrNoSuchLabel

No description provided by the author

ErrUndoTokenExpired

No description provided by the author

# Structs

Address

No description provided by the author

AddressEvent

No description provided by the author

APIError

APIError represents an error returned by the API.

Attachment

No description provided by the author

Auth

No description provided by the author

Auth2FAReq

No description provided by the author

AuthInfo

No description provided by the author

AuthInfoReq

No description provided by the author

AuthModulus

No description provided by the author

AuthRefreshReq

No description provided by the author

AuthReq

No description provided by the author

AuthSession

No description provided by the author

AuthVerifier

No description provided by the author

Block

No description provided by the author

Calendar

No description provided by the author

CalendarAttendee

No description provided by the author

CalendarEvent

No description provided by the author

CalendarEventPart

TODO: Only personal events have MemberID; should we have a different type for that?.

CalendarKey

No description provided by the author

CalendarMember

No description provided by the author

CalendarPassphrase

TODO: Support invitations.

Card

No description provided by the author

CardGroup

No description provided by the author

Client

Client is the proton client.

Contact

No description provided by the author

ContactCards

No description provided by the author

ContactEmail

No description provided by the author

ContactMetadata

No description provided by the author

ContactSettings

No description provided by the author

CreateAddressKeyReq

No description provided by the author

CreateAttachmentReq

No description provided by the author

CreateContactsReq

No description provided by the author

CreateContactsRes

No description provided by the author

CreateDraftReq

No description provided by the author

CreateLabelReq

No description provided by the author

CreateUserReq

No description provided by the author

DefaultAttachmentAllocator

No description provided by the author

DeleteContactsReq

No description provided by the author

DeleteUserReq

No description provided by the author

DraftTemplate

No description provided by the author

Event

No description provided by the author

EventItem

No description provided by the author

FIDO2Info

No description provided by the author

FIDO2Req

No description provided by the author

FileProperties

No description provided by the author

FolderProperties

No description provided by the author

FullMessage

No description provided by the author

Future

No description provided by the author

Group

No description provided by the author

ImportMetadata

No description provided by the author

ImportReq

No description provided by the author

ImportRes

No description provided by the author

Key

No description provided by the author

KeyList

No description provided by the author

KeyListEntry

No description provided by the author

Label

No description provided by the author

LabelEvent

No description provided by the author

LabelMessageRes

No description provided by the author

LabelMessagesReq

No description provided by the author

LabelMessagesRes

No description provided by the author

Link

No description provided by the author

LinkEvent

No description provided by the author

Listener

Listener wraps a net.Listener.

MailSettings

No description provided by the author

MakeAddressKeyPrimaryReq

No description provided by the author

Manager

No description provided by the author

MemberPassphrase

No description provided by the author

Message

No description provided by the author

MessageActionReq

No description provided by the author

MessageEvent

No description provided by the author

MessageFilter

No description provided by the author

MessageMetadata

No description provided by the author

MessagePackage

No description provided by the author

MessageRecipient

No description provided by the author

NetCtl

ctl can be used to control whether a dialer can dial, and whether the resulting connection can read or write.

NetError

NetError represents a network error.

OrderAddressesReq

No description provided by the author

ParallelScheduler

No description provided by the author

Pool

Pool is a worker pool that handles input of type In and returns results of type Out.

PublicKey

No description provided by the author

RegisteredKey

No description provided by the author

ReportBugAttachment

No description provided by the author

ReportBugReq

No description provided by the author

Revision

No description provided by the author

Salt

No description provided by the author

SendDraftReq

No description provided by the author

SendPreferences

No description provided by the author

SendVerificationCodeReq

No description provided by the author

SequentialScheduler

SequentialScheduler downloads the attachments one by one.

SessionKey

No description provided by the author

SetAttachPublicKeyReq

No description provided by the author

SetDefaultPGPSchemeReq

No description provided by the author

SetDisplayNameReq

No description provided by the author

SetDraftMIMETypeReq

No description provided by the author

SetSignatureReq

No description provided by the author

SetSignExternalMessagesReq

No description provided by the author

Signature

No description provided by the author

Ticker

No description provided by the author

TokenDestination

No description provided by the author

TwoFAInfo

No description provided by the author

UndoRes

No description provided by the author

UndoToken

No description provided by the author

UpdateContactReq

No description provided by the author

UpdateDraftReq

No description provided by the author

UpdateLabelReq

No description provided by the author

User

No description provided by the author

Volume

No description provided by the author

# Interfaces

AttachmentAllocator

AttachmentAllocator abstract the attachment download buffer creation.

Option

Option represents a type that can be used to configure the manager.

Scheduler

Scheduler allows the user to specify how the attachment data for the message should be downloaded.

# Type aliases

AddressStatus

No description provided by the author

APIBool

APIBool is the boolean type used by the API (0 or 1).

Attributes

No description provided by the author

AuthHandler

AuthHandler is given any new auths that are returned from the API due to an unexpected auth refresh.

Bool

Bool is a convenience type for boolean values; it converts from APIBool to Go's builtin bool type.

CalendarAttendeeStatus

TODO: What is this?.

CalendarEventType

No description provided by the author

CalendarFlag

No description provided by the author

CalendarKeyFlag

TODO: What is this?.

CalendarKeys

No description provided by the author

CalendarPassphraseFlag

TODO: What is this?.

CalendarPermissions

TODO: What is this?.

CalendarType

No description provided by the author

Cards

No description provided by the author

CardType

No description provided by the author

ClientType

No description provided by the author

Code

No description provided by the author

CreateDraftAction

No description provided by the author

Disposition

No description provided by the author

EncryptionScheme

No description provided by the author

EventAction

No description provided by the author

FileRevisionState

No description provided by the author

Handler

Handler is a generic function that can be registered for a certain event (e.g.

Headers

No description provided by the author

Keys

No description provided by the author

KeyState

No description provided by the author

LabelType

No description provided by the author

LinkEventType

No description provided by the author

LinkState

No description provided by the author

LinkType

No description provided by the author

LinkWalkFunc

No description provided by the author

MessageFlag

No description provided by the author

PasswordMode

No description provided by the author

Permissions

No description provided by the author

PublicKeys

No description provided by the author

RecipientType

No description provided by the author

RefreshFlag

No description provided by the author

Salts

No description provided by the author

ShareFlags

No description provided by the author

ShareState

No description provided by the author

ShareType

No description provided by the author

SignatureType

No description provided by the author

SignExternalMessages

No description provided by the author

Status

No description provided by the author

StatusObserver

No description provided by the author

TokenType

No description provided by the author

TwoFAStatus

No description provided by the author

UserType

No description provided by the author

VolumeState

No description provided by the author