Top Description Fields Constructors Methods
org.springframework.mail

public Class SimpleMailMessage

extends Object
implements MailMessage, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.springframework.mail.MailMessage
Annotations
@SuppressWarnings:serial
Imports
java.io.Serializable, java.util.Date, org.springframework.lang.Nullable, org.springframework.util.Assert, .ObjectUtils, .StringUtils

Models a simple mail message, including data such as the from, to, cc, subject, and text fields.

Consider JavaMailSender and JavaMail MimeMessages for creating more sophisticated messages, for example messages with attachments, special character encodings, or personal names that accompany mail addresses.

Authors
Dmitriy Kopylenko, Juergen Hoeller
Since
10.09.2003
See Also
MailSender, org.springframework.mail.javamail.JavaMailSender, org.springframework.mail.javamail.MimeMessagePreparator, org.springframework.mail.javamail.MimeMessageHelper, org.springframework.mail.javamail.MimeMailMessage

Field Summary

Modifier and TypeField and Description
private String[]
private String[]
private String
private String
private Date
private String
private String
private String[]

Constructor Summary

AccessConstructor and Description
public
SimpleMailMessage()

Create a new SimpleMailMessage.

public
SimpleMailMessage(SimpleMailMessage original)

Copy constructor for creating a new SimpleMailMessage from the state of an existing SimpleMailMessage instance.

Method Summary

Modifier and TypeMethod and Description
private static String[]
copy(String[] state)

private static String[]
copyOrNull(String[] state)

public void
copyTo(MailMessage
the MailMessage to copy to
target
)

Copy the contents of this message to the given target message.

public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String[]
public String[]
public String
public String
public Date
public String
public String
public String[]
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

bccback to summary
private String[] bcc
Annotations
@Nullable
ccback to summary
private String[] cc
Annotations
@Nullable
fromback to summary
private String from
Annotations
@Nullable
replyToback to summary
private String replyTo
Annotations
@Nullable
sentDateback to summary
private Date sentDate
Annotations
@Nullable
subjectback to summary
private String subject
Annotations
@Nullable
textback to summary
private String text
Annotations
@Nullable
toback to summary
private String[] to
Annotations
@Nullable

Constructor Detail

SimpleMailMessageback to summary
public SimpleMailMessage()

Create a new SimpleMailMessage.

SimpleMailMessageback to summary
public SimpleMailMessage(SimpleMailMessage original)

Copy constructor for creating a new SimpleMailMessage from the state of an existing SimpleMailMessage instance.

Method Detail

copyback to summary
private static String[] copy(String[] state)
copyOrNullback to summary
private static String[] copyOrNull(String[] state)
Annotations
@Nullable
copyToback to summary
public void copyTo(MailMessage target)

Copy the contents of this message to the given target message.

Parameters
target:MailMessage

the MailMessage to copy to

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getBccback to summary
public String[] getBcc()
Annotations
@Nullable
getCcback to summary
public String[] getCc()
Annotations
@Nullable
getFromback to summary
public String getFrom()
Annotations
@Nullable
getReplyToback to summary
public String getReplyTo()
Annotations
@Nullable
getSentDateback to summary
public Date getSentDate()
Annotations
@Nullable
getSubjectback to summary
public String getSubject()
Annotations
@Nullable
getTextback to summary
public String getText()
Annotations
@Nullable
getToback to summary
public String[] getTo()
Annotations
@Nullable
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
setBccback to summary
public void setBcc(String bcc)

Implements org.springframework.mail.MailMessage.setBcc.

Annotations
@Override
setBccback to summary
public void setBcc(String... bcc)

Implements org.springframework.mail.MailMessage.setBcc.

Annotations
@Override
setCcback to summary
public void setCc(String cc)

Implements org.springframework.mail.MailMessage.setCc.

Annotations
@Override
setCcback to summary
public void setCc(String... cc)

Implements org.springframework.mail.MailMessage.setCc.

Annotations
@Override
setFromback to summary
public void setFrom(String from)

Implements org.springframework.mail.MailMessage.setFrom.

Annotations
@Override
setReplyToback to summary
public void setReplyTo(String replyTo)

Implements org.springframework.mail.MailMessage.setReplyTo.

Annotations
@Override
setSentDateback to summary
public void setSentDate(Date sentDate)

Implements org.springframework.mail.MailMessage.setSentDate.

Annotations
@Override
setSubjectback to summary
public void setSubject(String subject)

Implements org.springframework.mail.MailMessage.setSubject.

Annotations
@Override
setTextback to summary
public void setText(String text)

Implements org.springframework.mail.MailMessage.setText.

Annotations
@Override
setToback to summary
public void setTo(String to)

Implements org.springframework.mail.MailMessage.setTo.

Annotations
@Override
setToback to summary
public void setTo(String... to)

Implements org.springframework.mail.MailMessage.setTo.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override