client

package

Go to main page

Versions in this module

v0

v0.1.10

Oct 30, 2026

v0.1.9

Oct 30, 2026

Changes in this version

+ const DevelVersion

+ const Module

+ func DeprecationWords(own string, at time.Time) string

+ func MinVersion(p *protocol.Problem) (string, bool)

+ func SunsetWords(own string, at time.Time) string

+ func UpgradeWords(own, latest string) string

+ func Version() string

type APIError

+ Version string

type Mailbox

+ func (b *Mailbox) Versions() *Versions

type Options

+ Version string

+ Versions *Versions

+ type Versions struct

+ func (v *Versions) Deprecation() (at time.Time, passed, ok bool)

+ func (v *Versions) Own() string

+ func (v *Versions) Sunset() (time.Time, bool)

+ func (v *Versions) Upgrade() (string, bool)

v0.1.8

Oct 30, 2026

Changes in this version

+ func Transient(err error) bool

+ type Mailbox struct

+ func (b *Mailbox) ACLPending(ctx context.Context) (bool, error)

+ func (b *Mailbox) Address() protocol.Address

+ func (b *Mailbox) Adopt(ctx context.Context, key string) (string, error)

+ func (b *Mailbox) Aliases() ([]Alias, error)

+ func (b *Mailbox) Allow(ctx context.Context, a protocol.Address) ([]Delivery, error)

+ func (b *Mailbox) Allowed() ([]protocol.Address, error)

+ func (b *Mailbox) Ask(ctx context.Context, a protocol.Address) (*Held, error)

+ func (b *Mailbox) Await(ctx context.Context, until time.Time, say func(*HoldResult, error)) error

+ func (b *Mailbox) Block(ctx context.Context, a protocol.Address) (int, error)

+ func (b *Mailbox) Blocked() ([]protocol.Address, error)

+ func (b *Mailbox) CertificatesRecord(ctx context.Context) (*protocol.Revocations, error)

+ func (b *Mailbox) Destination(s string) (protocol.Address, error)

+ func (b *Mailbox) Dir() string

+ func (b *Mailbox) Flush(ctx context.Context) ([]*Sent, error)

+ func (b *Mailbox) HeldMessages() ([]UnknownSender, error)

+ func (b *Mailbox) Hold(ctx context.Context, wait time.Duration) (*HoldResult, error)

+ func (b *Mailbox) Identity() *protocol.Identity

+ func (b *Mailbox) Inbox() ([]Delivery, error)

+ func (b *Mailbox) InboxMessage(id string) (Delivery, error)

+ func (b *Mailbox) KeepRevocation(ctx context.Context, rec *protocol.Revocations) (a protocol.Address, h *Held, err error)

+ func (b *Mailbox) Leave(ctx context.Context) error

+ func (b *Mailbox) Link() string

+ func (b *Mailbox) NotMade(ctx context.Context) (*NotMade, error)

+ func (b *Mailbox) Policy() (Policy, error)

+ func (b *Mailbox) PrekeyLifetime() (time.Duration, error)

+ func (b *Mailbox) Publish(ctx context.Context, rec *protocol.Revocations) (protocol.Address, error)

+ func (b *Mailbox) RebuildAllowed(ctx context.Context) (int, error)

+ func (b *Mailbox) Receive(ctx context.Context) (*Result, error)

+ func (b *Mailbox) RefusedMessages(ctx context.Context) ([]RefusedMessage, error)

+ func (b *Mailbox) Rekey(ctx context.Context, kt protocol.KeyType) (*protocol.Prekey, error)

+ func (b *Mailbox) RemoveAlias(ctx context.Context, name string) error

+ func (b *Mailbox) RemoveRefused(ctx context.Context, ids []string) ([]string, error)

+ func (b *Mailbox) RenewAndRevoke(ctx context.Context, kt protocol.KeyType) (*Remedy, error)

+ func (b *Mailbox) Resolve(ctx context.Context, peer protocol.Address) (*protocol.Prekey, error)

+ func (b *Mailbox) Revocation(ctx context.Context) (*protocol.Revocations, error)

+ func (b *Mailbox) Revoke(ctx context.Context, rec *protocol.Revocations) (protocol.Address, error)

+ func (b *Mailbox) RevokeEarlier(ctx context.Context) (*protocol.RevokedCertificates, error)

+ func (b *Mailbox) Send(ctx context.Context, to protocol.Address, body string) (*Sent, error)

+ func (b *Mailbox) SendJSON(ctx context.Context, to protocol.Address, body []byte, f Fields) (*Sent, error)

+ func (b *Mailbox) SendWith(ctx context.Context, to protocol.Address, body string, f Fields) (*Sent, error)

+ func (b *Mailbox) SetAlias(ctx context.Context, name string, a protocol.Address) error

+ func (b *Mailbox) SetPolicy(ctx context.Context, p Policy) error

