2019-02-10 02:37:37 +01:00
// Copyright 2019 The Gitea Authors. All rights reserved.
2022-11-27 19:20:29 +01:00
// SPDX-License-Identifier: MIT
2019-02-10 02:37:37 +01:00
package setting
import (
2023-05-16 22:55:51 +02:00
"context"
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
"net"
2019-02-10 02:37:37 +01:00
"net/mail"
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
"strings"
2020-05-03 01:04:31 +02:00
"time"
2019-02-10 02:37:37 +01:00
"code.gitea.io/gitea/modules/log"
2019-08-23 18:40:30 +02:00
2019-02-10 02:37:37 +01:00
shellquote "github.com/kballard/go-shellquote"
)
// Mailer represents mail service.
type Mailer struct {
// Mailer
2022-11-27 11:08:40 +01:00
Name string ` ini:"NAME" `
From string ` ini:"FROM" `
EnvelopeFrom string ` ini:"ENVELOPE_FROM" `
OverrideEnvelopeFrom bool ` ini:"-" `
FromName string ` ini:"-" `
FromEmail string ` ini:"-" `
SendAsPlainText bool ` ini:"SEND_AS_PLAIN_TEXT" `
SubjectPrefix string ` ini:"SUBJECT_PREFIX" `
2019-02-10 02:37:37 +01:00
// SMTP sender
2022-11-27 11:08:40 +01:00
Protocol string ` ini:"PROTOCOL" `
SMTPAddr string ` ini:"SMTP_ADDR" `
SMTPPort string ` ini:"SMTP_PORT" `
User string ` ini:"USER" `
Passwd string ` ini:"PASSWD" `
EnableHelo bool ` ini:"ENABLE_HELO" `
HeloHostname string ` ini:"HELO_HOSTNAME" `
ForceTrustServerCert bool ` ini:"FORCE_TRUST_SERVER_CERT" `
UseClientCert bool ` ini:"USE_CLIENT_CERT" `
ClientCertFile string ` ini:"CLIENT_CERT_FILE" `
ClientKeyFile string ` ini:"CLIENT_KEY_FILE" `
2019-02-10 02:37:37 +01:00
// Sendmail sender
2022-11-27 11:08:40 +01:00
SendmailPath string ` ini:"SENDMAIL_PATH" `
SendmailArgs [ ] string ` ini:"-" `
SendmailTimeout time . Duration ` ini:"SENDMAIL_TIMEOUT" `
SendmailConvertCRLF bool ` ini:"SENDMAIL_CONVERT_CRLF" `
2019-02-10 02:37:37 +01:00
}
2022-01-20 18:46:10 +01:00
// MailService the global mailer
var MailService * Mailer
2019-02-10 02:37:37 +01:00
2023-02-19 17:12:01 +01:00
func loadMailsFrom ( rootCfg ConfigProvider ) {
loadMailerFrom ( rootCfg )
loadRegisterMailFrom ( rootCfg )
loadNotifyMailFrom ( rootCfg )
loadIncomingEmailFrom ( rootCfg )
}
func loadMailerFrom ( rootCfg ConfigProvider ) {
2023-01-11 21:09:24 +01:00
sec := rootCfg . Section ( "mailer" )
2019-02-10 02:37:37 +01:00
// Check mailer setting.
if ! sec . Key ( "ENABLED" ) . MustBool ( ) {
return
}
2022-11-27 11:08:40 +01:00
// Handle Deprecations and map on to new configuration
2023-02-20 23:18:26 +01:00
// DEPRECATED should not be removed because users maybe upgrade from lower version to the latest version
// if these are removed, the warning will not be shown
deprecatedSetting ( rootCfg , "mailer" , "MAILER_TYPE" , "mailer" , "PROTOCOL" , "v1.19.0" )
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
if sec . HasKey ( "MAILER_TYPE" ) && ! sec . HasKey ( "PROTOCOL" ) {
if sec . Key ( "MAILER_TYPE" ) . String ( ) == "sendmail" {
2022-11-27 11:08:40 +01:00
sec . Key ( "PROTOCOL" ) . MustString ( "sendmail" )
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
}
2019-02-10 02:37:37 +01:00
}
2023-02-20 23:18:26 +01:00
deprecatedSetting ( rootCfg , "mailer" , "HOST" , "mailer" , "SMTP_ADDR" , "v1.19.0" )
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
if sec . HasKey ( "HOST" ) && ! sec . HasKey ( "SMTP_ADDR" ) {
givenHost := sec . Key ( "HOST" ) . String ( )
addr , port , err := net . SplitHostPort ( givenHost )
2023-01-11 21:09:24 +01:00
if err != nil && strings . Contains ( err . Error ( ) , "missing port in address" ) {
addr = givenHost
} else if err != nil {
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
log . Fatal ( "Invalid mailer.HOST (%s): %v" , givenHost , err )
2019-02-10 02:37:37 +01:00
}
2023-01-11 21:09:24 +01:00
if addr == "" {
addr = "127.0.0.1"
}
2022-11-27 11:08:40 +01:00
sec . Key ( "SMTP_ADDR" ) . MustString ( addr )
sec . Key ( "SMTP_PORT" ) . MustString ( port )
2019-02-10 02:37:37 +01:00
}
2023-02-20 23:18:26 +01:00
deprecatedSetting ( rootCfg , "mailer" , "IS_TLS_ENABLED" , "mailer" , "PROTOCOL" , "v1.19.0" )
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
if sec . HasKey ( "IS_TLS_ENABLED" ) && ! sec . HasKey ( "PROTOCOL" ) {
if sec . Key ( "IS_TLS_ENABLED" ) . MustBool ( ) {
2022-11-27 11:08:40 +01:00
sec . Key ( "PROTOCOL" ) . MustString ( "smtps" )
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
} else {
2022-11-27 11:08:40 +01:00
sec . Key ( "PROTOCOL" ) . MustString ( "smtp+starttls" )
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
}
}
2023-02-20 23:18:26 +01:00
deprecatedSetting ( rootCfg , "mailer" , "DISABLE_HELO" , "mailer" , "ENABLE_HELO" , "v1.19.0" )
2022-11-27 11:08:40 +01:00
if sec . HasKey ( "DISABLE_HELO" ) && ! sec . HasKey ( "ENABLE_HELO" ) {
sec . Key ( "ENABLE_HELO" ) . MustBool ( ! sec . Key ( "DISABLE_HELO" ) . MustBool ( ) )
}
2023-02-20 23:18:26 +01:00
deprecatedSetting ( rootCfg , "mailer" , "SKIP_VERIFY" , "mailer" , "FORCE_TRUST_SERVER_CERT" , "v1.19.0" )
2022-11-27 11:08:40 +01:00
if sec . HasKey ( "SKIP_VERIFY" ) && ! sec . HasKey ( "FORCE_TRUST_SERVER_CERT" ) {
sec . Key ( "FORCE_TRUST_SERVER_CERT" ) . MustBool ( sec . Key ( "SKIP_VERIFY" ) . MustBool ( ) )
}
2023-02-20 23:18:26 +01:00
deprecatedSetting ( rootCfg , "mailer" , "USE_CERTIFICATE" , "mailer" , "USE_CLIENT_CERT" , "v1.19.0" )
2022-11-27 11:08:40 +01:00
if sec . HasKey ( "USE_CERTIFICATE" ) && ! sec . HasKey ( "USE_CLIENT_CERT" ) {
sec . Key ( "USE_CLIENT_CERT" ) . MustBool ( sec . Key ( "USE_CERTIFICATE" ) . MustBool ( ) )
}
2023-02-20 23:18:26 +01:00
deprecatedSetting ( rootCfg , "mailer" , "CERT_FILE" , "mailer" , "CLIENT_CERT_FILE" , "v1.19.0" )
2022-11-27 11:08:40 +01:00
if sec . HasKey ( "CERT_FILE" ) && ! sec . HasKey ( "CLIENT_CERT_FILE" ) {
sec . Key ( "CERT_FILE" ) . MustString ( sec . Key ( "CERT_FILE" ) . String ( ) )
}
2023-02-20 23:18:26 +01:00
deprecatedSetting ( rootCfg , "mailer" , "KEY_FILE" , "mailer" , "CLIENT_KEY_FILE" , "v1.19.0" )
2022-11-27 11:08:40 +01:00
if sec . HasKey ( "KEY_FILE" ) && ! sec . HasKey ( "CLIENT_KEY_FILE" ) {
sec . Key ( "KEY_FILE" ) . MustString ( sec . Key ( "KEY_FILE" ) . String ( ) )
}
2023-02-20 23:18:26 +01:00
deprecatedSetting ( rootCfg , "mailer" , "ENABLE_HTML_ALTERNATIVE" , "mailer" , "SEND_AS_PLAIN_TEXT" , "v1.19.0" )
2022-11-27 11:08:40 +01:00
if sec . HasKey ( "ENABLE_HTML_ALTERNATIVE" ) && ! sec . HasKey ( "SEND_AS_PLAIN_TEXT" ) {
sec . Key ( "SEND_AS_PLAIN_TEXT" ) . MustBool ( ! sec . Key ( "ENABLE_HTML_ALTERNATIVE" ) . MustBool ( false ) )
}
if sec . HasKey ( "PROTOCOL" ) && sec . Key ( "PROTOCOL" ) . String ( ) == "smtp+startls" {
log . Error ( "Deprecated fallback `[mailer]` `PROTOCOL = smtp+startls` present. Use `[mailer]` `PROTOCOL = smtp+starttls`` instead. This fallback will be removed in v1.19.0" )
sec . Key ( "PROTOCOL" ) . SetValue ( "smtp+starttls" )
}
// Set default values & validate
sec . Key ( "NAME" ) . MustString ( AppName )
sec . Key ( "PROTOCOL" ) . In ( "" , [ ] string { "smtp" , "smtps" , "smtp+starttls" , "smtp+unix" , "sendmail" , "dummy" } )
sec . Key ( "ENABLE_HELO" ) . MustBool ( true )
sec . Key ( "FORCE_TRUST_SERVER_CERT" ) . MustBool ( false )
sec . Key ( "USE_CLIENT_CERT" ) . MustBool ( false )
sec . Key ( "SENDMAIL_PATH" ) . MustString ( "sendmail" )
sec . Key ( "SENDMAIL_TIMEOUT" ) . MustDuration ( 5 * time . Minute )
sec . Key ( "SENDMAIL_CONVERT_CRLF" ) . MustBool ( true )
sec . Key ( "FROM" ) . MustString ( sec . Key ( "USER" ) . String ( ) )
// Now map the values on to the MailService
MailService = & Mailer { }
if err := sec . MapTo ( MailService ) ; err != nil {
log . Fatal ( "Unable to map [mailer] section on to MailService. Error: %v" , err )
}
// Infer SMTPPort if not set
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
if MailService . SMTPPort == "" {
switch MailService . Protocol {
case "smtp" :
MailService . SMTPPort = "25"
case "smtps" :
MailService . SMTPPort = "465"
2022-11-27 11:08:40 +01:00
case "smtp+starttls" :
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
MailService . SMTPPort = "587"
}
}
2022-11-27 11:08:40 +01:00
// Infer Protocol
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
if MailService . Protocol == "" {
if strings . ContainsAny ( MailService . SMTPAddr , "/\\" ) {
MailService . Protocol = "smtp+unix"
} else {
switch MailService . SMTPPort {
case "25" :
MailService . Protocol = "smtp"
case "465" :
MailService . Protocol = "smtps"
case "587" :
2022-11-27 11:08:40 +01:00
MailService . Protocol = "smtp+starttls"
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
default :
log . Error ( "unable to infer unspecified mailer.PROTOCOL from mailer.SMTP_PORT = %q, assume using smtps" , MailService . SMTPPort )
MailService . Protocol = "smtps"
2023-01-11 21:09:24 +01:00
if MailService . SMTPPort == "" {
MailService . SMTPPort = "465"
}
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
}
}
}
// we want to warn if users use SMTP on a non-local IP;
// we might as well take the opportunity to check that it has an IP at all
2023-01-09 17:09:46 +01:00
// This check is not needed for sendmail
switch MailService . Protocol {
case "sendmail" :
var err error
MailService . SendmailArgs , err = shellquote . Split ( sec . Key ( "SENDMAIL_ARGS" ) . String ( ) )
if err != nil {
log . Error ( "Failed to parse Sendmail args: '%s' with error %v" , sec . Key ( "SENDMAIL_ARGS" ) . String ( ) , err )
}
case "smtp" , "smtps" , "smtp+starttls" , "smtp+unix" :
ips := tryResolveAddr ( MailService . SMTPAddr )
if MailService . Protocol == "smtp" {
for _ , ip := range ips {
2023-05-16 22:55:51 +02:00
if ! ip . IP . IsLoopback ( ) {
2023-01-09 17:09:46 +01:00
log . Warn ( "connecting over insecure SMTP protocol to non-local address is not recommended" )
break
}
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
}
}
2023-01-09 17:09:46 +01:00
case "dummy" : // just mention and do nothing
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
}
if MailService . From != "" {
parsed , err := mail . ParseAddress ( MailService . From )
if err != nil {
log . Fatal ( "Invalid mailer.FROM (%s): %v" , MailService . From , err )
}
MailService . FromName = parsed . Name
MailService . FromEmail = parsed . Address
} else {
log . Error ( "no mailer.FROM provided, email system may not work." )
2019-02-10 02:37:37 +01:00
}
2021-11-19 16:35:20 +01:00
switch MailService . EnvelopeFrom {
case "" :
MailService . OverrideEnvelopeFrom = false
case "<>" :
MailService . EnvelopeFrom = ""
MailService . OverrideEnvelopeFrom = true
default :
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
parsed , err := mail . ParseAddress ( MailService . EnvelopeFrom )
2021-11-19 16:35:20 +01:00
if err != nil {
log . Fatal ( "Invalid mailer.ENVELOPE_FROM (%s): %v" , MailService . EnvelopeFrom , err )
}
MailService . OverrideEnvelopeFrom = true
MailService . EnvelopeFrom = parsed . Address
}
2019-02-10 02:37:37 +01:00
log . Info ( "Mail Service Enabled" )
}
2023-02-19 17:12:01 +01:00
func loadRegisterMailFrom ( rootCfg ConfigProvider ) {
if ! rootCfg . Section ( "service" ) . Key ( "REGISTER_EMAIL_CONFIRM" ) . MustBool ( ) {
2019-02-10 02:37:37 +01:00
return
} else if MailService == nil {
log . Warn ( "Register Mail Service: Mail Service is not enabled" )
return
}
Service . RegisterEmailConfirm = true
log . Info ( "Register Mail Service Enabled" )
}
2023-02-19 17:12:01 +01:00
func loadNotifyMailFrom ( rootCfg ConfigProvider ) {
if ! rootCfg . Section ( "service" ) . Key ( "ENABLE_NOTIFY_MAIL" ) . MustBool ( ) {
2019-02-10 02:37:37 +01:00
return
} else if MailService == nil {
log . Warn ( "Notify Mail Service: Mail Service is not enabled" )
return
}
Service . EnableNotifyMail = true
log . Info ( "Notify Mail Service Enabled" )
}
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
2023-05-16 22:55:51 +02:00
func tryResolveAddr ( addr string ) [ ] net . IPAddr {
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
if strings . HasPrefix ( addr , "[" ) & & strings . HasSuffix ( addr , "]" ) {
addr = addr [ 1 : len ( addr ) - 1 ]
}
ip := net . ParseIP ( addr )
if ip != nil {
2023-05-16 22:55:51 +02:00
return [ ] net . IPAddr { { IP : ip } }
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
}
2023-05-16 22:55:51 +02:00
ctx , cancel := context . WithTimeout ( context . Background ( ) , 2 * time . Second )
defer cancel ( )
ips , err := net . DefaultResolver . LookupIPAddr ( ctx , addr )
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
if err != nil {
log . Warn ( "could not look up mailer.SMTP_ADDR: %v" , err )
2023-05-16 22:55:51 +02:00
return nil
Rework mailer settings (#18982)
* `PROTOCOL`: can be smtp, smtps, smtp+startls, smtp+unix, sendmail, dummy
* `SMTP_ADDR`: domain for SMTP, or path to unix socket
* `SMTP_PORT`: port for SMTP; defaults to 25 for `smtp`, 465 for `smtps`, and 587 for `smtp+startls`
* `ENABLE_HELO`, `HELO_HOSTNAME`: reverse `DISABLE_HELO` to `ENABLE_HELO`; default to false + system hostname
* `FORCE_TRUST_SERVER_CERT`: replace the unclear `SKIP_VERIFY`
* `CLIENT_CERT_FILE`, `CLIENT_KEY_FILE`, `USE_CLIENT_CERT`: clarify client certificates here
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2022-08-02 07:24:18 +02:00
}
return ips
}