deploy: e6a106fd5e

develop/print.html

@@ -4891,7 +4891,8 @@ saml2_config:
 #             localpart_template: Jinja2 template for the localpart of the MXID.
 #                 If this is not set, the user will be prompted to choose their
 #                 own username (see the documentation for the
-#                 'sso_auth_account_details.html' template).
+#                 'sso_auth_account_details.html' template). This template can
+#                 use the 'localpart_from_email' filter.
 #
 #             confirm_localpart: Whether to prompt the user to validate (or
 #                 change) the generated localpart (see the documentation for the
@@ -5932,6 +5933,10 @@ already available as part of Jinja 2:</p>
 <p>Turns a <code>mxc://</code> URL for media content into an HTTP(S) one using the homeserver's
 <code>public_baseurl</code> configuration setting as the URL's base.</p>
 <p>Example: <code>message.sender_avatar_url|mxc_to_http(32,32)</code></p>
+<pre><code class="language-python">localpart_from_email(address: str) -&gt; str
+</code></pre>
+<p>Returns the local part of an email address (e.g. <code>alice</code> in <code>alice@example.com</code>).</p>
+<p>Example: <code>user.email_address|localpart_from_email</code></p>
 <h2 id="email-templates"><a class="header" href="#email-templates">Email templates</a></h2>
 <p>Below are the templates Synapse will look for when generating the content of an email:</p>
 <ul>

develop/sample_config.yaml

@@ -1948,7 +1948,8 @@ saml2_config:
 #             localpart_template: Jinja2 template for the localpart of the MXID.
 #                 If this is not set, the user will be prompted to choose their
 #                 own username (see the documentation for the
-#                 'sso_auth_account_details.html' template).
+#                 'sso_auth_account_details.html' template). This template can
+#                 use the 'localpart_from_email' filter.
 #
 #             confirm_localpart: Whether to prompt the user to validate (or
 #                 change) the generated localpart (see the documentation for the

develop/templates.html

@@ -205,6 +205,10 @@ already available as part of Jinja 2:</p>
 <p>Turns a <code>mxc://</code> URL for media content into an HTTP(S) one using the homeserver's
 <code>public_baseurl</code> configuration setting as the URL's base.</p>
 <p>Example: <code>message.sender_avatar_url|mxc_to_http(32,32)</code></p>
+<pre><code class="language-python">localpart_from_email(address: str) -&gt; str
+</code></pre>
+<p>Returns the local part of an email address (e.g. <code>alice</code> in <code>alice@example.com</code>).</p>
+<p>Example: <code>user.email_address|localpart_from_email</code></p>
 <h2 id="email-templates"><a class="header" href="#email-templates">Email templates</a></h2>
 <p>Below are the templates Synapse will look for when generating the content of an email:</p>
 <ul>

develop/usage/configuration/homeserver_sample_config.html

@@ -2140,7 +2140,8 @@ saml2_config:
 #             localpart_template: Jinja2 template for the localpart of the MXID.
 #                 If this is not set, the user will be prompted to choose their
 #                 own username (see the documentation for the
-#                 'sso_auth_account_details.html' template).
+#                 'sso_auth_account_details.html' template). This template can
+#                 use the 'localpart_from_email' filter.
 #
 #             confirm_localpart: Whether to prompt the user to validate (or
 #                 change) the generated localpart (see the documentation for the