public class MailInformation
extends java.lang.Object
implements java.io.Serializable
A MailInformation
object contains the complete information for a mail.
Modifier and Type | Field and Description |
---|---|
static byte |
ENCRYPTED_NONE
Connect the SMTP with none encrypt format.
|
static byte |
ENCRYPTED_SSL
Connect the SMTP with SSL encrypt format.
|
static byte |
ENCRYPTED_TLS
Connect the SMTP with TLS encrypt format.
|
static int |
HIDDEN
Indicates that the html text overflow type is HIDDEN.
|
static int |
HTMLFILE
The constant indicates that the html format file is the mail attached file(s)
|
static int |
HTMLMAIL
The constant indicates that the html file is in mail body.
|
static int |
IE
browser type
|
static int |
NETSCAPE
browser type
|
static int |
PDFFILE
The constant indicates that the Pdf format file is the mail attached file.
|
static int |
PLAINTXT
The constant indicates that the text format file is the mail attached file.
|
static int |
PRECISION_ANY
The constant indicates that the layout precision could be any value, low or high.
|
static int |
PRECISION_HIGH
The constant indicates that the layout precision is high.
|
static int |
PRECISION_LOW
The constant indicates that the layout precision is low.
|
static int |
PSFILE
The constant indicates that the postscript format file is the mail attached file.
|
static int |
RSTFILE
The constant indicates that Rst format file is the mail attached file.
|
static int |
RTFFILE
The constant indicates that the Rtf format file is the mail attached file
|
static int |
TXTMAIL
The constant indicates that the Text file in mail body
|
static int |
VISIBLE
Indicates that the html text overflow type is VISIBLE.
|
static int |
XLSFILE
The constant indicates that excel format file is the mail attached file.
|
static int |
XMLFILE
The constant indicates that the xml format file(s) is the mail attached file.
|
Constructor and Description |
---|
MailInformation()
Constructs a new
MailInformation object
and invokes other setting method to set another needed parameter for exporting to mail. |
MailInformation(java.lang.String from,
java.lang.String rcpt,
java.lang.String cc,
java.lang.String bcc,
java.lang.String subject,
java.lang.String comments)
Constructs a new
MailInformation object with the following
parameters and invokes the following setting method to set the attached file parameter. |
MailInformation(java.lang.String from,
java.lang.String rcpt,
java.lang.String cc,
java.lang.String bcc,
java.lang.String subject,
java.lang.String comments,
boolean archiveCompress,
boolean bChartApplet,
boolean isMultiFile,
boolean bUsingTable,
boolean hyperlink,
boolean pageno,
boolean absolute,
boolean bincdrilldownfile,
boolean noMarginHtml,
int browser,
int udchWidth,
int udchHeight,
int resolution,
boolean compress,
boolean bRepeat,
boolean quoteMark,
boolean hasHeadFoot,
char delimiter,
boolean noMarginPDF,
boolean isPrintMode,
boolean isTransparent,
int isCompressImage,
boolean noMarginPS,
boolean noMarginRTF,
boolean isOnlyData,
java.lang.String xsdFile,
int isWordWrap,
boolean isBiff8,
boolean bToc,
boolean bDrill,
java.lang.String encoding)
Deprecated.
please use MailInformation() or MailInformation(String, String, String, String, String, String)
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
clear another file instance
|
MailInformation |
copy()
Adds this method for server group to invoke it.
|
java.lang.String |
getBlindCarbonCopy()
Gets the mail address of the blind copy recipient.
|
java.lang.String |
getCarbonCopy()
Gets the mail address of the carbon copy recipient.
|
java.lang.String |
getComments()
Gets text string for memoire.
|
java.lang.String |
getEncoding()
Gets the encoding of the mail.
|
byte |
getEncryptConnectionFormat()
Get the connection format.
|
ExcelParameter |
getExcelParameter()
Gets the excel parameter, which includes the needed parameter when producing excel files.
|
java.lang.String |
getFilename()
Gets the compressed file name.
|
java.lang.String |
getFileName(int format)
Gets the file name according to the format.
|
java.lang.String |
getFilenameFmt()
Stores the zip(template) name for server.
|
java.lang.String |
getFolder()
Gets the directory of saved files.
|
HtmlParameter |
getHtmlParameter(int type)
Gets the html parameter, which includes the parameter when producing the needed html files.
|
long |
getLimitSize()
Gets the limited file length.
|
java.lang.String[] |
getMailAuthencatorMessage()
Gets the mail authenticator message.
|
java.lang.String |
getMailFileNameFmt(int format)
Only for inner group to store template name.
|
boolean |
getMailFormat(int format)
Gets the flag whether this format is for mailbody or attached file.
|
java.lang.String |
getMailFrom()
Gets the mail address of the sender.
|
java.lang.String |
getMailTo()
Gets the mail address of the mail recipient.
|
java.util.Vector |
getOtherAttachedFile()
Gets other attached files.
|
PDFParameter |
getPDFParameters()
Gets the pdf parameter, which includes the needed parameter when producing pdf files.
|
int |
getPrecise(int format)
Gets the flag which indicates format file precision value.
|
PSParameter |
getPSParameter()
Gets the ps parameter, which includes the needed parameter when producing ps files.
|
java.lang.String |
getRSTFileName()
Gets the RST file name.
|
RtfParameter |
getRtfParameter()
Gets the rtf parameter, which includes the needed parameter when producing rtf files.
|
java.lang.String |
getSubject()
Gets the mail subject.
|
TextParameter |
getTextParameter(int format)
Gets the text parameter according to the format.
|
boolean |
getToEmailRstNoFileExt() |
java.lang.String |
getURL()
Deprecated.
This method is not used now. Will remove it in next version.
If you have any questions, please contact our sales.
|
XmlParameter |
getXmlParameter()
Get the xml parameter, which includes the needed parameter when producing xml files.
|
boolean |
isArchiveCompress() |
boolean |
isAuthencator()
Indexes whether to send mail with authenticator format.
|
boolean |
isCompressedRST()
get the flag that identify the RST file is compressed format or not
|
boolean |
isDisableLinkReport(int format)
Gets the flag which indicates format file disable link report value.
|
boolean |
isRSTFile()
Identifies whether the attached file includes RST file or not.
|
boolean |
isSendNotice()
Gets whether to send a mail to notice user or not.
|
boolean |
isSentMail()
Gets whether has sent the mail with attachment.
|
void |
setAbsoluteFontSize(boolean absolute)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setArchiveCompress(boolean archiveCompress)
Sets whether or not to compress mail attachment by using java compress utilities.
|
void |
setAuthencatorMessage(java.lang.String username,
java.lang.String passWord,
java.lang.String fromAddress)
Sets the authenticator message.
|
void |
setBlindCarbonCopy(java.lang.String bcc)
Sets the mail address of the blind copy recipient.
|
void |
setBrowser(int browser)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setCarbonCopy(java.lang.String cc)
Sets the mail address of the carbon copy recipient.
|
void |
setCharHeight(int udchHeight)
Deprecated.
please use setTextParameter(TextParameter) to replace this method
|
void |
setChartappletHtml(boolean bChartApplet)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setCharWidth(int udchWidth)
Deprecated.
please use setTextParameter(TextParameter) to replace this method
|
void |
setComments(java.lang.String comments)
Sets text string for memoire.
|
void |
setCompressImage(int isCompressImage)
Deprecated.
please use setPDFParameters(PDFParameter) to replace this method
|
void |
setCompressText(boolean compress)
Deprecated.
please use setTextParameter(TextParameter) to replace this method
|
void |
setDelimiter(char delimiter)
Deprecated.
please use setTextParameter(TextParameter) to replace this method
|
void |
setDisableLinkReport(int format,
boolean disable)
Sets the flag disable to the format.
|
void |
setDrill(boolean bDrill)
Deprecated.
please use setPDFParameters(PDFParameter) to replace this method
|
void |
setDrillDownHtml(boolean bincdrilldownfile)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setEncoding(java.lang.String encoding)
Sets the encoding of the mail.
|
void |
setEncryptConnectionFormat(byte format)
Set the connection format to connect the SMTP
|
void |
setExcelParam(int param)
Deprecated.
please use setExcelParameter(ExcelParameter) to replace this method
|
void |
setExcelParameter(ExcelParameter excelParameter)
Sets the excel parameter, which includes the needed parameter when producing excel files.
|
void |
setExcelParameter(java.lang.String filename,
ExcelParameter excelParameter)
Sets the file name and its parameter to the excel file.
|
void |
setFilename(java.lang.String filename)
Sets the compressed attached file name.
|
void |
setFilenameFmt(java.lang.String filenameFmt)
Stores the zip(template) name for server.
|
void |
setFolder(java.lang.String folder)
Sets the path of the saved files.
|
void |
setForWindows(boolean forWindows)
Deprecated.
please use setTextParameter(TextParameter) to replace this method
|
void |
setHtmlChartImageFormat(int chartImageFormatType)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setHtmlParameter(int type,
HtmlParameter htmlParameter)
Sets the html parameter, which includes the parameter when producing the needed html files.
|
void |
setHtmlParameter(int type,
java.lang.String fileName,
HtmlParameter htmlParameter)
Sets the html parameter and the fileName.
|
void |
setHtmlResolution(int resolution)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setHyperlink(boolean hyperlink)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setIsBiff8(boolean isBiff8)
Deprecated.
please use setExcelParameter(ExcelParameter) to replace this method
|
void |
setKeepHeadFoot(boolean hasHeadFoot)
Deprecated.
please use setTextParameter(TextParameter) to replace this method
|
void |
setLimitSize(long smtpMaxSize)
Sets the total limited file length.
|
void |
setMailFileNameFmt(int format,
java.lang.String fileNameFmt)
Only for inner group to store template name.
|
void |
setMailFormat(int format,
boolean value)
Sets the format of the mail.
|
void |
setMailFrom(java.lang.String from)
Sets the mail address of the sender.
|
void |
setMailTo(java.lang.String rcpt)
Sets the mail address of the recipient.
|
void |
setMultiFileHtml(boolean isMultiFile)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setNoMarginHtml(boolean noMarginHtml)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setNoMarginPDF(boolean noMarginPDF)
Deprecated.
please use setPDFParameters(PDFParameter) to replace this method
|
void |
setNoMarginPS(boolean noMarginPS)
Deprecated.
please use setPSParameter(PSParameter) to replace this method
|
void |
setNoMarginRTF(boolean noMarginRTF)
Deprecated.
please use setRtfParameter(RtfParameter) to replace this method
|
void |
setOnlyDataXML(boolean isOnlyData)
Deprecated.
please use setXmlParameter(XmlParameter) to replace this method
|
void |
setOtherAttachedFile(java.util.Vector other)
Sets another file, like version file or RST file.
|
void |
setOverflowType(int overflowType)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setPageNumber(boolean pageno)
Deprecated.
please use setHtmlParameter(int, HtmlParameter) to replace this method
|
void |
setPDFParameters(PDFParameter pdfParameter)
Sets the PDF parameter, which includes the parameter needed when producing PDF files.
|
void |
setPDFParameters(java.lang.String fileName,
PDFParameter pdfParameter)
Sets the pdf parameter and the file name
|
void |
setPdfPassword(java.lang.String pdfPassword)
Deprecated.
please use setPDFParameters(PDFParameter) to replace this method
|
void |
setPrecise(int format,
int precise)
Sets the flag precision to the format.
|
void |
setPrintModePDF(boolean isPrintMode)
Deprecated.
please use setPDFParameters(PDFParameter) to replace this method
|
void |
setPSParameter(PSParameter psParameter)
Sets the ps parameter, which includes the needed parameter when producing ps files.
|
void |
setPSParameter(java.lang.String fileName,
PSParameter psParameter)
Sets the ps parameter and the fileName.
|
void |
setQuoteMark(boolean quoteMark)
Deprecated.
please use setTextParameter(TextParameter) to replace this method
|
void |
setRepeatText(boolean bRepeat)
Deprecated.
please use setTextParameter(TextParameter) to replace this method
|
void |
setResolution(int resolution)
Deprecated.
please use setTextParameter(TextParameter) to replace this method
|
void |
setRstAsCompressed(boolean isCompress)
Sets the flag that exports the report as compressed format.
|
void |
setRSTFileName(java.lang.String rstFileName)
Sets the RST file name.
|
void |
setRtfParameter(RtfParameter rtfParameter)
Sets the rtf parameter, which includes the needed parameter when producing rtf files.
|
void |
setRtfParameter(java.lang.String fileName,
RtfParameter rtfParameter)
Sets the rtf parameter and the file name.
|
void |
setSendNotice(boolean bSendNotice)
Indicates whether to send a mail to notice user or not.
|
void |
setSentMail(boolean isMailSend)
Indicates whether has sent the mail with attachment.
|
void |
setSubject(java.lang.String subject)
Sets the mail subject.
|
void |
setTableFormatHtml(boolean bUsingTable)
Deprecated.
this function has been removed
|
void |
setTextParameter(int format,
java.lang.String fileName,
TextParameter textParamter)
Sets the text paramter and the file name.
|
void |
setTextParameter(java.lang.String fileName,
TextParameter textParameter)
Deprecated.
please use this method setTextParamter(int, String, TextParameter) to replace it
|
void |
setTextParameter(TextParameter textParameter)
Deprecated.
please use this method setTextParamter(int, String, TextParameter) to replace it
|
void |
setToc(boolean bToc)
Deprecated.
please use setPDFParameters(PDFParameter) to replace this method
|
void |
setToEmailRstNoFileExt(boolean toEmailRstNoFileExt) |
void |
setTransparentImage(boolean isTransparent)
Deprecated.
please use setPDFParameters(PDFParameter) to replace this method
|
void |
setURL(java.lang.String url)
Deprecated.
This method is not used now. Will remove it in next version.
If you have any questions, please contact our sales.
|
void |
setWordWrap(int isWordWrap)
Deprecated.
please use setExcelParameter(ExcelParameter) to replace this method
|
void |
setXmlParameter(java.lang.String fileName,
XmlParameter xmlParameter)
Sets the xml parameter and the fileName.
|
void |
setXmlParameter(XmlParameter xmlParameter)
Sets the xml parameter, which includes the needed parameter when producing xml files.
|
boolean |
setXSDFile(java.lang.String xsdFile)
Deprecated.
please use setXmlParameter(XmlParameter) to replace this method
|
public static final int IE
public static final int NETSCAPE
public static final int VISIBLE
public static final int HIDDEN
public static final int PRECISION_HIGH
The constant indicates that the layout precision is high.
This constant is used by the method setPrecise
.
public static final int PRECISION_LOW
The constant indicates that the layout precision is low.
This constant is used by the method setPrecise
.
public static final int PRECISION_ANY
The constant indicates that the layout precision could be any value, low or high.
This constant is used by the method setPrecise
.
public static final int HTMLMAIL
The constant indicates that the html file is in mail body.
This constant is used by the method setHtmlParameter
and setMailFormat
.
TXTMAIL
public static final int PLAINTXT
The constant indicates that the text format file is the mail attached file.
The file can be in normal text or delimited text by invoking the method
jet.bean.TextParameter.setNormalTextFile(boolean)
. It specifies
which format text would be produced.
This constant is used by the method setTextParameter
and setMailFormat
.
TextParameter
public static final int HTMLFILE
The constant indicates that the html format file is the mail attached file(s)
This constant is used by the method setHtmlParameter
and setMailFormat
.
public static final int PDFFILE
The constant indicates that the Pdf format file is the mail attached file.
This constant is used by the method setMailFormat
.
public static final int RSTFILE
The constant indicates that Rst format file is the mail attached file.
This constant is used by the method setMailFormat
.
public static final int PSFILE
The constant indicates that the postscript format file is the mail attached file.
This constant is used by the method setMailFormat
.
public static final int XLSFILE
The constant indicates that excel format file is the mail attached file.
This constant is used by the method setMailFormat
.
public static final int RTFFILE
The constant indicates that the Rtf format file is the mail attached file
This constant is used by the method setMailFormat
.
public static final int XMLFILE
The constant indicates that the xml format file(s) is the mail attached file.
This constant is used by the method setMailFormat
.
public static final int TXTMAIL
The constant indicates that the Text file in mail body
This constant is used by the method setTextParameter
and setMailFormat
.
HTMLMAIL
public static final byte ENCRYPTED_NONE
public static final byte ENCRYPTED_SSL
public static final byte ENCRYPTED_TLS
public MailInformation()
Constructs a new MailInformation
object
and invokes other setting method to set another needed parameter for exporting to mail.
Note: You must invoke the methods setMailTo(String)
, setCarbonCopy(String)
and setBlindCarbonCopy(String)
to set the mail address.
setMailFrom(String)
,
setMailTo(String)
,
setCarbonCopy(String)
,
setBlindCarbonCopy(String)
,
setSubject(String)
,
setComments(String)
,
setHtmlParameter(int, HtmlParameter)
,
setHtmlParameter(int, String, HtmlParameter)
,
setPDFParameters(PDFParameter)
,
setPDFParameters(String, PDFParameter)
,
setTextParameter(int, String, TextParameter)
,
setPSParameter(PSParameter)
,
setPSParameter(String, PSParameter)
,
setXmlParameter(XmlParameter)
,
setXmlParameter(String, XmlParameter)
,
setExcelParameter(ExcelParameter)
,
setExcelParameter(String, ExcelParameter)
,
setRtfParameter(RtfParameter)
,
setRtfParameter(String, RtfParameter)
public MailInformation(java.lang.String from, java.lang.String rcpt, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String comments)
Constructs a new MailInformation
object with the following
parameters and invokes the following setting method to set the attached file parameter.
from
- the address of the sender.rcpt
- the address of the receipt.cc
- copy to address.bcc
- blind copy to address.subject
- the mail subject.comments
- any text string for memoire.
Note:If the HTMLMAIL format is selected, the comments will be ignored
setHtmlParameter(int, HtmlParameter)
,
setHtmlParameter(int, String, HtmlParameter)
,
setPDFParameters(PDFParameter)
,
setPDFParameters(String, PDFParameter)
,
setTextParameter(int, String, TextParameter)
,
setPSParameter(PSParameter)
,
setPSParameter(String, PSParameter)
,
setXmlParameter(XmlParameter)
,
setXmlParameter(String, XmlParameter)
,
setExcelParameter(ExcelParameter)
,
setExcelParameter(String, ExcelParameter)
,
setRtfParameter(RtfParameter)
,
setRtfParameter(String, RtfParameter)
public MailInformation(java.lang.String from, java.lang.String rcpt, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String comments, boolean archiveCompress, boolean bChartApplet, boolean isMultiFile, boolean bUsingTable, boolean hyperlink, boolean pageno, boolean absolute, boolean bincdrilldownfile, boolean noMarginHtml, int browser, int udchWidth, int udchHeight, int resolution, boolean compress, boolean bRepeat, boolean quoteMark, boolean hasHeadFoot, char delimiter, boolean noMarginPDF, boolean isPrintMode, boolean isTransparent, int isCompressImage, boolean noMarginPS, boolean noMarginRTF, boolean isOnlyData, java.lang.String xsdFile, int isWordWrap, boolean isBiff8, boolean bToc, boolean bDrill, java.lang.String encoding)
from
- the address of the sender.rcpt
- the address of the receipt.cc
- carbon copy to address.bcc
- blind copy to address.subject
- the mail subject.comments
- any text string for memoire.archiveCompress
- indicates whether to use java compress utilities to compress
mail contents.bChartApplet
- creates chart as applet or image in html file.isMultiFile
- generates multi-page or single page html file.bUsingTable
- generates table format html file.hyperlink
- creates hyperlink in html when the html file is in single page format.pageno
- displays page number in html when the html file is in single page format.absolute
- indicates that the font size of the html file is absolute or relative.bincdrilldownfile
- specifies whether to create drilldowned html files.noMarginHtml
- indicates that the exported html file is without page Marginbrowser
- The browser is IE or NETSCAPE.udchWidth
- the width of user defined characters.udchHeight
- the height of user defined characters.resolution
- sets resolution for the text file.compress
- removes empty lines or redundant delimiters in the exported text file.bRepeat
- specifies whether to repeat the same contents in text file.quoteMark
- specifies whether to keep the quote character in standard format text or not.hasHeadFoot
- specifies to include the header and footer object when the text file is mail attached
file.delimiter
- the delimiter used in the SDF(Standard Data Format) format text.noMarginPDF
- indicates that the exported PDF file is without page MarginisPrintMode
- specifies to generate the pdf file using simulated print mode.isTransparent
- specifies to generate the pdf file with transparent gif images.isCompressImage
- indicates the image compress rate to generate the pdf file.noMarginPS
- indicates that the exported Post Script file is without page Margin.noMarginRTF
- indicates that the exported RTF file is without page Margin.isOnlyData
- indicates that only database column information ia added to the XML file, or else all the
detailed information of the report, including all the property values of each report object will be exported.encoding
- mail encodingxsdFile
- outputs the xml file based on the specified xsd.MailInformation()
,
MailInformation(String, String, String, String, String, String)
public final void setAuthencatorMessage(java.lang.String username, java.lang.String passWord, java.lang.String fromAddress)
username
- the user name when logoning SMTP serverpassWord
- the password when logoning SMTPfromAddress
- the user's mail address in this SMTP serverpublic final java.lang.String[] getMailAuthencatorMessage()
public final boolean isAuthencator()
public void setMailFormat(int format, boolean value)
format
- available choices are :
value
- true, sets it as this format, false, cancels it.HTMLMAIL
,
HTMLFILE
,
TXTMAIL
,
PLAINTXT
,
RSTFILE
,
RTFFILE
,
XLSFILE
,
XMLFILE
,
PSFILE
public void setPrecise(int format, int precise)
format
- format for the mail body or the attached fileprecision
- an int
specifying the layout precision;
one of MailInformation.PRECISION_HIGH
,
MailInformation.PRECISION_LOW
, or
MailInformation.PRECISION_ANY
.
the default value is PRECISION_ANYPRECISION_HIGH
,
PRECISION_LOW
,
PRECISION_ANY
public int getPrecise(int format)
format
- format for the mail body or the attached filePRECISION_HIGH
,
PRECISION_LOW
,
PRECISION_ANY
public void setDisableLinkReport(int format, boolean disable)
format
- format for the mail body or the attached filedisable
- true
disable the link report.public boolean isDisableLinkReport(int format)
format
- format for the mail body or the attached filepublic void setMailFileNameFmt(int format, java.lang.String fileNameFmt)
format
- fileNameFmt
- public java.lang.String getMailFileNameFmt(int format)
format
- the attache file formatpublic boolean getMailFormat(int format)
format
- the file format, such as HTMLMAIL....RTFFILEpublic java.lang.String getFileName(int format)
format
- the file format, such as HTMLMAIL....RTFFILEpublic void setMailFrom(java.lang.String from)
from
- the address of the sender.public java.lang.String getMailFrom()
public void setMailTo(java.lang.String rcpt)
rcpt
- the address of the recipient, splitting each address with "," or ";"public java.lang.String getMailTo()
public void setCarbonCopy(java.lang.String cc)
cc
- the address of the carbon copy recipient, splitting each address with "," or ";"public java.lang.String getCarbonCopy()
public void setBlindCarbonCopy(java.lang.String bcc)
bcc
- the address of the blind copy recipient, splitting each address with "," or ";"public java.lang.String getBlindCarbonCopy()
public void setComments(java.lang.String comments)
comments
- any text string for memoirepublic java.lang.String getComments()
public void setSubject(java.lang.String subject)
subject
- the mail subject.public java.lang.String getSubject()
public void setArchiveCompress(boolean archiveCompress)
archiveCompress
- the compress attachment flagpublic boolean isArchiveCompress()
public void setOtherAttachedFile(java.util.Vector other)
other
- hold another attached file(s)public boolean isRSTFile()
public java.lang.String getRSTFileName()
public void setRSTFileName(java.lang.String rstFileName)
rstFileName
- the attached RST file namepublic boolean isCompressedRST()
public void setRstAsCompressed(boolean isCompress)
isCompress
- the flag specifying whether to compress the RST file or notpublic java.util.Vector getOtherAttachedFile()
public void setHtmlParameter(int type, HtmlParameter htmlParameter)
htmlParameter
- the parameter when producing the needed html filestype
- the type should be HTMLFILE or HTMLMAILsetHtmlParameter(int, String, HtmlParameter)
public void setHtmlParameter(int type, java.lang.String fileName, HtmlParameter htmlParameter)
type
- the type will be HTMLFILE or HTMLMAILfileName
- the html fileNamehtmlParameter
- the parameter when producing the needed html filesHtmlParameter
public HtmlParameter getHtmlParameter(int type)
type
- the type will be HTMLFILE or HTMLMAILpublic void setOverflowType(int overflowType)
overflowType
- html text overflow typesetHtmlParameter(int, HtmlParameter)
public void setChartappletHtml(boolean bChartApplet)
setHtmlParameter(int, HtmlParameter)
public void setMultiFileHtml(boolean isMultiFile)
setHtmlParameter(int, HtmlParameter)
public void setTableFormatHtml(boolean bUsingTable)
public void setHyperlink(boolean hyperlink)
setHtmlParameter(int, HtmlParameter)
public void setPageNumber(boolean pageno)
setHtmlParameter(int, HtmlParameter)
public void setAbsoluteFontSize(boolean absolute)
setHtmlParameter(int, HtmlParameter)
public void setDrillDownHtml(boolean bincdrilldownfile)
setHtmlParameter(int, HtmlParameter)
public void setNoMarginHtml(boolean noMarginHtml)
setHtmlParameter(int, HtmlParameter)
public void setBrowser(int browser)
setHtmlParameter(int, HtmlParameter)
public void setHtmlResolution(int resolution)
resolution
- the resolution value of the html file.setHtmlParameter(int, HtmlParameter)
public void setHtmlChartImageFormat(int chartImageFormatType)
setHtmlParameter(int, HtmlParameter)
public void setTextParameter(TextParameter textParameter)
textParameter
- produces the parameter needed for text filessetTextParameter(int, String, TextParameter)
public void setTextParameter(int format, java.lang.String fileName, TextParameter textParamter)
format
- it should be TXTMAIL or PLAINTXTfileName
- the file name of the attached filetextParamter
- the paramter needed when exporting the report to text file
note: If the format is not PLAINTXT or TXTMAIL,
this method can not take affect.PLAINTXT
,
TXTMAIL
,
TextParameter
public void setTextParameter(java.lang.String fileName, TextParameter textParameter)
fileName
- the attached file nametextParameter
- the needed parameter when producing the text filesetTextParameter(int, String, TextParameter)
public TextParameter getTextParameter(int format)
format
- public void setForWindows(boolean forWindows)
setTextParameter(TextParameter)
public void setCharWidth(int udchWidth)
setTextParameter(TextParameter)
public void setCharHeight(int udchHeight)
setTextParameter(TextParameter)
public void setResolution(int resolution)
setTextParameter(TextParameter)
public void setCompressText(boolean compress)
setTextParameter(TextParameter)
public void setRepeatText(boolean bRepeat)
setTextParameter(TextParameter)
public void setQuoteMark(boolean quoteMark)
setTextParameter(TextParameter)
public void setKeepHeadFoot(boolean hasHeadFoot)
setTextParameter(TextParameter)
public void setDelimiter(char delimiter)
setTextParameter(TextParameter)
public void setPDFParameters(PDFParameter pdfParameter)
pdfParameter
- produce the needed parameter for PDF filessetPDFParameters(String, PDFParameter)
public void setPDFParameters(java.lang.String fileName, PDFParameter pdfParameter)
fileName
- the attached file namepdfParameter
- produce the needed parameter for PDF filesPDFParameter
public PDFParameter getPDFParameters()
public void setPdfPassword(java.lang.String pdfPassword)
pdfPassword
- the password stringsetPDFParameters(PDFParameter)
public void setToc(boolean bToc)
bToc
- setPDFParameters(PDFParameter)
public void setDrill(boolean bDrill)
bDrill
- setPDFParameters(PDFParameter)
public void setNoMarginPDF(boolean noMarginPDF)
setPDFParameters(PDFParameter)
public void setPrintModePDF(boolean isPrintMode)
setPDFParameters(PDFParameter)
public void setTransparentImage(boolean isTransparent)
setPDFParameters(PDFParameter)
public void setCompressImage(int isCompressImage)
setPDFParameters(PDFParameter)
public void setPSParameter(PSParameter psParameter)
psParameter
- produce the needed parameter when producing Postscript filessetPSParameter(String, PSParameter)
public void setPSParameter(java.lang.String fileName, PSParameter psParameter)
fileName
- the attached file namepsParameter
- produce the needed parameter when producing Postscript filesPSParameter
public PSParameter getPSParameter()
public void setNoMarginPS(boolean noMarginPS)
setPSParameter(PSParameter)
public void setRtfParameter(RtfParameter rtfParameter)
rtfParameter
- the needed parameter when producing rtf filessetRtfParameter(String, RtfParameter)
public void setRtfParameter(java.lang.String fileName, RtfParameter rtfParameter)
fileName
- the attached file namertfParameter
- the needed parameter when producing rtf filesRtfParameter
public RtfParameter getRtfParameter()
public void setNoMarginRTF(boolean noMarginRTF)
setRtfParameter(RtfParameter)
public void setXmlParameter(XmlParameter xmlParameter)
xmlParameter
- XmlParameter
public void setXmlParameter(java.lang.String fileName, XmlParameter xmlParameter)
fileName
- the attached file namexmlParameter
- the needed parameter when producing xml filessetXmlParameter(String, XmlParameter)
public XmlParameter getXmlParameter()
public void setOnlyDataXML(boolean isOnlyData)
setXmlParameter(XmlParameter)
public boolean setXSDFile(java.lang.String xsdFile)
xsdFile
- setXmlParameter(XmlParameter)
public void setExcelParameter(ExcelParameter excelParameter)
excelParameter
- the needed parameter when producing excel filessetExcelParameter(String, ExcelParameter)
public void setExcelParameter(java.lang.String filename, ExcelParameter excelParameter)
filename
- the attached file nameexcelParameter
- the needed parameter when producing excel filesExcelParameter
public ExcelParameter getExcelParameter()
public void setIsBiff8(boolean isBiff8)
isBiff8
- setExcelParameter(ExcelParameter)
public void setWordWrap(int isWordWrap)
setExcelParameter(ExcelParameter)
public void setExcelParam(int param)
setExcelParameter(ExcelParameter)
public void setEncoding(java.lang.String encoding)
encoding
- encoding name
NOTICE: If the encoding in communicator isn't null, you can not use it.public java.lang.String getEncoding()
public void setFolder(java.lang.String folder)
folder
- directory name
Note: If you invoke this method to set the folder, we would produce
the file(s) into it and store it.public java.lang.String getFolder()
public void setFilename(java.lang.String filename)
filename
- file name without extendpublic java.lang.String getFilename()
public void setFilenameFmt(java.lang.String filenameFmt)
filenameFmt
- the compressed attached file name if you need to compress
the attached filepublic java.lang.String getFilenameFmt()
public void setLimitSize(long smtpMaxSize)
smtpMaxSize
- specifies the max value of length for the attached files. The unit is K.public long getLimitSize()
public void setURL(java.lang.String url)
url
- public java.lang.String getURL()
public void setSendNotice(boolean bSendNotice)
bSendNotice
- if notice user, set true; otherwise, false.public boolean isSendNotice()
public void setSentMail(boolean isMailSend)
isMailSend
- if notice user, set true; otherwise, falsepublic boolean isSentMail()
public void setEncryptConnectionFormat(byte format)
public byte getEncryptConnectionFormat()
public void clear()
public MailInformation copy()
public void setToEmailRstNoFileExt(boolean toEmailRstNoFileExt)
public boolean getToEmailRstNoFileExt()