Allow password providers to bind emails

changelog.d/4947.feature

@@ -0,0 +1 @@
+Add ability for password provider modules to bind email addresses to users upon registration.

synapse/handlers/register.py

@@ -153,6 +153,7 @@ def register(
         user_type=None,
         default_display_name=None,
         address=None,
+        bind_emails=[],
     ):
         """Registers a new client on the server.
 
@@ -172,6 +173,7 @@ def register(
             default_display_name (unicode|None): if set, the new user's displayname
               will be set to this. Defaults to 'localpart'.
             address (str|None): the IP address used to perform the registration.
+            bind_emails (List[str]): list of emails to bind to this account.
         Returns:
             A tuple of (user_id, access_token).
         Raises:
@@ -261,6 +263,10 @@ def register(
         if not self.hs.config.user_consent_at_registration:
             yield self._auto_join_rooms(user_id)
 
+        # Bind any specified emails to this account
+        for email in bind_emails:
+            yield self.bind_email_to_account(user_id, email)
+
         defer.returnValue((user_id, token))
 
     @defer.inlineCallbacks
@@ -406,6 +412,32 @@ def register_email(self, threepidCreds):
                     403, "Third party identifier is not allowed"
                 )
 
+    @defer.inlineCallbacks
+    def bind_email_to_account(self, user_id, email, validated_at=None):
+        """Binds an email address with the registered identity service.
+
+        Args:
+            user_id (str): The user id of the user to bind the email to.
+            email (str): The email to bind.
+            validated_at (int|None): Time to mark emails validated at. If
+                `None`, the current time is used.
+
+        Returns:
+            Deferred
+        """
+
+        # generate threepid dict
+        threepid_dict = {
+            "medium": "email",
+            "address": email,
+            "validated_at": self.hs.get_clock().time_msec(),
+        }
+
+        # Bind email to new account
+        yield self._register_email_threepid(
+            user_id, threepid_dict, None, False,
+        )
+
     @defer.inlineCallbacks
     def bind_emails(self, user_id, threepidCreds):
         """Links emails with a user ID and informs an identity server.

synapse/module_api/__init__.py

@@ -74,14 +74,14 @@ def check_user_exists(self, user_id):
         return self._auth_handler.check_user_exists(user_id)
 
     @defer.inlineCallbacks
-    def register(self, localpart, displayname=None):
+    def register(self, localpart, displayname=None, emails=[]):
         """Registers a new user with given localpart and optional
-           displayname.
+           displayname, emails.
 
         Args:
             localpart (str): The localpart of the new user.
-            displayname (str|None): The displayname of the new user. If None,
-                the user's displayname will default to `localpart`.
+            displayname (str|None): The displayname of the new user.
+            emails (List[str]): Emails to bind to the new user.
 
         Returns:
             Deferred: a 2-tuple of (user_id, access_token)
@@ -90,6 +90,7 @@ def register(self, localpart, displayname=None):
         reg = self.hs.get_registration_handler()
         user_id, access_token = yield reg.register(
             localpart=localpart, default_display_name=displayname,
+            bind_emails=emails,
         )
 
         defer.returnValue((user_id, access_token))