1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-23 04:42:06 +01:00

Add note about UserId.parse().toString() not guaranteing identity

This commit is contained in:
Paul Schaub 2023-01-04 18:27:14 +01:00
parent 51c7bc932b
commit abf723cc6c
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311

View file

@ -96,6 +96,8 @@ public final class UserId implements CharSequence {
* <li><pre>" "@example.org</pre> (spaces between the quotes)</li> * <li><pre>" "@example.org</pre> (spaces between the quotes)</li>
* <li><pre>"very.(),:;&lt;&gt;[]\".VERY.\"very@\\ \"very\".unusual"@strange.example.com</pre></li> * <li><pre>"very.(),:;&lt;&gt;[]\".VERY.\"very@\\ \"very\".unusual"@strange.example.com</pre></li>
* </ul> * </ul>
* Note: This method does not guarantee that <pre>string.equals(UserId.parse(string).toString())</pre> is true.
* For example, <pre>UserId.parse("alice@pgpainless.org").toString()</pre> wraps the mail address in angled brackets.
* *
* @see <a href="https://www.rfc-editor.org/rfc/rfc5322#page-16">RFC5322 §3.4. Address Specification</a> * @see <a href="https://www.rfc-editor.org/rfc/rfc5322#page-16">RFC5322 §3.4. Address Specification</a>
* @param string user-id * @param string user-id