+ func (b *Mailbox) SetPrekeyLifetime(ctx context.Context, d time.Duration) error

+ func (b *Mailbox) Status(ctx context.Context) (*Status, error)

+ func (b *Mailbox) SyncACL(ctx context.Context) error

+ type RefusedMessage struct

+ CertificateBegan string

+ CertificateEnds string

+ CertificateSerial uint64

+ ClaimsIdentity string

+ Code string

+ ID string

+ JudgedAt string

+ MsgID string

+ Reason string

+ ReceivedAt string

+ SentAt string

+ SignedBy string

v0.1.7

Oct 29, 2026

v0.1.6

Oct 28, 2026

v0.1.5

Oct 28, 2026

Changes in this version

+ const ReceiveEvery

type Box

+ func (b *Box) Await(ctx context.Context, until time.Time, say func(*HoldResult, error)) error

+ func (b *Box) Inbox() ([]Delivery, error)

+ func (b *Box) InboxMessage(id string) (Delivery, error)

+ func (b *Box) RefusedMail(ctx context.Context) ([]RefusedMail, error)

+ func (b *Box) RemoveRefused(ctx context.Context, ids []string) ([]string, error)

+ type RefusedMail struct

+ CertificateBegan string

+ CertificateEnds string

+ CertificateSerial uint64

+ ClaimsIdentity string

+ Code string

+ ID string

+ JudgedAt string

+ MsgID string

+ Reason string

+ ReceivedAt string

+ SentAt string

+ SignedBy string

type Status

+ Refused int

+ type UnknownSender struct

+ FirstSentAt string

+ From protocol.Address

+ IDs []string

+ LastSentAt string

v0.1.4

Oct 28, 2026

v0.1.3

Oct 28, 2026

Changes in this version

+ const DefaultHold

+ const MinHold

type Box

+ func (b *Box) Hold(ctx context.Context, wait time.Duration) (*HoldResult, error)

+ type HoldResult struct

+ After time.Duration

+ Changed bool

+ Dropped bool

+ KeepAlive time.Duration

+ Wait time.Duration

v0.1.2

Oct 27, 2026

v0.1.1

Oct 26, 2026

v0.1.0

Oct 25, 2026

Changes in this version

+ const AdmitAll

+ const AdmitAllowed

+ const DefaultBase

+ const DefaultDrainTime

+ const EchoAddress

+ const EchoAddressNoPQ

+ const LandHeld

+ const LandInbox

+ const MinPrekeyLifetime

+ const RefusedCertificate

+ const RefusedDecrypt

+ const RefusedID

+ const RefusedPrekeyType

+ const RefusedReplay

+ const RefusedRevoked

+ func Dir() (string, error)

+ func IsID(s string) bool

+ func Publish(ctx context.Context, opt Options, rec *protocol.Revocations) (protocol.Address, error)

+ func RecvWithin(lifetime time.Duration) time.Duration

+ func Revoke(ctx context.Context, opt Options, rec *protocol.Revocations) (protocol.Address, error)

+ func ValidAlias(name string) error

+ type APIError struct

+ Dated time.Time

+ Problem protocol.Problem

+ Read time.Time

+ RetryAfter time.Duration

+ Status int

+ func (e *APIError) Error() string

+ type Alias struct

+ Address protocol.Address

+ Name string

+ type Box struct

+ func Init(ctx context.Context, dir string, opt Options, kt protocol.KeyType) (*Box, error)

+ func Open(dir string, opt Options) (*Box, error)

+ func (b *Box) ACLPending(ctx context.Context) (bool, error)

+ func (b *Box) Address() protocol.Address

+ func (b *Box) Adopt(ctx context.Context, key string) (string, error)

+ func (b *Box) Aliases() ([]Alias, error)

+ func (b *Box) Allow(ctx context.Context, a protocol.Address) ([]Delivery, error)

+ func (b *Box) Allowed() ([]protocol.Address, error)

+ func (b *Box) Ask(ctx context.Context, a protocol.Address) (*Held, error)

+ func (b *Box) Block(ctx context.Context, a protocol.Address) (int, error)

+ func (b *Box) Blocked() ([]protocol.Address, error)

+ func (b *Box) CertificatesRecord(ctx context.Context) (*protocol.Revocations, error)

+ func (b *Box) Destination(s string) (protocol.Address, error)

+ func (b *Box) Dir() string

+ func (b *Box) Flush(ctx context.Context) ([]*Sent, error)

+ func (b *Box) HeldMail() ([]HeldSender, error)

+ func (b *Box) Identity() *protocol.Identity

+ func (b *Box) InboxLine(id string) ([]byte, error)

+ func (b *Box) KeepRevocation(ctx context.Context, rec *protocol.Revocations) (a protocol.Address, h *Held, err error)

+ func (b *Box) Leave(ctx context.Context) error

+ func (b *Box) Link() string

+ func (b *Box) NotMade(ctx context.Context) (*NotMade, error)

