Package org.apache.logging.log4j.smtp

Class MimeMessageBuilder

java.lang.Object

org.apache.logging.log4j.smtp.MimeMessageBuilder

All Implemented Interfaces:

Builder<jakarta.mail.internet.MimeMessage>

public class MimeMessageBuilder
extends java.lang.Object
implements Builder<jakarta.mail.internet.MimeMessage>

Builder for MimeMessage instances.

Field Summary

Fields

Modifier and Type	Field	Description
private jakarta.mail.internet.MimeMessage	message

Constructor Summary

Constructors

Constructor	Description
MimeMessageBuilder(jakarta.mail.Session session)

Method Summary

Modifier and Type	Method	Description
jakarta.mail.internet.MimeMessage	build()	Builds the object after all configuration has been set.
private static jakarta.mail.internet.InternetAddress	parseAddress(java.lang.String address)
private static jakarta.mail.internet.InternetAddress[]	parseAddresses(java.lang.String addresses)
MimeMessageBuilder	setFrom(java.lang.String from)
MimeMessageBuilder	setRecipients(jakarta.mail.Message.RecipientType recipientType, java.lang.String recipients)
MimeMessageBuilder	setReplyTo(java.lang.String replyTo)
MimeMessageBuilder	setSubject(java.lang.String subject)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Field Detail

message

private final jakarta.mail.internet.MimeMessage message

Constructor Detail

MimeMessageBuilder

public MimeMessageBuilder(jakarta.mail.Session session)

Method Detail

setFrom

public MimeMessageBuilder setFrom(java.lang.String from)
                           throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException

setReplyTo

public MimeMessageBuilder setReplyTo(java.lang.String replyTo)
                              throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException

setRecipients

public MimeMessageBuilder setRecipients(jakarta.mail.Message.RecipientType recipientType,
                                        java.lang.String recipients)
                                 throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException

setSubject

public MimeMessageBuilder setSubject(java.lang.String subject)
                              throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException

build

public jakarta.mail.internet.MimeMessage build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<jakarta.mail.internet.MimeMessage>

Returns:

the configured instance.

parseAddress

private static jakarta.mail.internet.InternetAddress parseAddress(java.lang.String address)
                                                           throws jakarta.mail.internet.AddressException

Throws:

jakarta.mail.internet.AddressException

parseAddresses

private static jakarta.mail.internet.InternetAddress[] parseAddresses(java.lang.String addresses)
                                                               throws jakarta.mail.internet.AddressException

Throws:

jakarta.mail.internet.AddressException