Document OutgoingEmailValidator

Change-Id: I863879f697fa6396c993f2c995d077ed513de867
Signed-off-by: Edwin Kempin <ekempin@google.com>
This commit is contained in:
Edwin Kempin
2019-12-13 13:31:15 +01:00
parent 061bf2bc19
commit f14a711a24

View File

@@ -24,6 +24,13 @@ import org.apache.commons.validator.routines.DomainValidator;
import org.apache.commons.validator.routines.EmailValidator; import org.apache.commons.validator.routines.EmailValidator;
import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.Config;
/**
* Validator that checks if an email address is valid and allowed for receiving notification emails.
*
* <p>An email address is valid if it is syntactically correct.
*
* <p>An email address is allowed if its top level domain is allowed by Gerrit's configuration.
*/
@Singleton @Singleton
public class OutgoingEmailValidator { public class OutgoingEmailValidator {
private static final FluentLogger logger = FluentLogger.forEnclosingClass(); private static final FluentLogger logger = FluentLogger.forEnclosingClass();