Skip to content

Fix: Clarify signature property controls sender display name for all affected versions (Product IS issue #26144) #5656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix: Clarify signature property controls sender display name for all affected versions (Product IS issue #26144) #5656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en/identity-server/5.10.0/docs/setup/configuring-email-sending.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
notifications](../../learn/enabling-notifications-for-user-operations),
[account recovery](../../learn/password-recovery).

1. Shut down the server if it is running.

Check failure on line 9 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers 

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md:9:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md
2. Add the following properties to the `deployment.toml` file in the `IS_HOME/repository/conf` folder to configure the email server.

Check failure on line 10 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers 

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md:10:1 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md030.md

```toml
[output_adapter.email]
Expand All @@ -20,20 +20,20 @@
enable_authentication= true
signature = "ABC.com"
```

Check failure on line 23 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces 

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md:23:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md
| | |
|---------------------------------------------------|------------------------------------------------|
| ` from_address ` | The mail address from where you want to send the notification. It can be any working mail address. |

Check failure on line 26 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md:26:35 MD038/no-space-in-code Spaces inside code span elements [Context: "... from_address                `"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md

Check failure on line 26 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md:26:8 MD038/no-space-in-code Spaces inside code span elements [Context: "`               from_address  ..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
| ` username ` | Provide the username of the SMTP account. <br/> User name of the the mail you have provide in **from_address** |

Check failure on line 27 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md:27:31 MD038/no-space-in-code Spaces inside code span elements [Context: "... username                    `"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md

Check failure on line 27 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md:27:8 MD038/no-space-in-code Spaces inside code span elements [Context: "`               username      ..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
| ` password ` | Provide the password of the SMTP account. <br/> Password of the mail you have provided in **from_address** |

Check failure on line 28 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md:28:31 MD038/no-space-in-code Spaces inside code span elements [Context: "...sword                        `"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md

Check failure on line 28 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md:28:8 MD038/no-space-in-code Spaces inside code span elements [Context: "`               password      ..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
| ` host ` | The SMTP server to connect to. |

Check failure on line 29 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / lint

Spaces inside code span elements 

en/identity-server/5.10.0/docs/setup/configuring-email-sending.md:29:8 MD038/no-space-in-code Spaces inside code span elements [Context: "`               host          ..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md038.md
| ` port `|The SMTP server port to connect to, if the connect() method does not explicitly specify one. Defaults to 25. |

Check failure on line 30 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.", "location": {"path": "en/identity-server/5.10.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 30, "column": 114}}}, "severity": "ERROR"}

Check warning on line 30 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'SMTP' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'SMTP' has no definition.", "location": {"path": "en/identity-server/5.10.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 30, "column": 58}}}, "severity": "INFO"}
| ` 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.
| `enable_authentication` | If true, attempt to authenticate the user using the AUTH command. Defaults to true.|

Check warning on line 32 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'AUTH' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'AUTH' has no definition.", "location": {"path": "en/identity-server/5.10.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 32, "column": 105}}}, "severity": "INFO"}
| `signature` | Signature of the sender account |
| `signature` | Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <[email protected]>`). <br/><br/>**Note:** If this property is left unset, the display name will be `null`. Some SMTP servers may default to using the authentication `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 = ""` |

Check warning on line 33 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'SMTP' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'SMTP' has no definition.", "location": {"path": "en/identity-server/5.10.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 33, "column": 276}}}, "severity": "INFO"}

Check warning on line 33 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'be'.

Raw Output:
{"message": "[write-good.E-Prime] Try to avoid using 'be'.", "location": {"path": "en/identity-server/5.10.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 33, "column": 260}}}, "severity": "INFO"}

Check warning on line 33 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Passive] 'is left' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'is left' looks like passive voice.", "location": {"path": "en/identity-server/5.10.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 33, "column": 223}}}, "severity": "INFO"}

Check warning on line 33 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'is'.

Raw Output:
{"message": "[write-good.E-Prime] Try to avoid using 'is'.", "location": {"path": "en/identity-server/5.10.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 33, "column": 223}}}, "severity": "INFO"}

Check warning on line 33 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[write-good.Passive] 'is left' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'is left' may be passive voice. Use active voice if you can.", "location": {"path": "en/identity-server/5.10.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 33, "column": 223}}}, "severity": "WARNING"}

Check warning on line 33 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'ABC' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'ABC' has no definition.", "location": {"path": "en/identity-server/5.10.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 33, "column": 125}}}, "severity": "INFO"}

