Skip to content

Commit dc7de22

Browse files
committed
Slightly improve usage javadoc
1 parent a807864 commit dc7de22

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

modules/core-module/src/main/java/org/simplejavamail/api/email/config/SmimeEncryptionConfig.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@
2121

2222
import static java.lang.String.format;
2323

24+
/**
25+
* @see #getKeyEncapsulationAlgorithm()
26+
* @see #getCipherAlgorithm()
27+
* @see EmailPopulatingBuilder#encryptWithSmime(SmimeEncryptionConfig)
28+
*/
2429
@ToString
2530
@Getter
2631
@EqualsAndHashCode
@@ -58,6 +63,8 @@ public class SmimeEncryptionConfig implements Serializable {
5863
* <p><strong>Note:</strong> While the default RSA is widely compatible, the move towards RSA with OAEP padding
5964
* is encouraged to ensure a higher level of security against modern cryptographic attacks. The choice of SHA-256
6065
* or higher as the hashing algorithm for OAEP provides a good balance between security and performance.</p>
66+
*
67+
* @see EmailPopulatingBuilder#encryptWithSmime(SmimeEncryptionConfig)
6168
*/
6269
@Nullable
6370
final String keyEncapsulationAlgorithm;
@@ -83,6 +90,8 @@ public class SmimeEncryptionConfig implements Serializable {
8390
*
8491
* <p><strong>Note:</strong> While DES_EDE3_CBC is supported for backward compatibility, AES (128, 192, 256)
8592
* is strongly recommended for new applications due to its enhanced security and efficiency.</p>
93+
*
94+
* @see EmailPopulatingBuilder#encryptWithSmime(SmimeEncryptionConfig)
8695
*/
8796
@Nullable
8897
final String cipherAlgorithm;

modules/core-module/src/main/java/org/simplejavamail/api/email/config/SmimeSigningConfig.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@
1818
import static java.lang.String.format;
1919
import static org.simplejavamail.internal.util.MiscUtil.readInputStreamToBytes;
2020

21+
/**
22+
* @see #getSignatureAlgorithm()
23+
* @see EmailPopulatingBuilder#signWithSmime(SmimeSigningConfig)
24+
*/
2125
@ToString
2226
@Getter
2327
@EqualsAndHashCode

0 commit comments

Comments
 (0)