bot

Documentation

Index

• Variables
• type Bot
  • func New(q *queue.Queue, lp *linkpearl.Linkpearl, log *zerolog.Logger, ...) (*Bot, error)
  • func (b *Bot) ActivateAlias(ctx context.Context, ownerID id.UserID, roomID id.RoomID, alias string) bool
  • func (b *Bot) ActivateMailbox(ctx context.Context, ownerID id.UserID, roomID id.RoomID, mailbox string) bool
  • func (b *Bot) AllowAuth(ctx context.Context, email, password string) (id.RoomID, bool)
  • func (b *Bot) BanAuth(ctx context.Context, addr net.Addr)
  • func (b *Bot) BanAuto(ctx context.Context, addr net.Addr)
  • func (b *Bot) BanManually(ctx context.Context, addr net.Addr)
  • func (b *Bot) Error(ctx context.Context, message string, args ...any)
  • func (b *Bot) GetDKIMprivkey(ctx context.Context) string
  • func (b *Bot) GetIFOptions(ctx context.Context, roomID id.RoomID) email.IncomingFilteringOptions
  • func (b *Bot) GetMapping(ctx context.Context, mailbox string) (id.RoomID, bool)
  • func (b *Bot) GetRelayConfig(ctx context.Context, roomID id.RoomID) *url.URL
  • func (b *Bot) IncomingEmail(ctx context.Context, eml *email.Email) error
  • func (b *Bot) IsBanned(ctx context.Context, addr net.Addr) bool
  • func (b *Bot) IsGreylisted(ctx context.Context, addr net.Addr) bool
  • func (b *Bot) IsTrusted(addr net.Addr) bool
  • func (b *Bot) SendEmailReply(ctx context.Context)
  • func (b *Bot) Sendmail(ctx context.Context, eventID id.EventID, from, to, data string, ...) (bool, error)
  • func (b *Bot) SetSendmail(sendmail func(string, string, string, *url.URL) error)
  • func (b *Bot) Start(statusMsg string) error
  • func (b *Bot) Stop()
  • func (b *Bot) SyncRooms()
• type MBXConfig

Variables

var ErrNoRoom = errors.New("room not found")

Types

type Bot

type Bot struct {
	// contains filtered or unexported fields
}

Bot represents matrix bot

func New

func New(
	q *queue.Queue,
	lp *linkpearl.Linkpearl,
	log *zerolog.Logger,
	cfg *config.Manager,
	psdc *psd.Client,
	proxies []string,
	prefix string,
	domains []string,
	admins []string,
	mbxc MBXConfig,
) (*Bot, error)

New creates a new matrix bot

func (*Bot) ActivateAlias

func (b *Bot) ActivateAlias(ctx context.Context, ownerID id.UserID, roomID id.RoomID, alias string) bool

func (*Bot) ActivateMailbox

func (b *Bot) ActivateMailbox(ctx context.Context, ownerID id.UserID, roomID id.RoomID, mailbox string) bool

ActivateMailbox using the configured flow

func (*Bot) AllowAuth

func (b *Bot) AllowAuth(ctx context.Context, email, password string) (id.RoomID, bool)

AllowAuth check if SMTP login (email) and password are valid

func (*Bot) BanAuth

func (b *Bot) BanAuth(ctx context.Context, addr net.Addr)

Ban an address for incorrect auth automatically

func (*Bot) BanAuto

func (b *Bot) BanAuto(ctx context.Context, addr net.Addr)

Ban an address automatically

func (*Bot) BanManually

func (b *Bot) BanManually(ctx context.Context, addr net.Addr)

Ban an address manually

func (*Bot) Error

func (b *Bot) Error(ctx context.Context, message string, args ...any)

Error message to the log and matrix room

func (*Bot) GetDKIMprivkey

func (b *Bot) GetDKIMprivkey(ctx context.Context) string

GetDKIMprivkey returns DKIM private key

func (*Bot) GetIFOptions

func (b *Bot) GetIFOptions(ctx context.Context, roomID id.RoomID) email.IncomingFilteringOptions

GetIFOptions returns incoming email filtering options (room settings)

func (*Bot) GetMapping

func (b *Bot) GetMapping(ctx context.Context, mailbox string) (id.RoomID, bool)

GetMapping returns mapping of mailbox = room

func (*Bot) GetRelayConfig

func (b *Bot) GetRelayConfig(ctx context.Context, roomID id.RoomID) *url.URL

GetRelayConfig returns relay config for specific room (mailbox) if set

func (*Bot) IncomingEmail

func (b *Bot) IncomingEmail(ctx context.Context, eml *email.Email) error

IncomingEmail sends incoming email to matrix room

func (*Bot) IsBanned

func (b *Bot) IsBanned(ctx context.Context, addr net.Addr) bool

IsBanned checks if address is banned

func (*Bot) IsGreylisted

func (b *Bot) IsGreylisted(ctx context.Context, addr net.Addr) bool

IsGreylisted checks if host is in greylist

func (*Bot) IsTrusted

func (b *Bot) IsTrusted(addr net.Addr) bool

IsTrusted checks if address is a trusted (proxy)

func (*Bot) SendEmailReply

func (b *Bot) SendEmailReply(ctx context.Context)

SendEmailReply sends replies from matrix thread to email thread

func (*Bot) Sendmail

func (b *Bot) Sendmail(ctx context.Context, eventID id.EventID, from, to, data string, relayOverride *url.URL) (bool, error)

Sendmail tries to send email immediately, but if it gets 4xx error (greylisting), the email will be added to the queue and retried several times after that

func (*Bot) SetSendmail

func (b *Bot) SetSendmail(sendmail func(string, string, string, *url.URL) error)

SetSendmail sets mail sending func to the bot

func (*Bot) Start

func (b *Bot) Start(statusMsg string) error

Start performs matrix /sync

func (*Bot) Stop

func (b *Bot) Stop()

Stop the bot

func (*Bot) SyncRooms

func (b *Bot) SyncRooms()

SyncRooms and mailboxes

type MBXConfig

type MBXConfig struct {
	Reserved   []string
	Forwarded  []string
	Activation string
}

Mailboxes config