Skip to content

Commit f7ad339

Browse files
committed
Clarified Javadoc for replying to emails
1 parent 51ae5d9 commit f7ad339

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/main/java/org/simplejavamail/email/EmailBuilder.java

+5-4
Original file line numberDiff line numberDiff line change
@@ -266,11 +266,12 @@ public EmailPopulatingBuilder replyingToAll(@Nonnull final MimeMessage email) {
266266
}
267267

268268
/**
269-
* Primes the email with all subject, headers, originally embedded images and recipients needed for a valid RFC reply.
269+
* Primes the email with all subject, quoted content, headers, originally embedded images and recipients needed for a valid RFC reply.
270270
* <p>
271-
* <strong>Note:</strong> replaces subject with "Re: &lt;original subject&gt;" (but never nested).<br>
272-
* <strong>Note:</strong> Make sure you set the content before using this API or else the quoted content is lost. Replaces body (text is
273-
* replaced with "> text" and HTML is replaced with the provided or default quoting markup.
271+
* <strong>Note 1:</strong> replaces subject with "Re: &lt;original subject&gt;" (but never nested).<br>
272+
* <strong>Note 2:</strong> always sets both plain text and HTML text, so if you update the content body, be sure to update HTML as well.<br>
273+
* <strong>Note 3:</strong> sets bod content: text is replaced with "> text" and HTML is replaced with the provided (or default) quoting markup
274+
* (add your own content with {@code .prependText()} and {@code .prependTextHTML()}).
274275
*
275276
* @param emailMessage The message from which we harvest recipients, original content to quote (including embedded images), message ID to
276277
* include.

0 commit comments

Comments
 (0)