!!! Tip
For information about the SMTP, see

Check warning on line 36 in en/identity-server/5.10.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'SMTP' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'SMTP' has no definition.", "location": {"path": "en/identity-server/5.10.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 36, "column": 35}}}, "severity": "INFO"}
[here](https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html).

3. Re-start the server once configurations are in place.
Expand Down
2 changes: 1 addition & 1 deletion en/identity-server/5.11.0/docs/setup/configuring-email-sending.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@
| ` username ` | Provide the username of the SMTP account. <br/> User name of the the mail you have provide in **from_address** |
| ` password ` | Provide the password of the SMTP account. <br/> Password of the mail you have provided in **from_address** |
| ` host ` | The SMTP server to connect to. |
| ` port `|The SMTP server port to connect to, if the connect() method does not explicitly specify one. Defaults to 25. |

Check failure on line 27 in en/identity-server/5.11.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.", "location": {"path": "en/identity-server/5.11.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 27, "column": 114}}}, "severity": "ERROR"}

Check warning on line 27 in en/identity-server/5.11.0/docs/setup/configuring-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Acronyms] 'SMTP' has no definition.

Raw Output:
{"message": "[Microsoft.Acronyms] 'SMTP' has no definition.", "location": {"path": "en/identity-server/5.11.0/docs/setup/configuring-email-sending.md", "range": {"start": {"line": 27, "column": 58}}}, "severity": "INFO"}
| ` 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.
| `enable_authentication` | If true, attempt to authenticate the user using the AUTH command. Defaults to true.|
| `signature` | Signature of the sender account |
| `signature` | Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <[email protected]>`). <br/><br/>**Note:** If this property is left unset, the display name will be `null`. Some SMTP servers may default to using the authentication `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 = ""` |

!!! Tip
For information about the SMTP, see
Expand Down
4 changes: 2 additions & 2 deletions en/identity-server/6.0.0/docs/deploy/configure-email-sending.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@
| `username` | Provide the username of the SMTP account. <br/> Username of the mail you have provided in **from_address**. |
| `password` | Provide the password of the SMTP account. <br/> Password of the mail you have provided in **from_address**. |
| `host` | The SMTP server to connect to. |
| `port`|This is the SMTP server port to connect to if the connect() method does not explicitly specify one. Defaults to 25. |

