com.esri.arcgis.geoprocessing.tools.servertools
Class SendEmailWithZipFileAttachment

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.servertools.SendEmailWithZipFileAttachment

All Implemented Interfaces:

GPTool

public class SendEmailWithZipFileAttachment
extends AbstractGPTool

Emails a file to an email address using a SMTP email server. The Send Email With Zip File Attachment tool is contained in the Server Tools tool box.

Usage tips:

• Ask your system administrator for details about an SMTP email server that you can use.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

SendEmailWithZipFileAttachment()
Creates the Send Email With Zip File Attachment tool with defaults.

SendEmailWithZipFileAttachment(String to, String from, String subject, String text, Object zipFile, int maxFileSizeMB, String sMTPEmailServer)
Creates the Send Email With Zip File Attachment tool with the required parameters.

Method Summary

String	getFrom() Returns the From parameter of this tool .
int	getMaxFileSizeMB() Returns the Max File Size (MB) parameter of this tool .
String	getPassword() Returns the Password parameter of this tool .
String	getSent() Returns the Sent parameter of this tool (Read only).
String	getSMTPEmailServer() Returns the SMTP Email Server parameter of this tool .
String	getSubject() Returns the Subject parameter of this tool .
String	getText() Returns the Text parameter of this tool .
String	getTo() Returns the To parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
String	getUser() Returns the User parameter of this tool .
Object	getZipFile() Returns the Zip File parameter of this tool .
void	setFrom(String from) Sets the From parameter of this tool .
void	setMaxFileSizeMB(int maxFileSizeMB) Sets the Max File Size (MB) parameter of this tool .
void	setPassword(String password) Sets the Password parameter of this tool .
void	setSMTPEmailServer(String sMTPEmailServer) Sets the SMTP Email Server parameter of this tool .
void	setSubject(String subject) Sets the Subject parameter of this tool .
void	setText(String text) Sets the Text parameter of this tool .
void	setTo(String to) Sets the To parameter of this tool .
void	setUser(String user) Sets the User parameter of this tool .
void	setZipFile(Object zipFile) Sets the Zip File parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SendEmailWithZipFileAttachment

public SendEmailWithZipFileAttachment()

Creates the Send Email With Zip File Attachment tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

SendEmailWithZipFileAttachment

public SendEmailWithZipFileAttachment(String to,
                                      String from,
                                      String subject,
                                      String text,
                                      Object zipFile,
                                      int maxFileSizeMB,
                                      String sMTPEmailServer)

Creates the Send Email With Zip File Attachment tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

to - the email address of the recipient.

from - the email address of the sender.

subject - the text in the subject line of the email.

text - the body text of the email.

zipFile - the file to be attached to the email.

maxFileSizeMB - the maximum allowable size of an attachment. if you don't know what to use for Max File Size, check the attachment size limit of your SMTP mail server and the recipient email provider .

sMTPEmailServer - the SMTP email server that will deliver the email.

Method Detail

getTo

public String getTo()

Returns the To parameter of this tool . This parameter is the email address of the recipient. This is a required parameter.

Returns:

the To

setTo

public void setTo(String to)

Sets the To parameter of this tool . This parameter is the email address of the recipient. This is a required parameter.

Parameters:

to - the email address of the recipient.

getFrom

public String getFrom()

Returns the From parameter of this tool . This parameter is the email address of the sender. This is a required parameter.

Returns:

the From

setFrom

public void setFrom(String from)

Sets the From parameter of this tool . This parameter is the email address of the sender. This is a required parameter.

Parameters:

from - the email address of the sender.

getSubject

public String getSubject()

Returns the Subject parameter of this tool . This parameter is the text in the subject line of the email. This is a required parameter.

Returns:

the Subject

setSubject

public void setSubject(String subject)

Sets the Subject parameter of this tool . This parameter is the text in the subject line of the email. This is a required parameter.

Parameters:

subject - the text in the subject line of the email.

getText

public String getText()

Returns the Text parameter of this tool . This parameter is the body text of the email. This is a required parameter.

Returns:

the Text

setText

public void setText(String text)

Sets the Text parameter of this tool . This parameter is the body text of the email. This is a required parameter.

Parameters:

text - the body text of the email.

getZipFile

public Object getZipFile()

Returns the Zip File parameter of this tool . This parameter is the file to be attached to the email. This is a required parameter.

Returns:

the Zip File

setZipFile

public void setZipFile(Object zipFile)

Sets the Zip File parameter of this tool . This parameter is the file to be attached to the email. This is a required parameter.

Parameters:

zipFile - the file to be attached to the email.

getMaxFileSizeMB

public int getMaxFileSizeMB()

Returns the Max File Size (MB) parameter of this tool . This parameter is the maximum allowable size of an attachment. if you don't know what to use for Max File Size, check the attachment size limit of your SMTP mail server and the recipient email provider . This is a required parameter.

Returns:

the Max File Size (MB)

setMaxFileSizeMB

public void setMaxFileSizeMB(int maxFileSizeMB)

Sets the Max File Size (MB) parameter of this tool . This parameter is the maximum allowable size of an attachment. if you don't know what to use for Max File Size, check the attachment size limit of your SMTP mail server and the recipient email provider . This is a required parameter.

Parameters:

maxFileSizeMB - the maximum allowable size of an attachment. if you don't know what to use for Max File Size, check the attachment size limit of your SMTP mail server and the recipient email provider .

getSMTPEmailServer

public String getSMTPEmailServer()

Returns the SMTP Email Server parameter of this tool . This parameter is the SMTP email server that will deliver the email. This is a required parameter.

Returns:

the SMTP Email Server

setSMTPEmailServer

public void setSMTPEmailServer(String sMTPEmailServer)

Sets the SMTP Email Server parameter of this tool . This parameter is the SMTP email server that will deliver the email. This is a required parameter.

Parameters:

sMTPEmailServer - the SMTP email server that will deliver the email.

getUser

public String getUser()

Returns the User parameter of this tool . This parameter is the user which will log into the SMTP email server. This is an optional parameter.

Returns:

the User

setUser

public void setUser(String user)

Sets the User parameter of this tool . This parameter is the user which will log into the SMTP email server. This is an optional parameter.

Parameters:

user - the user which will log into the SMTP email server.

getPassword

public String getPassword()

Returns the Password parameter of this tool . This parameter is the user password used to connect to the SMTP email server (if necessary). This is an optional parameter.

Returns:

the Password

setPassword

public void setPassword(String password)

Sets the Password parameter of this tool . This parameter is the user password used to connect to the SMTP email server (if necessary). This is an optional parameter.

Parameters:

password - the user password used to connect to the SMTP email server (if necessary).

getSent

public String getSent()

Returns the Sent parameter of this tool (Read only). This is an derived parameter.

Returns:

the Sent

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias