com.aspc.commander.sql

Class CreateEmailCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.commander.sql.CreateEmailCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class CreateEmailCommand
extends SQLCommand

Sending an email.
Syntax

  CREATE_EMAIL EMAIL_ACCOUNT sender
               [BODY content]|[TEMPLATE template_key]
               RECIPIENTS recipient_list[,...]
               [CC_RECIPIENTS cc_recipient_list[,...]]
               [BCC_RECIPIENTS bcc_recipient_list[,...]]
               [SUBJECT subject]
               [ATTACHMENTS attachments_list[,...]]
               [BASE_OBJ base]
  

Usage

  /* send email from EMAIL_ACCOUNT @12~2@1 with TEMPLATE @16~1@1 to  1@1~1@1,1@2~1@1,1@3~1@1*/
  CREATE_EMAIL EMAIL_ACCOUNT @12~2@1
               TEMPLATE @16~1@1
               RECIPIENTS 1@1~1@1,1@2~1@1,1@3~1@1
  

THREAD MODE: SINGLE THREADED command

Since:

Jul 26, 2005

Author:

nabhilash

Field Summary

Fields inherited from class com.aspc.commander.sql.SQLCommand

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
CreateEmailCommand(Connection connection, Pattern pattern) std.

Method Summary

Modifier and Type	Method and Description
void	addEmailRecipient(MutableDataSource mds, Contact recipient, java.lang.String type, DBEmailSend email) Add values to email recipient object.
protected void	execute(Parser p) execute the command.
DBEmailSend	generateDBEmail(MutableDataSource mds, java.lang.String subject, DBEmailAccount sender, java.lang.String[] recipientList, java.lang.String[] ccRecipientList, java.lang.String[] bccRecipientList, DBEmailTemplate template, java.lang.String content, java.lang.String[] attachmentsList, DBObject base) Generating DBEmail
java.lang.String	getColumnName(int col) implements getColumnName of interface CommandBuildResultsPlugin.
java.lang.String	getColumnType(int col) Gets the column type for the given column index, starting at one
java.lang.String	getRecordID(int row) the record ID
java.lang.Object	getValue(int row, int col) the value for this row, column

Methods inherited from class com.aspc.commander.sql.SQLCommand

appendResult, appendResult, getCursorName, getRecordKey, isExecuteOnly

Methods inherited from class com.aspc.commander.Command

execute, extMakeThreadName, getConnection, getPattern, getRawTitle, getTitle, makeThreadName, recordCall, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspc.commander.sql.results.CommandBuildResultsPlugin

getRawTitle

Constructor Detail

CreateEmailCommand

public CreateEmailCommand(Connection connection,
                          Pattern pattern)

std. Command.

Parameters:

connection - the connection

pattern - the pattern

Method Detail

execute

protected void execute(Parser p)
                throws java.lang.Exception

execute the command.

Specified by:

execute in class Command

Parameters:

p - The parser

Throws:

java.lang.Exception - A serious problem

generateDBEmail

public DBEmailSend generateDBEmail(MutableDataSource mds,
                                   java.lang.String subject,
                                   DBEmailAccount sender,
                                   java.lang.String[] recipientList,
                                   java.lang.String[] ccRecipientList,
                                   java.lang.String[] bccRecipientList,
                                   DBEmailTemplate template,
                                   java.lang.String content,
                                   java.lang.String[] attachmentsList,
                                   DBObject base)
                            throws java.lang.Exception

Generating DBEmail

Parameters:

mds - mutable data source

subject - subject

sender - sender address

recipientList - list of recipient

ccRecipientList - list of cc recipient

bccRecipientList - list of BCC recipient

template - template

content - content

attachmentsList - list of attachment

base - base object

Returns:

DBEmailSend object

Throws:

java.lang.Exception - a serious problem

addEmailRecipient

public void addEmailRecipient(MutableDataSource mds,
                              Contact recipient,
                              java.lang.String type,
                              DBEmailSend email)
                       throws java.lang.Exception

Add values to email recipient object.

Parameters:

mds - mutable datasource

recipient - recipient

type - type of recipient

email - email send object

Throws:

java.lang.Exception - a serious problem

getColumnName

public java.lang.String getColumnName(int col)

implements getColumnName of interface CommandBuildResultsPlugin. Returns the name for the given column index. Column indexes start at 1

Parameters:

col - the column number to name

Returns:

String the name of the column

getRecordID

public java.lang.String getRecordID(int row)

the record ID

Parameters:

row - the row index

Returns:

the record ID

getColumnType

public java.lang.String getColumnType(int col)

Gets the column type for the given column index, starting at one

Parameters:

col - the column index

Returns:

String the column type

getValue

public java.lang.Object getValue(int row,
                                 int col)

the value for this row, column

Parameters:

row - the row index

col - the column

Returns:

Object the value for the given row and column