Categorygithub.com/kraudcloud/mailshuttle
modulepackage
0.2.1
Repository: https://github.com/kraudcloud/mailshuttle.git
Documentation: pkg.go.dev

# README

MailShuttle

A simple email proxying service, to host a local service with your master key to the proxy, and easily allow other services to access it.

Configuration

The server is configured through a yaml file located at CONFIG_PATH (by default $XDG_CONFIG_HOME/mailshuttle/config.yaml).

You can view the parsed config with DUMP_CONFIG=1

# Functions

NewConfigStore creates a new ConfigStore instance and initializes it with the given configuration path.
NewReader creates a new ReaderStringer that wraps the provided io.Reader.
No description provided by the author

# Structs

No description provided by the author
AuthStore is a struct that manages user authentication.
The Backend implements SMTP server methods.
No description provided by the author
No description provided by the author
Envelope represents an SMTP message envelope, containing the sender, recipients, and message body.
No description provided by the author
Proxy is a struct that proxies SMTP messages through a target SMTP server, applying filters to the messages.
No description provided by the author
ReaderStringer is a struct that wraps an io.Reader and provides a String() method to read the entire contents of the reader.
No description provided by the author
A Session is returned after successful login.
SMTPTarget represents a target server to proxy messages to.

# Interfaces

ConfigLoader defines an interface for loading configurations.
Proxier is a function that proxies the message from the sender to the intended recipient.

# Type aliases

Filter is a function that filters messages based on the sender and recipient.
No description provided by the author