Check failure on line 30 in en/identity-server/6.0.0/docs/deploy/configure-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.", "location": {"path": "en/identity-server/6.0.0/docs/deploy/configure-email-sending.md", "range": {"start": {"line": 30, "column": 81}}}, "severity": "ERROR"}
| `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`. |
| `enable_authentication` | If true, attempt to authenticate the user using the AUTH command. Defaults to `true`.|
| `signature` | Signature of the sender account. |
| `signature` | Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <[email protected]>`). <br/><br/>**Note:** If this property is left unset, the display name will be `null`. Some SMTP servers may default to using the authentication `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 = ""` |

!!! Tip
For information about the SMTP, see
Expand Down Expand Up @@ -128,7 +128,7 @@
</tr>
<tr class="odd">
<td><code> mail.smtp.signature </code></td>
<td>Signature for the sender account</td>
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in <code>"ABC Company" &lt;[email protected]&gt;</code>). If this property is left unset, the display name will be <code>null</code>. Some SMTP servers may default to using the authentication <code>username</code> as the display name. To send an email with no display name and show only the email address, set this value to an empty string.</td>
</tr>
</tbody>
</table>
Expand Down
4 changes: 2 additions & 2 deletions en/identity-server/6.1.0/docs/deploy/configure-email-sending.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@
| `username` | Provide the username of the SMTP account. <br/> Username of the mail you have provided in **from_address**. |
| `password` | Provide the password of the SMTP account. <br/> Password of the mail you have provided in **from_address**. |
| `host` | The SMTP server to connect to. |
| `port`|This is the SMTP server port to connect to if the connect() method does not explicitly specify one. Defaults to 25. |

Check failure on line 30 in en/identity-server/6.1.0/docs/deploy/configure-email-sending.md

View workflow job for this annotation

GitHub Actions / Vale style check 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'doesn't' instead of 'does not'.", "location": {"path": "en/identity-server/6.1.0/docs/deploy/configure-email-sending.md", "range": {"start": {"line": 30, "column": 81}}}, "severity": "ERROR"}
| `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`. |
| `enable_authentication` | If true, attempt to authenticate the user using the AUTH command. Defaults to `true`.|
| `signature` | Signature of the sender account. |
| `signature` | Specifies the display name for the "From" email address (for example, "ABC Company" results in `"ABC Company" <[email protected]>`). <br/><br/>**Note:** If this property is left unset, the display name will be `null`. Some SMTP servers may default to using the authentication `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 = ""` |

!!! Tip
For information about the SMTP, see
Expand Down Expand Up @@ -128,7 +128,7 @@
</tr>
<tr class="odd">
<td><code> mail.smtp.signature </code></td>
<td>Signature for the sender account</td>
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in <code>"ABC Company" &lt;[email protected]&gt;</code>). If this property is left unset, the display name will be <code>null</code>. Some SMTP servers may default to using the authentication <code>username</code> as the display name. To send an email with no display name and show only the email address, set this value to an empty string.</td>
</tr>
</tbody>
</table>
Expand Down
7 changes: 5 additions & 2 deletions en/identity-server/7.0.0/docs/deploy/configure/email-sending-module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,10 @@ Follow the steps given below to enable the email sender globally for all tenants
</tr>
<tr>
<td><code>signature</code></td>
<td>Signature of the sender account.</td>
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in <code>"ABC Company" &lt;[email protected]&gt;</code>).<br/><br/>
<strong>Note:</strong> If this property is left unset, the display name will be <code>null</code>. Some SMTP servers may default to using the authentication <code>username</code> 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: <code>signature = ""</code>
</td>
</tr>
</table>

Expand Down Expand Up @@ -158,7 +161,7 @@ Follow the steps given below to enable the email sender per tenant.
</tr>
<tr class="odd">
<td><code> mail.smtp.signature </code></td>
<td>Signature for the sender account</td>
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in <code>"ABC Company" &lt;[email protected]&gt;</code>). If this property is left unset, the display name will be <code>null</code>. Some SMTP servers may default to using the authentication <code>username</code> as the display name. To send an email with no display name and show only the email address, set this value to an empty string.</td>
</tr>
</tbody>
</table>
Expand Down
7 changes: 5 additions & 2 deletions en/identity-server/7.1.0/docs/deploy/configure/email-sending-module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,10 @@ Follow the steps given below to enable the email sender globally for all tenants
</tr>
<tr>
<td><code>signature</code></td>
<td>Signature of the sender account.</td>
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in <code>"ABC Company" &lt;[email protected]&gt;</code>).<br/><br/>
<strong>Note:</strong> If this property is left unset, the display name will be <code>null</code>. Some SMTP servers may default to using the authentication <code>username</code> 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: <code>signature = ""</code>
</td>
</tr>
</table>

Expand Down Expand Up @@ -158,7 +161,7 @@ Follow the steps given below to enable the email sender per tenant.
</tr>
<tr class="odd">
<td><code> mail.smtp.signature </code></td>
<td>Signature for the sender account</td>
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in <code>"ABC Company" &lt;[email protected]&gt;</code>). If this property is left unset, the display name will be <code>null</code>. Some SMTP servers may default to using the authentication <code>username</code> as the display name. To send an email with no display name and show only the email address, set this value to an empty string.</td>
</tr>
</tbody>
</table>
Expand Down
5 changes: 4 additions & 1 deletion en/identity-server/7.2.0/docs/deploy/configure/email-sending-module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@ Follow the steps given below to enable the email sender globally for all tenants
</tr>
<tr>
<td><code>signature</code></td>
<td>Signature of the sender account.</td>
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in <code>"ABC Company" &lt;[email protected]&gt;</code>).<br/><br/>
<strong>Note:</strong> If this property is left unset, the display name will be <code>null</code>. Some SMTP servers may default to using the authentication <code>username</code> 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: <code>signature = ""</code>
</td>
</tr>
</table>

Expand Down
5 changes: 4 additions & 1 deletion en/identity-server/next/docs/deploy/configure/email-sending-module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@ Follow the steps given below to enable the email sender globally for all tenants
</tr>
<tr>
<td><code>signature</code></td>
<td>Signature of the sender account.</td>
<td>Specifies the display name for the "From" email address (for example, "ABC Company" results in <code>"ABC Company" &lt;[email protected]&gt;</code>).<br/><br/>
<strong>Note:</strong> If this property is left unset, the display name will be <code>null</code>. Some SMTP servers may default to using the authentication <code>username</code> 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: <code>signature = ""</code>
</td>
</tr>
</table>

Expand Down
Loading