api

package
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Oct 22, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package api defines the arguments and results of every control operation, shared by the CLI and the server so both always agree.

Index

Constants

View Source 
const (
	OpStatus    = "status"
	OpDoctor    = "doctor"
	OpConfig    = "config.list"
	OpConfigGet = "config.get"
	OpConfigSet = "config.set"

	OpDomainAdd    = "domain.add"
	OpDomainList   = "domain.list"
	OpDomainRemove = "domain.remove"
	OpDomainDNS    = "domain.dns"
	OpDomainRotate = "domain.rotate"

	OpMailboxAdd    = "mailbox.add"
	OpMailboxList   = "mailbox.list"
	OpMailboxRemove = "mailbox.remove"
	OpMailboxRename = "mailbox.rename"
	OpMailboxSet    = "mailbox.set"
	OpAliasAdd      = "alias.add"
	OpAliasRemove   = "alias.remove"
	OpCatchall      = "catchall.set"

	OpMailList       = "mail.list"
	OpMailRead       = "mail.read"
	OpMailMove       = "mail.move"
	OpMailFlag       = "mail.flag"
	OpMailDelete     = "mail.delete"
	OpMailSend       = "mail.send"
	OpMailReply      = "mail.reply"
	OpMailAttachment = "mail.attachment"
	OpWatch          = "watch"
	OpEvents         = "events.list"

	OpListAdd    = "list.add"
	OpListList   = "list.list"
	OpListShow   = "list.show"
	OpListSet    = "list.set"
	OpListRemove = "list.remove"
	OpListPause  = "list.pause"

	OpSubAdd        = "sub.add"
	OpSubList       = "sub.list"
	OpSubRemove     = "sub.remove"
	OpSubImport     = "sub.import"
	OpSubExport     = "sub.export"
	OpContactShow   = "contact.show"
	OpContactForget = "contact.forget"
	OpSuppress      = "contact.suppress"
	OpUnsuppress    = "contact.unsuppress"

	OpIssueCreate  = "issue.create"
	OpIssuePut     = "issue.put"
	OpIssueUpdate  = "issue.update"
	OpIssueList    = "issue.list"
	OpIssueShow    = "issue.show"
	OpIssueLint    = "issue.lint"
	OpIssuePreview = "issue.preview"
	OpIssueTest    = "issue.test"
	OpIssueSend    = "issue.send"
	OpIssueCancel  = "issue.cancel"
	OpIssueStats   = "issue.stats"
	OpIssueRemove  = "issue.remove"

	OpSitePut   = "site.put"
	OpSiteCheck = "site.check"

	OpRelaySet     = "relay.set"
	OpRelayShow    = "relay.show"
	OpRelayTest    = "relay.test"
	OpRelayWebhook = "relay.webhook"

	OpQueueList  = "queue.list"
	OpQueueRetry = "queue.retry"
	OpQueueDrop  = "queue.drop"

	OpSpamStats = "spam.stats"
	OpSpamReset = "spam.reset"
	OpReports   = "reports.list"
	OpBackup    = "backup"
)

Op names.

Variables

This section is empty.

Functions

This section is empty.

Types

type Alias 

type Alias struct {
	Alias  string `json:"alias"`
	Target string `json:"target"`
}

Alias points an address at a mailbox.

type Attachment 

type Attachment struct {
	ID    int64 `json:"id"`
	Index int   `json:"index"`
}

Attachment asks for one attachment.

type Backup 

type Backup struct {
	Dir string `json:"dir"`
}

Backup writes a copy of the data directory.

type BackupResult 

type BackupResult struct {
	Dir   string `json:"dir"`
	Blobs int    `json:"blobs"`
	Bytes int64  `json:"bytes"`
}

BackupResult reports the backup.

type CSV 

type CSV struct {
	Rows int    `json:"rows"`
	CSV  string `json:"csv"`
}

CSV is exported data.

type Catchall 

type Catchall struct {
	Domain string `json:"domain"`
	Target string `json:"target"`
}

Catchall sets or clears a domain's catch-all mailbox.

type Check 

type Check struct {
	Name   string `json:"name"`
	Status string `json:"status"` // ok, warn, fail, skip
	Detail string `json:"detail"`
	Fix    string `json:"fix,omitempty"`
}

