Package org.quartz.jobs.ee.mail

Class SendMailJob

java.lang.Object

org.quartz.jobs.ee.mail.SendMailJob

All Implemented Interfaces:

org.quartz.Job

public class SendMailJob
extends java.lang.Object
implements org.quartz.Job

A Job which sends an e-mail with the configured content to the configured recipient. Arbitrary mail.smtp.xxx settings can be added to job data and they will be passed along the mail session

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SendMailJob.MailInfo

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROP_CC_RECIPIENT	The e-mail address to cc the mail to.
static java.lang.String	PROP_CONTENT_TYPE	The message content type.
static java.lang.String	PROP_MESSAGE	The e-mail message body.
static java.lang.String	PROP_PASSWORD	Password for authenticated session.
static java.lang.String	PROP_RECIPIENT	The e-mail address to send the mail to.
static java.lang.String	PROP_REPLY_TO	The e-mail address the message should say to reply to.
static java.lang.String	PROP_SENDER	The e-mail address to claim the mail is from.
static java.lang.String	PROP_SMTP_HOST	The host name of the smtp server.
static java.lang.String	PROP_SUBJECT	The subject to place on the e-mail.
static java.lang.String	PROP_USERNAME	Username for authenticated session.

Constructor Summary

Constructors

Constructor	Description
SendMailJob()

Method Summary

Modifier and Type	Method	Description
protected SendMailJob.MailInfo	createMailInfo()
void	execute(org.quartz.JobExecutionContext context)
protected org.slf4j.Logger	getLog()
protected jakarta.mail.Session	getMailSession(SendMailJob.MailInfo mailInfo)
protected java.lang.String	getOptionalParm(org.quartz.JobDataMap data, java.lang.String property)
protected java.lang.String	getRequiredParm(org.quartz.JobDataMap data, java.lang.String property, java.lang.String constantName)
protected SendMailJob.MailInfo	populateMailInfo(org.quartz.JobDataMap data, SendMailJob.MailInfo mailInfo)
protected jakarta.mail.internet.MimeMessage	prepareMimeMessage(SendMailJob.MailInfo mailInfo)
protected void	setMimeMessageContent(jakarta.mail.internet.MimeMessage mimeMessage, SendMailJob.MailInfo mailInfo)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_SMTP_HOST

public static final java.lang.String PROP_SMTP_HOST

The host name of the smtp server. REQUIRED.

See Also:

Constant Field Values

PROP_RECIPIENT

public static final java.lang.String PROP_RECIPIENT

The e-mail address to send the mail to. REQUIRED.

See Also:

Constant Field Values

PROP_CC_RECIPIENT

public static final java.lang.String PROP_CC_RECIPIENT

The e-mail address to cc the mail to. Optional.

See Also:

Constant Field Values

PROP_SENDER

public static final java.lang.String PROP_SENDER

The e-mail address to claim the mail is from. REQUIRED.

See Also:

Constant Field Values

PROP_REPLY_TO

public static final java.lang.String PROP_REPLY_TO

The e-mail address the message should say to reply to. Optional.

See Also:

Constant Field Values

PROP_SUBJECT

public static final java.lang.String PROP_SUBJECT

The subject to place on the e-mail. REQUIRED.

See Also:

Constant Field Values

PROP_MESSAGE

public static final java.lang.String PROP_MESSAGE

The e-mail message body. REQUIRED.

See Also:

Constant Field Values

PROP_CONTENT_TYPE

public static final java.lang.String PROP_CONTENT_TYPE

The message content type. For example, "text/html". Optional.

See Also:

Constant Field Values

PROP_USERNAME

public static final java.lang.String PROP_USERNAME

Username for authenticated session. Password must also be set if username is used. Optional.

See Also:

Constant Field Values

PROP_PASSWORD

public static final java.lang.String PROP_PASSWORD

Password for authenticated session. Optional.

See Also:

Constant Field Values

Constructor Detail

SendMailJob

public SendMailJob()

Method Detail

execute

public void execute(org.quartz.JobExecutionContext context)
             throws org.quartz.JobExecutionException

Specified by:

execute in interface org.quartz.Job

Throws:

org.quartz.JobExecutionException

See Also:

Job.execute(org.quartz.JobExecutionContext)

getLog

protected org.slf4j.Logger getLog()

prepareMimeMessage

protected jakarta.mail.internet.MimeMessage prepareMimeMessage(SendMailJob.MailInfo mailInfo)
                                                        throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException

setMimeMessageContent

protected void setMimeMessageContent(jakarta.mail.internet.MimeMessage mimeMessage,
                                     SendMailJob.MailInfo mailInfo)
                              throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException

getMailSession

protected jakarta.mail.Session getMailSession(SendMailJob.MailInfo mailInfo)
                                       throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException

createMailInfo

protected SendMailJob.MailInfo createMailInfo()

populateMailInfo

protected SendMailJob.MailInfo populateMailInfo(org.quartz.JobDataMap data,
                                                SendMailJob.MailInfo mailInfo)

getRequiredParm

protected java.lang.String getRequiredParm(org.quartz.JobDataMap data,
                                           java.lang.String property,
                                           java.lang.String constantName)

getOptionalParm

protected java.lang.String getOptionalParm(org.quartz.JobDataMap data,
                                           java.lang.String property)