autoconfig

README

go-autoconfig

Discover configuration parameters for e-mail, contact and calendar servers.

License

MIT

Documentation

Overview

Package autoconfig discovers configuration parameters for e-mail, contact and calendar servers.

The following mechanisms are implemented:

• DNS SRV records, defined in RFC 6186 section 3.1 and RFC 8314 section 5.1
• Mozilla Thunderbird auto-configuration, described in https://wiki.mozilla.org/Thunderbird:Autoconfiguration
• Guesses based on common subdomain names and DNS MX records

Index

• type Config
  • func DiscoverMail(ctx context.Context, addr string, st ServiceType) (*Config, error)
• type IMAP
• type JMAP
• type SMTP
• type ServiceType

Types

type Config

type Config struct {
	SMTP *SMTP
	IMAP *IMAP
	JMAP *JMAP
}

Config contains the result of a service discovery.

func DiscoverMail

func DiscoverMail(ctx context.Context, addr string, st ServiceType) (*Config, error)

DiscoverMail performs service discovery from an e-mail address.

type IMAP

type IMAP struct {
	Addr     string
	StartTLS bool

	Username string
}

IMAP returns configuration for an IMAP server.

type JMAP

type JMAP struct {
	SessionEndpoint string
}

JMAP returns configuration for a JMAP server.

type SMTP

type SMTP struct {
	Addr     string
	StartTLS bool

	Username string
}

SMTP returns configuration for an SMTP server.

type ServiceType

type ServiceType int

ServiceType is a set of service types to be discovered.

const (
	ServiceTypeSMTP ServiceType = 1 << iota
	ServiceTypeIMAP
	ServiceTypeJMAP
)