Check is one doctor result.

type ConfigSet 

type ConfigSet struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

ConfigSet changes a setting.

type DomainDNS 

type DomainDNS struct {
	Name  string `json:"name"`
	Check bool   `json:"check"`
}

DomainDNS asks for a domain's records, optionally checked against live DNS.

type DomainInfo 

type DomainInfo struct {
	Name     string           `json:"name"`
	Selector string           `json:"selector"`
	Next     string           `json:"next_selector,omitempty"` // rotation prepared, not yet signing
	Catchall string           `json:"catchall,omitempty"`
	Created  time.Time        `json:"created"`
	Records  []domains.Record `json:"records,omitempty"`
	Zone     string           `json:"zone,omitempty"`
	Checks   []RecordCheck    `json:"checks,omitempty"`
	Notes    []string         `json:"notes,omitempty"`
}

DomainInfo is a domain with what DNS must hold.

type Events 

type Events struct {
	Since string   `json:"since,omitempty"` // duration like 24h, or RFC 3339
	Kinds []string `json:"kinds,omitempty"`
	List  string   `json:"list,omitempty"`
	Issue int64    `json:"issue,omitempty"`
	Limit int      `json:"limit,omitempty"`
}

Events lists stored events.

type File 

type File struct {
	Name string `json:"name"`
	Type string `json:"type,omitempty"`
	Data []byte `json:"data"`
}

File is an attachment in transit.

type ID 

type ID struct {
	ID int64 `json:"id"`
}

ID selects one thing by number.

type IDs 

type IDs struct {
	IDs []int64 `json:"ids"`
}

IDs selects several messages.

type IssueDraft 

type IssueDraft struct {
	List      string `json:"list,omitempty"`
	ID        int64  `json:"id,omitempty"`
	Markdown  string `json:"markdown"`
	Subject   string `json:"subject,omitempty"`
	Slug      string `json:"slug,omitempty"`
	Preheader string `json:"preheader,omitempty"`
	Summary   string `json:"summary,omitempty"`
	Welcome   bool   `json:"welcome,omitempty"` // issue.put: make it the list's welcome issue
	// issue.put: the images the Markdown references by a local path. nil
	// keeps the stored images; an empty list removes them.
	Media *[]issues.File `json:"media,omitempty"`
}

IssueDraft creates or changes an issue.

type IssueList 

type IssueList struct {
	List string `json:"list"`
}

IssueList selects a list's issues.

type IssuePut 

type IssuePut struct {
	Issue   issues.Issue `json:"issue"`
	Created bool         `json:"created"`
}

IssuePut is the result of issue.put.

type IssueRef 

type IssueRef struct {
	ID   int64  `json:"id,omitempty"`
	List string `json:"list,omitempty"`
	Slug string `json:"slug,omitempty"`
}

IssueRef names an issue by ID, or by its list and slug.

type IssueSend 

type IssueSend struct {
	IssueRef
	At    string `json:"at,omitempty"`
	Force bool   `json:"force,omitempty"` // send despite warnings (errors always block)
}

IssueSend schedules an issue; At empty means now.

type IssueTest 

type IssueTest struct {
	IssueRef
	To []string `json:"to"`
}

IssueTest sends test copies.

type ListFields 

type ListFields struct {
	Name        *string `json:"name,omitempty"`
	Description *string `json:"description,omitempty"`
	From        *string `json:"from,omitempty"`
	FromName    *string `json:"from_name,omitempty"`
	ReplyTo     *string `json:"reply_to,omitempty"`
	Host        *string `json:"host,omitempty"`
	Language    *string `json:"language,omitempty"`
	Tracking    *bool   `json:"tracking,omitempty"`
	ImprintURL  *string `json:"imprint_url,omitempty"`
	PrivacyURL  *string `json:"privacy_url,omitempty"`
	Address     *string `json:"address,omitempty"`
	Consent     *string `json:"consent,omitempty"`
	Cadence     *string `json:"cadence,omitempty"`
	Headline    *string `json:"headline,omitempty"`
	Pitch       *string `json:"pitch,omitempty"`
	MinGap      *string `json:"min_gap,omitempty"` // a duration like 20h; 0 turns the guard off
}

ListFields are the settable fields of a list.

type ListPause 

