jodd.mail

Class SendMailSession

java.lang.Object

jodd.mail.SendMailSession

All Implemented Interfaces:

java.lang.AutoCloseable

public class SendMailSession
extends java.lang.Object

Encapsulates Email sending session. Prepares and sends sendMail(Email) Emails.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	jodd.mail.MailSession.Defaults

Field Summary

Fields

Modifier and Type	Field and Description
protected jakarta.mail.Service	service

Constructor Summary

Constructors

Constructor and Description
SendMailSession(jakarta.mail.Session session, jakarta.mail.Transport transport) Creates new mail session.

Method Summary

Modifier and Type	Method and Description
void	close() Closes session.
protected jakarta.mail.internet.MimeBodyPart	createAttachmentBodyPart(EmailAttachment<? extends jakarta.activation.DataSource> attachment) Creates attachment body part.
protected jakarta.mail.internet.MimeMessage	createMessage(Email email) Creates new MimeMessage from an Email.
protected static java.util.List<EmailAttachment<? extends jakarta.activation.DataSource>>	filterEmbeddedAttachments(java.util.List<EmailAttachment<? extends jakarta.activation.DataSource>> attachments, EmailMessage emailMessage) Filters out the List of embedded EmailAttachments for given EmailMessage.
jakarta.mail.Transport	getService() Returns the Service.
jakarta.mail.Session	getSession() Returns the Session.
boolean	isConnected() Returns true if mail session is still connected.
void	open() Opens session.
java.lang.String	sendMail(Email email) Prepares message and sends it.
protected static void	setupSystemMailProperties() Setups the system email properties.

Methods inherited from class java.lang.Object

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

Field Detail

service

protected final jakarta.mail.Service service

Constructor Detail

SendMailSession

public SendMailSession(jakarta.mail.Session session,
                       jakarta.mail.Transport transport)

Creates new mail session.

Parameters:

session - Session

transport - Transport

Method Detail

getService

public jakarta.mail.Transport getService()

Returns the Service.

Returns:

the Service.

sendMail

public java.lang.String sendMail(Email email)

Prepares message and sends it. Returns Message ID of sent email.

Parameters:

email - Email to send.

Returns:

String representing message ID.

createMessage

protected jakarta.mail.internet.MimeMessage createMessage(Email email)
                                                   throws jakarta.mail.MessagingException

Creates new MimeMessage from an Email.

Parameters:

email - Email to be created as a MimeMessage.

Returns:

MimeMessage created from an Email.

Throws:

jakarta.mail.MessagingException - if there is a failure

createAttachmentBodyPart

protected jakarta.mail.internet.MimeBodyPart createAttachmentBodyPart(EmailAttachment<? extends jakarta.activation.DataSource> attachment)
                                                               throws jakarta.mail.MessagingException

Creates attachment body part. Handles regular and inline attachments.

Parameters:

attachment - Body part EmailAttachment.

Returns:

MimeBodyPart which represents body part attachment.

Throws:

jakarta.mail.MessagingException - if there is a failure.

filterEmbeddedAttachments

protected static java.util.List<EmailAttachment<? extends jakarta.activation.DataSource>> filterEmbeddedAttachments(java.util.List<EmailAttachment<? extends jakarta.activation.DataSource>> attachments,
                                                                                                                    EmailMessage emailMessage)

Filters out the List of embedded EmailAttachments for given EmailMessage. This will remove the embedded attachments from the List and return them in a new List.

Parameters:

attachments - List of attachments to search for in emailMessage.

emailMessage - EmailMessage to see if attachment is embedded into.

Returns:

List of embedded EmailAttachments; otherwise, returns empty List.

setupSystemMailProperties

protected static void setupSystemMailProperties()

Setups the system email properties.

open

public void open()

Opens session.

close

public void close()

Closes session.

Specified by:

close in interface java.lang.AutoCloseable

isConnected

public boolean isConnected()

Returns true if mail session is still connected.

Returns:

true if mail session is still connected.

getSession

public jakarta.mail.Session getSession()

Returns the Session.

Returns:

the Session.