smtp package - code.gitea.io/gitea/services/auth/source/smtp

Documentation ¶

Index ¶

Constants
Variables
func Authenticate(a smtp.Auth, source *Source) error
type Source

Constants ¶

const (
	PlainAuthentication   = "PLAIN"
	LoginAuthentication   = "LOGIN"
	CRAMMD5Authentication = "CRAM-MD5"
)

SMTP authentication type names.

Variables ¶

View Source

var Authenticators = []string{PlainAuthentication, LoginAuthentication, CRAMMD5Authentication}

Authenticators contains available SMTP authentication type names.

View Source

var ErrUnsupportedLoginType = errors.New("Login source is unknown")

ErrUnsupportedLoginType login source is unknown error

Functions ¶

func Authenticate ¶

func Authenticate(a smtp.Auth, source *Source) error

Authenticate performs an SMTP authentication.

Types ¶

type Source ¶

type Source struct {
	auth.ConfigBase `json:"-"`

	Auth           string
	Host           string
	Port           int
	AllowedDomains string `xorm:"TEXT"`
	ForceSMTPS     bool
	SkipVerify     bool
	HeloHostname   string
	DisableHelo    bool
}

Source holds configuration for the SMTP login source.

func (*Source) Authenticate ¶

func (source *Source) Authenticate(ctx context.Context, user *user_model.User, userName, password string) (*user_model.User, error)

Authenticate queries if the provided login/password is authenticates against the SMTP server Users will be autoregistered as required

func (*Source) FromDB ¶

func (source *Source) FromDB(bs []byte) error

FromDB fills up an SMTPConfig from serialized format.

func (*Source) HasTLS ¶

func (source *Source) HasTLS() bool

HasTLS returns true for SMTP

func (*Source) IsSkipVerify ¶

func (source *Source) IsSkipVerify() bool

IsSkipVerify returns if SkipVerify is set

func (*Source) ToDB ¶

func (source *Source) ToDB() ([]byte, error)

ToDB exports an SMTPConfig to a serialized format.

func (*Source) UseTLS ¶

func (source *Source) UseTLS() bool

UseTLS returns if TLS is set

Source Files ¶

View all Source files

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