type ListPause struct {
	Slug   string `json:"slug"`
	Reason string `json:"reason"`
}

ListPause pauses (with a reason) or resumes (empty reason) a list.

type ListSet 

type ListSet struct {
	Slug string `json:"slug"`
	ListFields
}

ListSet creates or changes a list.

type MailDelete 

type MailDelete struct {
	IDs   []int64 `json:"ids"`
	Purge bool    `json:"purge,omitempty"`
}

MailDelete trashes or purges messages.

type MailFlag 

type MailFlag struct {
	IDs  []int64 `json:"ids"`
	Flag string  `json:"flag"`
	On   bool    `json:"on"`
}

MailFlag sets a flag.

type MailList 

type MailList struct {
	Mailbox string `json:"mailbox,omitempty"`
	Folder  string `json:"folder,omitempty"`
	Unread  bool   `json:"unread,omitempty"`
	Thread  string `json:"thread,omitempty"`
	Search  string `json:"search,omitempty"`
	Limit   int    `json:"limit,omitempty"`
	Before  int64  `json:"before,omitempty"`
}

MailList selects messages; Search makes it a full-text search.

type MailMove 

type MailMove struct {
	IDs    []int64 `json:"ids"`
	Folder string  `json:"folder"`
}

MailMove moves messages; moving into or out of junk teaches the spam filter.

type MailRead 

type MailRead struct {
	ID         int64 `json:"id"`
	Raw        bool  `json:"raw,omitempty"`
	KeepUnread bool  `json:"keep_unread,omitempty"`
}

MailRead reads one message.

type MailReply 

type MailReply struct {
	ID       int64  `json:"id"`
	Markdown string `json:"markdown,omitempty"`
	Text     string `json:"text,omitempty"`
	HTML     string `json:"html,omitempty"`
	All      bool   `json:"all,omitempty"`
	NoQuote  bool   `json:"no_quote,omitempty"`
	Files    []File `json:"files,omitempty"`
}

MailReply answers a message.

type MailSend 

type MailSend struct {
	From     string   `json:"from"`
	To       []string `json:"to"`
	Cc       []string `json:"cc,omitempty"`
	Bcc      []string `json:"bcc,omitempty"`
	ReplyTo  string   `json:"reply_to,omitempty"`
	Subject  string   `json:"subject"`
	Markdown string   `json:"markdown,omitempty"`
	Text     string   `json:"text,omitempty"`
	HTML     string   `json:"html,omitempty"`
	Files    []File   `json:"files,omitempty"`
}

MailSend sends a message from a mailbox. Markdown, when given, becomes the HTML and text parts; otherwise Text and/or HTML are used as they are.

type MailboxAdd 

type MailboxAdd struct {
	Address string `json:"address"`
	Name    string `json:"name"`
}

MailboxAdd creates a mailbox.

type MailboxSet 

type MailboxSet struct {
	Address string  `json:"address"`
	Name    *string `json:"name,omitempty"`
	Forward *string `json:"forward,omitempty"`
}

MailboxSet changes a mailbox; nil keeps a value.

type Name 

type Name struct {
	Name string `json:"name"`
}

Name selects one thing by name, address or slug.

type Preview 

type Preview struct {
	Subject string `json:"subject"`
	HTML    string `json:"html"`
	Text    string `json:"text"`
	Size    int    `json:"size"`
	WebURL  string `json:"web_url"`
}

Preview is a rendered issue.

type QueueList 

type QueueList struct {
	Status string `json:"status,omitempty"`
	Limit  int    `json:"limit,omitempty"`
}

QueueList selects queue entries.

type RecordCheck 

type RecordCheck struct {
	Record domains.Record `json:"record"`
	Status string         `json:"status"` // ok, missing, wrong
	Found  []string       `json:"found,omitempty"`
}

RecordCheck compares one expected record with live DNS.

type RelayInfo 

type RelayInfo struct {
	Mode     string            `json:"mode"` // relay or direct
	URL      string            `json:"url,omitempty"`
	SPF      string            `json:"spf,omitempty"`
	Webhooks map[string]string `json:"webhooks"`
}

RelayInfo describes outbound delivery.

type RelaySet 

type RelaySet struct {
	URL      string `json:"url"`
	Password string `json:"password,omitempty"`
	SPF      string `json:"spf,omitempty"`
}

