Skip to content

Commit aea5fea

Browse files
committed
Update email sender signature property description.
1 parent daad7a6 commit aea5fea

File tree

7 files changed

+7
-7
lines changed

7 files changed

+7
-7
lines changed

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ notifications](../../learn/enabling-notifications-for-user-operations),
3030
| ` port `|The SMTP server port to connect to, if the connect() method does not explicitly specify one. Defaults to 25. |
3131
| ` enable_start_tls` | If true, enables the use of the STARTTLS` command (if supported by the before issuing any login commands. Note that an appropriate trust store must configured so that the client will trust the server's certificate. Defaults to true.
3232
| `enable_authentication` | If true, attempt to authenticate the user using the AUTH command. Defaults to true.|
33-
| `signature` | Signature of the sender account |
33+
| `signature` | Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <mail@address.tld>`). <br/><br/>If not set, the display name will be `null`. Some SMTP servers may default to using the `username` as the display name.<br/><br/>To send an email with no display name and show only the email address, set this value to an empty string: `signature = ""`. |
3434

3535
!!! Tip
3636
For information about the SMTP, see

en/identity-server/5.11.0/docs/setup/configuring-email-sending.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This document explains the steps to configure WSO2 Identity Server to send email
2727
| ` port `|The SMTP server port to connect to, if the connect() method does not explicitly specify one. Defaults to 25. |
2828
| ` enable_start_tls` | If true, enables the use of the STARTTLS` command (if supported by the before issuing any login commands. Note that an appropriate trust store must configured so that the client will trust the server's certificate. Defaults to true.
2929
| `enable_authentication` | If true, attempt to authenticate the user using the AUTH command. Defaults to true.|
30-
| `signature` | Signature of the sender account |
30+
| `signature` | Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <mail@address.tld>`). <br/><br/>If not set, the display name will be `null`. Some SMTP servers may default to using the `username` as the display name.<br/><br/>To send an email with no display name and show only the email address, set this value to an empty string: `signature = ""`. |
3131

3232
!!! Tip
3333
For information about the SMTP, see

en/identity-server/6.0.0/docs/deploy/configure-email-sending.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Follow the steps given below to enable the email sender globally for all tenants
3030
| `port`|This is the SMTP server port to connect to if the connect() method does not explicitly specify one. Defaults to 25. |
3131
| `enable_start_tls` | If true, this enables using the `STARTTLS` command (if enabled before issuing any login commands. Note that an appropriate trust store must be configured so that the client will trust the server's certificate. Defaults to `true`. |
3232
| `enable_authentication` | If true, attempt to authenticate the user using the AUTH command. Defaults to `true`.|
33-
| `signature` | Signature of the sender account. |
33+
| `signature` | Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <mail@address.tld>`). <br/><br/>If not set, the display name will be `null`. Some SMTP servers may default to using the `username` as the display name.<br/><br/>To send an email with no display name and show only the email address, set this value to an empty string: `signature = ""`. |
3434

3535
!!! Tip
3636
For information about the SMTP, see

en/identity-server/6.1.0/docs/deploy/configure-email-sending.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Follow the steps given below to enable the email sender globally for all tenants
3030
| `port`|This is the SMTP server port to connect to if the connect() method does not explicitly specify one. Defaults to 25. |
3131
| `enable_start_tls` | If true, this enables using the `STARTTLS` command (if enabled before issuing any login commands. Note that an appropriate trust store must be configured so that the client will trust the server's certificate. Defaults to `true`. |
3232
| `enable_authentication` | If true, attempt to authenticate the user using the AUTH command. Defaults to `true`.|
33-
| `signature` | Signature of the sender account. |
33+
| `signature` | Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <mail@address.tld>`). <br/><br/>If not set, the display name will be `null`. Some SMTP servers may default to using the `username` as the display name.<br/><br/>To send an email with no display name and show only the email address, set this value to an empty string: `signature = ""`. |
3434

3535
!!! Tip
3636
For information about the SMTP, see

en/identity-server/7.0.0/docs/deploy/configure/email-sending-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Follow the steps given below to enable the email sender globally for all tenants
5555
</tr>
5656
<tr>
5757
<td><code>signature</code></td>
58-
<td>Signature of the sender account.</td>
58+
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <mail@address.tld>`). <br/><br/>If not set, the display name will be `null`. Some SMTP servers may default to using the `username` as the display name.<br/><br/>To send an email with no display name and show only the email address, set this value to an empty string: `signature = ""`</td>
5959
</tr>
6060
</table>
6161

en/identity-server/7.1.0/docs/deploy/configure/email-sending-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Follow the steps given below to enable the email sender globally for all tenants
5555
</tr>
5656
<tr>
5757
<td><code>signature</code></td>
58-
<td>Signature of the sender account.</td>
58+
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <mail@address.tld>`). <br/><br/>If not set, the display name will be `null`. Some SMTP servers may default to using the `username` as the display name.<br/><br/>To send an email with no display name and show only the email address, set this value to an empty string: `signature = ""`</td>
5959
</tr>
6060
</table>
6161

en/includes/guides/notification-channels/configure-email-provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Follow the steps given below to enable the email sender globally for all tenants
6969
</tr>
7070
<tr>
7171
<td><code>signature</code></td>
72-
<td>Signature of the sender account.</td>
72+
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <mail@address.tld>`). <br/><br/>If not set, the display name will be `null`. Some SMTP servers may default to using the `username` as the display name.<br/><br/>To send an email with no display name and show only the email address, set this value to an empty string: `signature = ""`</td>
7373
</tr>
7474
</table>
7575

0 commit comments

Comments
 (0)