Skip to content

Commit 3dc729d

Browse files
committed
Javadoc clarifications
1 parent 72006a4 commit 3dc729d

File tree

3 files changed

+5
-1
lines changed

3 files changed

+5
-1
lines changed

modules/core-module/src/main/java/org/simplejavamail/api/mailer/CustomMailer.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88

99
/**
1010
* By default, Simple Java Mail handles the ultimate connection and sending of emails. However, it is possible to replace this last step
11-
* by a custom implementation.
11+
* by a custom implementation. Note this is not meant to 'override' the default behavior, but to provide a custom implementation for
12+
* specific use cases (for example sending using MailChimp or SendGrid, or logging to your own database).
1213
* <p>
1314
* The benefit of this is that Simple Java Mail acts as an accelarator, providing thread pool, applying email content-validation, address validations,
1415
* configuring a {@code Session} instance, producing a {@code MimeMessage}, all with full S/MIME, DKIM support and everything else.

modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/EmailGovernanceImpl.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ public EmailGovernanceImpl(@Nullable EmailValidator emailValidator, @Nullable Em
116116
this.maximumEmailSize = maximumEmailSize;
117117
}
118118

119+
// FIXME default notificationTo is missing
119120
// The name is a bit cryptic, but succinct (and it's only used internally)
120121
private Email newDefaultsEmailWithDefaultDefaults() {
121122
final EmailPopulatingBuilder allDefaults = EmailBuilder.startingBlank();

modules/simple-java-mail/src/main/java/org/simplejavamail/mailer/internal/util/TransportRunner.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ public class TransportRunner {
3030

3131
/**
3232
* NOTE: only in case batch-module is *not* in use, the {@link Session} passed in here is garuanteed to be used to send this message.
33+
*
34+
* @param clusterKey The cluster key to use for the connection pool, which was randomly generated in the Mailer builder if not provided.
3335
*/
3436
public static void sendMessage(@NotNull final UUID clusterKey, final Session session, @NotNull Email email)
3537
throws MessagingException {

0 commit comments

Comments
 (0)