RelaySet configures the outbound relay; an empty URL means direct delivery.

type Rename 

type Rename struct {
	From string `json:"from"`
	To   string `json:"to"`
}

Rename moves a mailbox to a new address.

type Report 

type Report struct {
	Kind     string          `json:"kind"`
	Org      string          `json:"org"`
	Domain   string          `json:"domain"`
	Begin    time.Time       `json:"begin"`
	End      time.Time       `json:"end"`
	Pass     int             `json:"pass"`
	Fail     int             `json:"fail"`
	Received time.Time       `json:"received"`
	Rows     json.RawMessage `json:"rows,omitempty"` // the report's rows as the reporter sent them
}

Report is a stored DMARC or TLS report.

type Reports 

type Reports struct {
	Kind   string `json:"kind,omitempty"`
	Domain string `json:"domain,omitempty"`
	Limit  int    `json:"limit,omitempty"`
}

Reports selects stored reports.

type Sent 

type Sent struct {
	ID      int64  `json:"id"`
	Queued  int    `json:"queued"`
	Message string `json:"message"`
}

Sent identifies a sent message.

type SitePut 

type SitePut struct {
	List  string            `json:"list"`
	Files map[string][]byte `json:"files"` // relative path → content
}

SitePut uploads a list's website templates and assets.

type Status 

type Status struct {
	Version   string          `json:"version"`
	Uptime    string          `json:"uptime"`
	Hostname  string          `json:"hostname"`
	IPv4      string          `json:"ipv4,omitempty"`
	Transport string          `json:"transport"`
	Domains   int             `json:"domains"`
	Mailboxes int             `json:"mailboxes"`
	Unread    int             `json:"unread"`
	Lists     int             `json:"lists"`
	Members   int             `json:"confirmed_members"`
	Queue     outbound.Status `json:"queue"`
	Paused    []string        `json:"paused,omitempty"` // "<list>: <reason>" for every list that holds its mail
	Listening []string        `json:"listening"`
	Next      []string        `json:"next,omitempty"`
}

Status is the overview `lfr status` shows.

type SubAdd 

type SubAdd struct {
	List      string   `json:"list"`
	Emails    []string `json:"emails"`
	Confirmed bool     `json:"confirmed,omitempty"` // consent exists already: skip double opt-in
	Reconfirm bool     `json:"reconfirm,omitempty"` // readers already on the list confirm again
	Source    string   `json:"source,omitempty"`
	Consent   string   `json:"consent,omitempty"`
}

SubAdd adds addresses to a list.

type SubAddResult 

type SubAddResult struct {
	Added        int      `json:"added"`
	Existing     int      `json:"existing"`
	Confirmation int      `json:"confirmation_sent"`
	OptedOut     int      `json:"opted_out"` // left, complained, bounced or erased: kept off
	Reconfirm    int      `json:"reconfirm"` // on the list already, asked to confirm again
	Invalid      []string `json:"invalid,omitempty"`
}

SubAddResult counts what happened.

type SubImport 

type SubImport struct {
	List      string `json:"list"`
	CSV       string `json:"csv"`
	Confirmed bool   `json:"confirmed,omitempty"`
	Reconfirm bool   `json:"reconfirm,omitempty"`
	Source    string `json:"source,omitempty"`
	Consent   string `json:"consent,omitempty"`
}

SubImport imports a CSV.

type SubList 

type SubList struct {
	List   string `json:"list"`
	Status string `json:"status,omitempty"`
	Search string `json:"search,omitempty"`
	Limit  int    `json:"limit,omitempty"`
	After  int64  `json:"after,omitempty"`
}

SubList selects members.

type SubRemove 

type SubRemove struct {
	List  string `json:"list"`
	Email string `json:"email"`
}

SubRemove unsubscribes an address from a list.

type Suppress 

type Suppress struct {
	Email  string   `json:"email,omitempty"`
	Emails []string `json:"emails,omitempty"` // many at once, e.g. an old platform's unsubscribed export
	Reason string   `json:"reason"`
}

Suppress stops mail to an address.

type Watch 

type Watch struct {
	Kinds []string `json:"kinds,omitempty"`
}

Watch selects event kinds to stream; empty for all.

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.