public class

MailSendException

extends MailException
java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ java.lang.RuntimeException
         ↳ org.springframework.core.NestedRuntimeException
           ↳ org.springframework.mail.MailException
             ↳ org.springframework.mail.MailSendException

Class Overview

Exception thrown when a mail sending error is encountered. Can register failed messages with their exceptions.

Summary

Public Constructors
MailSendException(String msg)
Constructor for MailSendException.
MailSendException(String msg, Throwable cause)
Constructor for MailSendException.
MailSendException(String msg, Throwable cause, Map<Object, Exception> failedMessages)
Constructor for registration of failed messages, with the messages that failed as keys, and the thrown exceptions as values.
MailSendException(Map<Object, Exception> failedMessages)
Constructor for registration of failed messages, with the messages that failed as keys, and the thrown exceptions as values.
Public Methods
final Map<Object, Exception> getFailedMessages()
Return a Map with the failed messages as keys, and the thrown exceptions as values.
String getMessage()
Return the detail message, including the message from the nested exception if there is one.
final Exception[] getMessageExceptions()
Return an array with thrown message exceptions.
void printStackTrace(PrintWriter pw)
void printStackTrace(PrintStream ps)
String toString()
[Expand]
Inherited Methods
From class org.springframework.core.NestedRuntimeException
From class java.lang.Throwable
From class java.lang.Object

Public Constructors

public MailSendException (String msg)

Constructor for MailSendException.

Parameters
msg the detail message

public MailSendException (String msg, Throwable cause)

Constructor for MailSendException.

Parameters
msg the detail message
cause the root cause from the mail API in use

public MailSendException (String msg, Throwable cause, Map<Object, Exception> failedMessages)

Constructor for registration of failed messages, with the messages that failed as keys, and the thrown exceptions as values.

The messages should be the same that were originally passed to the invoked send method.

Parameters
msg the detail message
cause the root cause from the mail API in use
failedMessages Map of failed messages as keys and thrown exceptions as values

public MailSendException (Map<Object, Exception> failedMessages)

Constructor for registration of failed messages, with the messages that failed as keys, and the thrown exceptions as values.

The messages should be the same that were originally passed to the invoked send method.

Parameters
failedMessages Map of failed messages as keys and thrown exceptions as values

Public Methods

public final Map<Object, Exception> getFailedMessages ()

Return a Map with the failed messages as keys, and the thrown exceptions as values.

Note that a general mail server connection failure will not result in failed messages being returned here: A message will only be contained here if actually sending it was attempted but failed.

The messages will be the same that were originally passed to the invoked send method, that is, SimpleMailMessages in case of using the generic MailSender interface.

In case of sending MimeMessage instances via JavaMailSender, the messages will be of type MimeMessage.

NOTE: This Map will not be available after serialization. Use getMessageExceptions() in such a scenario, which will be available after serialization as well.

Returns
  • the Map of failed messages as keys and thrown exceptions as values
See Also

public String getMessage ()

Return the detail message, including the message from the nested exception if there is one.

public final Exception[] getMessageExceptions ()

Return an array with thrown message exceptions.

Note that a general mail server connection failure will not result in failed messages being returned here: A message will only be contained here if actually sending it was attempted but failed.

Returns
  • the array of thrown message exceptions, or an empty array if no failed messages

public void printStackTrace (PrintWriter pw)

public void printStackTrace (PrintStream ps)

public String toString ()