com.novell.nds.dirxml.job

Interface JobEmail

public interface JobEmail

Interface to allow a Job implementation to send email using the Identity Manager email notification template facility.

Method Summary

Modifier and Type	Method and Description
JobResult[]	checkConfig(java.util.Locale msgLocale) Verify that the job is configured properly to send email.
JobResult	sendMail(java.lang.String from, java.lang.String replyTo, java.lang.String[] to, java.lang.String[] cc, java.lang.String[] bcc, DirectoryObject template, java.util.Map replacementData, java.lang.String encoding, java.util.List customHeaders) Send email based on an eDirectory notfMergeTemplate object that contains the email body and the subject information.
JobResult	sendMail(java.lang.String from, java.lang.String replyTo, java.lang.String[] to, java.lang.String[] cc, java.lang.String[] bcc, java.lang.String subject, java.lang.String body, java.lang.String encoding, java.util.List customHeaders, boolean sendAsHTML) Send email based on passed subject and email body.

Method Detail

checkConfig

JobResult[] checkConfig(java.util.Locale msgLocale)

Verify that the job is configured properly to send email. This means that the DirXML-Job object has a reference to a properly configured notfTemplateCollection object.

Returns:

an array of one or more JobResult implementations if there is an error, null if everything appears to be configured correctly.

sendMail

JobResult sendMail(java.lang.String from,
                   java.lang.String replyTo,
                   java.lang.String[] to,
                   java.lang.String[] cc,
                   java.lang.String[] bcc,
                   DirectoryObject template,
                   java.util.Map replacementData,
                   java.lang.String encoding,
                   java.util.List customHeaders)
            throws java.lang.IllegalArgumentException

Send email based on an eDirectory notfMergeTemplate object that contains the email body and the subject information.

Parameters:

from - SMTP email address for "From" field. If null then the "from" value from the notfTemplateCollection object specified for the job will be used.

replyTo - SMTP email address for "Reply to" field (may be null)

to - array of primary recipient SMTP email addresses (may not be null or empty)

cc - array of "CC" recipient SMTP email addresses (may be null)

bcc - array of "BCC" recipient SMTP email addresses (may be null)

template - notfMergeTemplate object containing email subject and body data

replacementData - key-value pairs of strings containing replacement data for the template

encoding - character encoding to use (may be null)

customHeaders - list of Strings, each containing a custom SMTP header line (may be null)

Returns:

result (will not be null)

Throws:

java.lang.IllegalArgumentException - if one of the required parameters is null, empty, or otherwise invalid

sendMail

JobResult sendMail(java.lang.String from,
                   java.lang.String replyTo,
                   java.lang.String[] to,
                   java.lang.String[] cc,
                   java.lang.String[] bcc,
                   java.lang.String subject,
                   java.lang.String body,
                   java.lang.String encoding,
                   java.util.List customHeaders,
                   boolean sendAsHTML)
            throws java.lang.IllegalArgumentException

Send email based on passed subject and email body.

Parameters:

from - SMTP email address for "From" field. If null then the "from" value from the notfTemplateCollection object specified for the job will be used.

replyTo - SMTP email address for "Reply to" field (may be null)

to - array of primary recipient SMTP email addresses (may not be null or empty)

cc - array of "CC" recipient SMTP email addresses (may be null)

bcc - array of "BCC" recipient SMTP email addresses (may be null)

subject - email message subject line

body - email message body

encoding - character encoding to use (may be null)

customHeaders - list of Strings, each containing a custom SMTP header line (may be null)

sendAsHTML - if true, email is sent as HTML, if false email is sent as plain text.

Returns:

result (will not be null)

Throws:

java.lang.IllegalArgumentException - if one of the required parameters is null, empty, or otherwise invalid