org.simplejavamail.email

Class EmailBuilder.EmailBuilderInstance

java.lang.Object

org.simplejavamail.email.EmailBuilder.EmailBuilderInstance

Enclosing class:

EmailBuilder

public static final class EmailBuilder.EmailBuilderInstance
extends Object

Offers the same API as MailerBuilder, but as an instance (so we can keep track of state). This is because ignoringDefaults() is the only method that doesn't return a EmailPopulatingBuilder but returns to the inital API instead.

As with the EmailBuilder, every other method returns an EmailPopulatingBuilder.

Method Summary

Modifier and Type	Method and Description
EmailPopulatingBuilder	copying(Email email) Preconfigures the builder with all the properties from the given email that are non-null.
EmailPopulatingBuilder	copying(EmailPopulatingBuilder emailBuilder) Delegates to copying(Email), by building the email first.
EmailPopulatingBuilder	copying(javax.mail.internet.MimeMessage message) Delegates to copying(Email), by converting the email first.
EmailPopulatingBuilder	forwarding(Email email) Delegates to forwarding(MimeMessage) with the provided Email converted to MimeMessage.
EmailPopulatingBuilder	forwarding(javax.mail.internet.MimeMessage emailMessage) Primes the email to build with proper subject and inline forwarded email needed for a valid RFC forward.
EmailPopulatingBuilder	replyingTo(Email email) Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to false and a default HTML quoting template.
EmailPopulatingBuilder	replyingTo(Email email, String customQuotingTemplate) Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to false.
EmailPopulatingBuilder	replyingTo(javax.mail.internet.MimeMessage email) Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to false and a default HTML quoting template.
EmailPopulatingBuilder	replyingTo(javax.mail.internet.MimeMessage emailMessage, boolean repyToAll, String htmlTemplate) Primes the email with all subject, headers, originally embedded images and recipients needed for a valid RFC reply.
EmailPopulatingBuilder	replyingTo(javax.mail.internet.MimeMessage email, String customQuotingTemplate) Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to false.
EmailPopulatingBuilder	replyingToAll(Email email) Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to true and a default HTML quoting template.
EmailPopulatingBuilder	replyingToAll(Email email, String customQuotingTemplate) Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to true.
EmailPopulatingBuilder	replyingToAll(javax.mail.internet.MimeMessage email) Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to true and a default HTML quoting template.
EmailPopulatingBuilder	replyingToAll(javax.mail.internet.MimeMessage email, String customQuotingTemplate) Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to true.
EmailPopulatingBuilder	startingBlank() Most common use case for creating a new email.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

startingBlank

public EmailPopulatingBuilder startingBlank()

Most common use case for creating a new email. Starts with an empty email, populated with defaults when set through config properties (if not disabled using ignoringDefaults().

Note: Any builder method called after this will override the default value.

Returns:

A new EmailBuilder.EmailBuilderInstance to further populate the email with.

replyingTo

public EmailPopulatingBuilder replyingTo(@Nonnull
                                         Email email)

Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to false and a default HTML quoting template.

replyingToAll

public EmailPopulatingBuilder replyingToAll(@Nonnull
                                            Email email)

Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to true and a default HTML quoting template.

replyingToAll

public EmailPopulatingBuilder replyingToAll(@Nonnull
                                            Email email,
                                            @Nonnull
                                            String customQuotingTemplate)

Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to true.

See Also:

DEFAULT_QUOTING_MARKUP

replyingTo

public EmailPopulatingBuilder replyingTo(@Nonnull
                                         Email email,
                                         @Nonnull
                                         String customQuotingTemplate)

Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to false.

replyingTo

public EmailPopulatingBuilder replyingTo(@Nonnull
                                         javax.mail.internet.MimeMessage email)

Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to false and a default HTML quoting template.

replyingToAll

public EmailPopulatingBuilder replyingToAll(@Nonnull
                                            javax.mail.internet.MimeMessage email,
                                            @Nonnull
                                            String customQuotingTemplate)

Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to true.

See Also:

DEFAULT_QUOTING_MARKUP

replyingTo

public EmailPopulatingBuilder replyingTo(@Nonnull
                                         javax.mail.internet.MimeMessage email,
                                         @Nonnull
                                         String customQuotingTemplate)

Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to false.

replyingToAll

public EmailPopulatingBuilder replyingToAll(@Nonnull
                                            javax.mail.internet.MimeMessage email)

Delegates to replyingTo(MimeMessage, boolean, String) with replyToAll set to true and a default HTML quoting template.

See Also:

DEFAULT_QUOTING_MARKUP

replyingTo

public EmailPopulatingBuilder replyingTo(@Nonnull
                                         javax.mail.internet.MimeMessage emailMessage,
                                         boolean repyToAll,
                                         @Nonnull
                                         String htmlTemplate)

Primes the email with all subject, headers, originally embedded images and recipients needed for a valid RFC reply.

Note: replaces subject with "Re: <original subject>" (but never nested).
Note: Make sure you set the content before using this API or else the quoted content is lost. Replaces body (text is replaced with "> text" and HTML is replaced with the provided or default quoting markup.

Parameters:

emailMessage - The message from which we harvest recipients, original content to quote (including embedded images), message ID to include.

repyToAll - Indicates whether all original receivers should be included in this new reply. Also see MimeMessage.reply(boolean).

htmlTemplate - A valid HTML that contains the string "%s". Be advised that HTML is very limited in emails.

See Also:

replyingTo(Email), replyingTo(Email, String), replyingTo(MimeMessage), replyingTo(MimeMessage, String), replyingToAll(Email), replyingToAll(Email, String), replyingToAll(MimeMessage), replyingToAll(MimeMessage, String), Official JavaMail FAQ on replying, MimeMessage.reply(boolean)

forwarding

public EmailPopulatingBuilder forwarding(@Nonnull
                                         Email email)

Delegates to forwarding(MimeMessage) with the provided Email converted to MimeMessage.

See Also:

EmailConverter.emailToMimeMessage(Email)

forwarding

public EmailPopulatingBuilder forwarding(@Nonnull
                                         javax.mail.internet.MimeMessage emailMessage)

Primes the email to build with proper subject and inline forwarded email needed for a valid RFC forward. Also includes the original email intact, to be rendered by the email client as 'forwarded email'.

Note 1: replaces subject with "Fwd: <original subject>" (nesting enabled).

Note 2: Content-Disposition will be left empty so the receiving email client can decide how to handle display (most will show inline, some will show as attachment instead).

See Also:

Official JavaMail FAQ on forwarding, More reading material, forwarding(Email)

copying

public EmailPopulatingBuilder copying(@Nonnull
                                      javax.mail.internet.MimeMessage message)

Delegates to copying(Email), by converting the email first.

See Also:

EmailConverter.mimeMessageToEmail(MimeMessage)

copying

public EmailPopulatingBuilder copying(@Nonnull
                                      EmailPopulatingBuilder emailBuilder)

Delegates to copying(Email), by building the email first.

See Also:

EmailPopulatingBuilder.buildEmail()

copying

public EmailPopulatingBuilder copying(@Nonnull
                                      Email email)

Preconfigures the builder with all the properties from the given email that are non-null.