+ func (b *Box) Policy() (Policy, error)

+ func (b *Box) PrekeyLifetime() (time.Duration, error)

+ func (b *Box) Publish(ctx context.Context, rec *protocol.Revocations) (protocol.Address, error)

+ func (b *Box) Quarantined(ctx context.Context) ([]Quarantined, error)

+ func (b *Box) RebuildAllowed(ctx context.Context) (int, error)

+ func (b *Box) Receive(ctx context.Context) (*Result, error)

+ func (b *Box) Rekey(ctx context.Context, kt protocol.KeyType) (*protocol.Prekey, error)

+ func (b *Box) RemoveAlias(ctx context.Context, name string) error

+ func (b *Box) RemoveQuarantined(ctx context.Context, ids []string) ([]string, error)

+ func (b *Box) RenewAndRevoke(ctx context.Context, kt protocol.KeyType) (*Remedy, error)

+ func (b *Box) Resolve(ctx context.Context, peer protocol.Address) (*protocol.Prekey, error)

+ func (b *Box) Revocation(ctx context.Context) (*protocol.Revocations, error)

+ func (b *Box) Revoke(ctx context.Context, rec *protocol.Revocations) (protocol.Address, error)

+ func (b *Box) RevokeEarlier(ctx context.Context) (*protocol.RevokedCertificates, error)

+ func (b *Box) Send(ctx context.Context, to protocol.Address, body string) (*Sent, error)

+ func (b *Box) SendJSON(ctx context.Context, to protocol.Address, body []byte, f Fields) (*Sent, error)

+ func (b *Box) SendWith(ctx context.Context, to protocol.Address, body string, f Fields) (*Sent, error)

+ func (b *Box) SetAlias(ctx context.Context, name string, a protocol.Address) error

+ func (b *Box) SetPolicy(ctx context.Context, p Policy) error

+ func (b *Box) SetPrekeyLifetime(ctx context.Context, d time.Duration) error

+ func (b *Box) Status(ctx context.Context) (*Status, error)

+ func (b *Box) SyncACL(ctx context.Context) error

+ type Delivery struct

+ Envelope *protocol.Envelope

+ ID string

+ Line []byte

+ Plaintext []byte

+ Signature []byte

+ type Fields struct

+ InReplyTo string

+ Subject string

+ Supersedes string

+ type Held struct

+ Certificates *protocol.RevokedCertificates

+ Revoked bool

+ type HeldSender struct

+ FirstSentAt string

+ From protocol.Address

+ IDs []string

+ LastSentAt string

+ type NotMade struct

+ At string

+ CertificateSerial uint64

+ OwnCertificate bool

+ Serial uint64

+ func (nm *NotMade) Words() string

+ type Options struct

+ Base string

+ DrainTime time.Duration

+ HTTPClient *http.Client

+ IdentityType string

+ Now func() time.Time

+ SenderKeyTypes []string

+ Waiting func()

+ type Policy struct

+ Server string

+ Unknown string

+ func DefaultPolicy() Policy

+ type Quarantined struct

+ CertificateBegan string

+ CertificateEnds string

+ CertificateSerial uint64

+ ClaimsIdentity string

+ Code string

+ From string

+ ID string

+ JudgedAt string

+ MsgID string

+ Reason string

+ ReceivedAt string

+ SentAt string

+ SignedBy string

+ type Refusal struct

+ Code string

+ Findings *protocol.Findings

+ ID string

+ Reason string

+ type RefusedError struct

+ Code string

+ Reason string

+ func (e *RefusedError) Error() string

+ type Remedy struct

+ Below uint64

+ NotRenewed error

+ NotRevoked error

+ Prekey *protocol.Prekey

+ Revoked *protocol.RevokedCertificates

+ Unread error

+ type Result struct

+ ACLErr error

+ ACLReplaced bool

+ Blocked []string

+ Delivered []Delivery

+ Duplicates []string

+ Held []Delivery

+ More bool

+ NotMade *NotMade

+ Paced time.Duration

+ PollAfter int64

+ Refused []Refusal

+ RenewErr error

+ Renewed *protocol.Prekey

+ func (r *Result) Again() time.Duration

+ type RevokedError struct

+ Address protocol.Address

+ Own bool

+ func (e *RevokedError) Error() string

+ type Sent struct

+ ACLErr error

+ MsgID string

+ To protocol.Address

+ type Status struct

+ Address protocol.Address

+ Attention []string

+ CertificateNotAfter string

+ CertificateSerial uint64

+ Held int

+ Inbox int

+ Outbox int

+ OutboxFailed int

+ Policy Policy

+ PrekeyLifetime int64

+ PrekeyMade string

+ PrekeyNotAfter string

+ PrekeyNotMade *NotMade

+ PrekeySerial uint64

+ Quarantine int

+ RenewalPendingSince string

+ Revoked bool

+ Sent int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL