-
-
Notifications
You must be signed in to change notification settings - Fork 349
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add smtp configuration * add email confirm + reset templates * add email sender to testrig * flesh out the email sender interface * go fmt * golint * update from field with more clarity * tidy up the email formatting * fix tests * add email sender to processor * tidy client api processing a bit * further tidying in fromClientAPI * pin new account to user * send msg to processor on new account creation * generate confirm email uri * remove emailer from account processor again * add processCreateAccountFromClientAPI * move emailer accountprocessor => userprocessor * add email sender to user processor * SendConfirmEmail function * add noop email sender * use noop email sender in tests * only assemble message if callback is not nil * use noop email sender if no smtp host is defined * minify email html before sending * fix wrong email address * email confirm test * fmt * serve web hndler * add email confirm handler * init test log properly on testrig * log emails that *would* have been sent * go fmt ./... * unexport confirm email handler * updatedAt * test confirm email function * don't allow tokens older than 7 days * change error message a bit * add basic smtp docs * add a few more snippets * typo * add email sender to outbox tests * don't use dutch wikipedia link * don't minify email html
- Loading branch information
1 parent
de1f90e
commit 2aaec82
Showing
56 changed files
with
1,543 additions
and
398 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| /* | ||
| GoToSocial | ||
| Copyright (C) 2021 GoToSocial Authors [email protected] | ||
| This program is free software: you can redistribute it and/or modify | ||
| it under the terms of the GNU Affero General Public License as published by | ||
| the Free Software Foundation, either version 3 of the License, or | ||
| (at your option) any later version. | ||
| This program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU Affero General Public License for more details. | ||
| You should have received a copy of the GNU Affero General Public License | ||
| along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "github.com/superseriousbusiness/gotosocial/internal/config" | ||
| "github.com/urfave/cli/v2" | ||
| ) | ||
|
|
||
| func smtpFlags(flagNames, envNames config.Flags, defaults config.Defaults) []cli.Flag { | ||
| return []cli.Flag{ | ||
| &cli.StringFlag{ | ||
| Name: flagNames.SMTPHost, | ||
| Usage: "Host of the smtp server. Eg., 'smtp.eu.mailgun.org'", | ||
| Value: defaults.SMTPHost, | ||
| EnvVars: []string{envNames.SMTPHost}, | ||
| }, | ||
| &cli.IntFlag{ | ||
| Name: flagNames.SMTPPort, | ||
| Usage: "Port of the smtp server. Eg., 587", | ||
| Value: defaults.SMTPPort, | ||
| EnvVars: []string{envNames.SMTPPort}, | ||
| }, | ||
| &cli.StringFlag{ | ||
| Name: flagNames.SMTPUsername, | ||
| Usage: "Username to authenticate with the smtp server as. Eg., '[email protected]'", | ||
| Value: defaults.SMTPUsername, | ||
| EnvVars: []string{envNames.SMTPUsername}, | ||
| }, | ||
| &cli.StringFlag{ | ||
| Name: flagNames.SMTPPassword, | ||
| Usage: "Password to pass to the smtp server.", | ||
| Value: defaults.SMTPPassword, | ||
| EnvVars: []string{envNames.SMTPPassword}, | ||
| }, | ||
| &cli.StringFlag{ | ||
| Name: flagNames.SMTPFrom, | ||
| Usage: "Address to use as the 'from' field of the email. Eg., '[email protected]'", | ||
| Value: defaults.SMTPFrom, | ||
| EnvVars: []string{envNames.SMTPFrom}, | ||
| }, | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # Email Config (smtp) | ||
|
|
||
| GoToSocial supports sending emails to users via the [Simple Mail Transfer Protocol](https://wikipedia.org/wiki/Simple_Mail_Transfer_Protocol) or **smtp**. | ||
|
|
||
| Configuring GoToSocial to send emails is **not required** in order to have a properly running instance. Still, it's very useful for doing things like sending confirmation emails and notifications, and handling password reset requests. | ||
|
|
||
| In order to make GoToSocial email sending work, you need an smtp-compatible mail service running somewhere, either as a server on the same machine that GoToSocial is running on, or via an external service like [Mailgun](https://mailgun.com). It may also be possible to use a free personal email address for sending emails, if your email provider supports smtp (check with them--most do), but you might run into trouble sending lots of emails. | ||
|
|
||
| ## Settings | ||
|
|
||
| The configuration options for smtp are as follows: | ||
|
|
||
| ```yaml | ||
| ####################### | ||
| ##### SMTP CONFIG ##### | ||
| ####################### | ||
|
|
||
| # Config for sending emails via an smtp server. See https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol | ||
| smtp: | ||
|
|
||
| # String. The hostname of the smtp server you want to use. | ||
| # If this is not set, smtp will not be used to send emails, and you can ignore the other settings. | ||
| # Examples: ["mail.example.org", "localhost"] | ||
| # Default: "" | ||
| host: "" | ||
| # Int. Port to use to connect to the smtp server. | ||
| # Examples: [] | ||
| # Default: 0 | ||
| port: 0 | ||
| # String. Username to use when authenticating with the smtp server. | ||
| # This should have been provided to you by your smtp host. | ||
| # This is often, but not always, an email address. | ||
| # Examples: ["[email protected]"] | ||
| # Default: "" | ||
| username: | ||
| # String. Password to use when authenticating with the smtp server. | ||
| # This should have been provided to you by your smtp host. | ||
| # Examples: ["1234", "password"] | ||
| # Default: "" | ||
| password: | ||
| # String. 'From' address for sent emails. | ||
| # Examples: ["[email protected]"] | ||
| # Default: "" | ||
| from: "" | ||
| ``` | ||
| Note that if you don't set `Host`, then email sending via smtp will be disabled, and the other settings will be ignored. GoToSocial will still log (at trace level) emails that *would* have been sent if smtp was enabled. | ||
|
|
||
| ## Behavior | ||
|
|
||
| ### SSL | ||
|
|
||
| GoToSocial requires your smtp server to present valid SSL certificates. Most of the big services like Mailgun do this anyway, but if you're running your own mail server without SSL for some reason, and you're trying to connect GoToSocial to it, it will not work. | ||
|
|
||
| The exception to this requirement is if you're running your mail server (or bridge to a mail server) on `localhost`, in which case SSL certs are not required. | ||
|
|
||
| ### When are emails sent? | ||
|
|
||
| Currently, emails are only sent to users to request email confirmation when a new account is created, or to serve password reset requests. More email functionality will probably be added later. | ||
|
|
||
| ### HTML versus Plaintext | ||
|
|
||
| Emails are sent in HTML by default. At this point, there is no option to send emails in plaintext, but this is something that might be added later if there's enough demand for it. | ||
|
|
||
| ## Customization | ||
|
|
||
| If you like, you can customize the templates that are used for generating emails. Follow the examples in `web/templates`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -360,3 +360,35 @@ oidc: | |
| - "email" | ||
| - "profile" | ||
| - "groups" | ||
|
|
||
| ####################### | ||
| ##### SMTP CONFIG ##### | ||
| ####################### | ||
|
|
||
| # Config for sending emails via an smtp server. See https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol | ||
| smtp: | ||
|
|
||
| # String. The hostname of the smtp server you want to use. | ||
| # If this is not set, smtp will not be used to send emails, and you can ignore the other settings. | ||
| # Examples: ["mail.example.org", "localhost"] | ||
| # Default: "" | ||
| host: "" | ||
| # Int. Port to use to connect to the smtp server. | ||
| # Examples: [] | ||
| # Default: 0 | ||
| port: 0 | ||
| # String. Username to use when authenticating with the smtp server. | ||
| # This should have been provided to you by your smtp host. | ||
| # This is often, but not always, an email address. | ||
| # Examples: ["[email protected]"] | ||
| # Default: "" | ||
| username: | ||
| # String. Password to use when authenticating with the smtp server. | ||
| # This should have been provided to you by your smtp host. | ||
| # Examples: ["1234", "password"] | ||
| # Default: "" | ||
| password: | ||
| # String. 'From' address for sent emails. | ||
| # Examples: ["[email protected]"] | ||
| # Default: "" | ||
| from: "" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.