org.dspace.core

Class Email

java.lang.Object

org.dspace.core.Email

public class Email
extends java.lang.Object

Class representing an e-mail message, also used to send e-mails.

Typical use:

Email email = ConfigurationManager.getEmail(name);
email.addRecipient("foo@bar.com");
email.addArgument("John");
email.addArgument("On the Testing of DSpace");
email.send();

name is the name of an email template in dspace-dir/config/emails/ (which also includes the subject.) arg0 and arg1 are arguments to fill out the message with.

Emails are formatted using java.text.MessageFormat. Additionally, comment lines (starting with '#') are stripped, and if a line starts with "Subject:" the text on the right of the colon is used for the subject line. For example:

     # This is a comment line which is stripped
     #
     # Parameters:   {0}  is a person's name
     #               {1}  is the name of a submission
     #
     Subject: Example e-mail

     Dear {0},

     Thank you for sending us your submission "{1}".

 

If the example code above was used to send this mail, the resulting mail would have the subject Example e-mail and the body would be:

     Dear John,

     Thank you for sending us your submission "On the Testing of DSpace".

 

Note that parameters like {0} cannot be placed in the subject of the e-mail; they won't get filled out.

Version:

$Revision: 5844 $

Author:

Robert Tansley, Jim Downing - added attachment handling code, Adan Roman Ruiz at arvo.es - added inputstream attachment handling code

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Email.InputStreamDataSource

Constructor Summary

Constructors

Constructor and Description
Email() Create a new email message.

Method Summary

Methods

Modifier and Type	Method and Description
void	addArgument(java.lang.Object arg) Fill out the next argument in the template
void	addAttachment(java.io.File f, java.lang.String name)
void	addAttachment(java.io.InputStream is, java.lang.String name, java.lang.String mimetype)
void	addRecipient(java.lang.String email) Add a recipient
static Email	getEmail(java.lang.String emailFile) Get the template for an email message.
static void	main(java.lang.String[] args) Test method to send an email to check email server settings
void	reset() "Reset" the message.
void	send() Sends the email.
void	setCharset(java.lang.String cs)
void	setContent(java.lang.String cnt) Set the content of the message.
void	setReplyTo(java.lang.String email) Set the reply-to email address
void	setSubject(java.lang.String s) Set the subject of the message

Methods inherited from class java.lang.Object

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

Constructor Detail

Email

public Email()

Create a new email message.

Method Detail

addRecipient

public void addRecipient(java.lang.String email)

Add a recipient

Parameters:

email - the recipient's email address

setContent

public void setContent(java.lang.String cnt)

Set the content of the message. Setting this "resets" the message formatting -addArgument will start. Comments and any "Subject:" line must be stripped.

Parameters:

cnt - the content of the message

setSubject

public void setSubject(java.lang.String s)

Set the subject of the message

Parameters:

s - the subject of the message

setReplyTo

public void setReplyTo(java.lang.String email)

Set the reply-to email address

Parameters:

email - the reply-to email address

addArgument

public void addArgument(java.lang.Object arg)

Fill out the next argument in the template

Parameters:

arg - the value for the next argument

addAttachment

public void addAttachment(java.io.File f,
                 java.lang.String name)

addAttachment

public void addAttachment(java.io.InputStream is,
                 java.lang.String name,
                 java.lang.String mimetype)

setCharset

public void setCharset(java.lang.String cs)

reset

public void reset()

"Reset" the message. Clears the arguments and recipients, but leaves the subject and content intact.

send

public void send()
          throws javax.mail.MessagingException,
                 java.io.IOException

Sends the email.

Throws:

javax.mail.MessagingException - if there was a problem sending the mail.

java.io.IOException

getEmail

public static Email getEmail(java.lang.String emailFile)
                      throws java.io.IOException

Get the template for an email message. The message is suitable for inserting values using java.text.MessageFormat.

Parameters:

emailFile - full name for the email template, for example "/dspace/config/emails/register".

Returns:

the email object, with the content and subject filled out from the template

Throws:

java.io.IOException - if the template couldn't be found, or there was some other error reading the template

main

public static void main(java.lang.String[] args)

Test method to send an email to check email server settings

Parameters:

args - Command line options