Package jenkins.plugins.mailer.tasks

Class MimeMessageBuilder

java.lang.Object

jenkins.plugins.mailer.tasks.MimeMessageBuilder

public class MimeMessageBuilder
extends Object

Builder for MimeMessage. This class is NOT thread-safe.

Author:

tom.fennelly@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MimeMessageBuilder.AddressFilter

Constructor Summary

Constructors

Constructor	Description
MimeMessageBuilder()

Method Summary

Modifier and Type	Method	Description
MimeMessageBuilder	addRecipients(String recipients)
MimeMessageBuilder	addRecipients(String recipients, jakarta.mail.Message.RecipientType recipientType)	Adds the given recipients to the current MIME message.
MimeMessageBuilder	addReplyTo(String replyTo)
jakarta.mail.internet.MimeMessage	buildMimeMessage()	Build a MimeMessage instance from the set of supplied parameters.
MimeMessageBuilder	setBody(String body)
MimeMessageBuilder	setCharset(String charset)
MimeMessageBuilder	setDefaultSuffix(String defaultSuffix)
MimeMessageBuilder	setFrom(String from)
static void	setInReplyTo(jakarta.mail.internet.MimeMessage msg, String inReplyTo)
MimeMessageBuilder	setListener(TaskListener listener)
MimeMessageBuilder	setMimeType(String mimeType)
MimeMessageBuilder	setRecipientFilter(MimeMessageBuilder.AddressFilter recipientFilter)
MimeMessageBuilder	setReplyTo(String replyTo)
MimeMessageBuilder	setSubject(String subject)

Methods inherited from class java.lang.Object

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

Constructor Detail

MimeMessageBuilder

public MimeMessageBuilder()

Method Detail

setCharset

public MimeMessageBuilder setCharset(@NonNull
                                     String charset)

setMimeType

public MimeMessageBuilder setMimeType(@NonNull
                                      String mimeType)

setListener

public MimeMessageBuilder setListener(TaskListener listener)

setDefaultSuffix

public MimeMessageBuilder setDefaultSuffix(@NonNull
                                           String defaultSuffix)

setFrom

public MimeMessageBuilder setFrom(@NonNull
                                  String from)

setReplyTo

public MimeMessageBuilder setReplyTo(@NonNull
                                     String replyTo)

addReplyTo

public MimeMessageBuilder addReplyTo(@NonNull
                                     String replyTo)

setSubject

public MimeMessageBuilder setSubject(@NonNull
                                     String subject)

setBody

public MimeMessageBuilder setBody(@NonNull
                                  String body)

setRecipientFilter

public MimeMessageBuilder setRecipientFilter(MimeMessageBuilder.AddressFilter recipientFilter)

addRecipients

public MimeMessageBuilder addRecipients(@NonNull
                                        String recipients)
                                 throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

addRecipients

public MimeMessageBuilder addRecipients(@NonNull
                                        String recipients,
                                        @NonNull
                                        jakarta.mail.Message.RecipientType recipientType)
                                 throws UnsupportedEncodingException

Adds the given recipients to the current MIME message.

Parameters:

recipients - one or more recipients

recipientType - recipient type

Returns:

the constructed message with the given recipients

Throws:

UnsupportedEncodingException - in case of encoding problems

buildMimeMessage

public jakarta.mail.internet.MimeMessage buildMimeMessage()
                                                   throws jakarta.mail.MessagingException,
                                                          UnsupportedEncodingException

Build a MimeMessage instance from the set of supplied parameters.

Returns:

The MimeMessage instance;

Throws:

jakarta.mail.MessagingException - in case the mail cannot be created

UnsupportedEncodingException - in case of encoding problems

setInReplyTo

public static void setInReplyTo(@NonNull
                                jakarta.mail.internet.MimeMessage msg,
                                @NonNull
                                String inReplyTo)
                         throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException