org.nlab.smtp.transport.connection

Interface ClosableSmtpConnection

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DefaultClosableSmtpConnection

public interface ClosableSmtpConnection
extends AutoCloseable

Created by nlabrot on 30/04/15.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER_MESSAGE_ID

Method Summary

Modifier and Type	Method and Description
void	addTransportListener(jakarta.mail.event.TransportListener l) Add a new TransportListener
void	clearListeners() Clear the list of TransportListener
jakarta.mail.Transport	getDelegate()
jakarta.mail.Session	getSession()
void	invalidate() Marks this pooled object to be invalid such that it is not returned in the pool when closed.
boolean	isConnected() Test if the current connection is connected
void	removeTransportListener(jakarta.mail.event.TransportListener l) Remove the provided TransportListener
void	sendMessage(jakarta.mail.internet.MimeMessage msg) Send a message.
void	sendMessage(jakarta.mail.internet.MimeMessage msg, jakarta.mail.Address[] recipients) Send a message to a list of recipients
void	sendMessages(jakarta.mail.internet.MimeMessage... msgs) Send the given array of JavaMail MIME messages in batch.
void	setInvalidateConnectionOnClose(boolean invalid) Allows setting the invalid flag to true or false

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

HEADER_MESSAGE_ID

static final String HEADER_MESSAGE_ID

See Also:

Constant Field Values

Method Detail

invalidate

void invalidate()

Marks this pooled object to be invalid such that it is not returned in the pool when closed. This is equivalent to setInvalid(true).

setInvalidateConnectionOnClose

void setInvalidateConnectionOnClose(boolean invalid)

Allows setting the invalid flag to true or false

Parameters:

invalid - true if the object should not be returned in the pool when closed.

sendMessage

void sendMessage(jakarta.mail.internet.MimeMessage msg,
                 jakarta.mail.Address[] recipients)
          throws jakarta.mail.MessagingException,
                 MailSendException

Send a message to a list of recipients

Parameters:

msg -

recipients -

Throws:

jakarta.mail.MessagingException

MailSendException

sendMessage

void sendMessage(jakarta.mail.internet.MimeMessage msg)
          throws jakarta.mail.MessagingException

Send a message. The list of recipients are taken from MimeMessage.getAllRecipients()

Parameters:

msg - MimeMessage

Throws:

jakarta.mail.MessagingException

sendMessages

void sendMessages(jakarta.mail.internet.MimeMessage... msgs)
           throws MailSendException

Send the given array of JavaMail MIME messages in batch. Do not stop the batch when a message could not be sent MailSendException.getFailedMessages() will contain the failed messages

Parameters:

msgs - Array of MimeMessage

Throws:

MailSendException - in case of failure when sending a message

isConnected

boolean isConnected()

Test if the current connection is connected

Returns:

addTransportListener

void addTransportListener(jakarta.mail.event.TransportListener l)

Add a new TransportListener

Parameters:

l -

removeTransportListener

void removeTransportListener(jakarta.mail.event.TransportListener l)

Remove the provided TransportListener

Parameters:

l -

clearListeners

void clearListeners()

Clear the list of TransportListener

getDelegate

jakarta.mail.Transport getDelegate()

Returns:

the Transport associated to this connection

getSession

jakarta.mail.Session getSession()

Returns:

the Session