|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.Filemailer
public class Filemailer
The FileMailer Bean is used to send emails with file attachments.
The bean sends a message (provided in MessageText
) and one
or more file attachments specified in the Attachments
collection
.
The recipients are specified by the SendTo
, Cc
, and BCc
properties, and the message subject by the Subject
property.
Once all the appropriate properties have been set call the Send
method and your message will be sent to its intended
recipient(s).
Other SMTP headers may be specified through the OtherHeaders
property. Information about interaction with the server is
provided via the PITrail
event.
Field Summary | |
---|---|
static int |
amCRAMMD5
|
static int |
amKerberos
|
static int |
amNTLM
|
static int |
amUserPassword
|
static int |
epNonUrgent
|
static int |
epNormal
|
static int |
epUnspecified
|
static int |
epUrgent
|
static int |
esCompanyConfidential
|
static int |
esPersonal
|
static int |
esPrivate
|
static int |
esUnspecified
|
static int |
miHigh
|
static int |
miLow
|
static int |
miNormal
|
static int |
miUnspecified
|
Constructor Summary | |
---|---|
Filemailer()
Creates an instance of Filemailer Bean. |
|
Filemailer(java.lang.String runtimeLicense)
Creates an instance of Filemailer Bean with specified run-time license. |
Method Summary | |
---|---|
void |
addAttachment(java.lang.String fileName)
Adds FileName as an attachment. |
void |
addFilemailerEventListener(FilemailerEventListener l)
|
java.lang.String |
config(java.lang.String configurationString)
Sets or retrieves a configuration setting. |
void |
connect()
Connects to the mail relay and sends the SMTP HELO command. |
void |
disconnect()
Disconnects from the SMTP server. |
void |
doEvents()
Processes events from the internal message queue. |
FileAttachmentList |
getAttachments()
The paths of files to attach to the message. |
int |
getAuthMechanism()
Used when connecting to the mail server. |
java.lang.String |
getBCc()
A comma separated list of addresses for blind carbon copies (optional). |
java.lang.String |
getCc()
A comma separated list of addresses for carbon copies (optional). |
java.lang.String |
getDeliveryNotificationTo()
Email address to send to which to send a delivery notification. |
Firewall |
getFirewall()
A set of properties related to firewall access. |
java.lang.String |
getFrom()
The email address of the sender (required). |
int |
getImportance()
Importance of the mail message (optional). |
java.lang.String |
getLastReply()
The last reply from the server. |
java.lang.String |
getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
int |
getMailPort()
The server port for SMTP (default 25). |
java.lang.String |
getMailServer()
The name or address of a mail server (mail relay). |
java.lang.String |
getMessageDate()
Date of the mail message (optional). |
java.lang.String |
getMessageId()
The Message Identifier for the message. |
MessageRecipientList |
getMessageRecipients()
The collection of recipients of the message. |
java.lang.String |
getMessageText()
The full text of the message to send (without headers). |
java.lang.String |
getOtherHeaders()
An RFC 822 compliant string consisting of extra headers. |
java.lang.String |
getPassword()
A password for logon to the MailServer . |
int |
getPriority()
Priority of the mail message (optional). |
java.lang.String |
getReadReceiptTo()
Email address to send a read receipt to. |
java.lang.String |
getReplyTo()
A mail address to which to reply (optional). |
java.lang.String |
getSendTo()
A comma separated list of addresses for destinations (required). |
int |
getSensitivity()
Sensitivity of the mail message (optional). |
java.lang.String |
getSubject()
The subject of the mail message (optional). |
int |
getTimeout()
A timeout for the bean. |
java.lang.String |
getUser()
A user identifier to login as in the MailServer . |
void |
interrupt()
Interrupt the current method. |
boolean |
isConnected()
Shows whether the bean is connected. |
boolean |
isIdle()
The current status of the component. |
void |
processQueue(java.lang.String queueDir)
Sends the messages which have previously been queued into QueueDir . |
java.lang.String |
queue(java.lang.String queueDir)
Queues the message into QueueDir . |
void |
removeFilemailerEventListener(FilemailerEventListener l)
|
void |
resetHeaders()
Resets all the message headers to empty. |
void |
send()
Sends the current message and MIME encoded attachment. |
void |
setAuthMechanism(int authMechanism)
Used when connecting to the mail server. |
void |
setBCc(java.lang.String BCc)
A comma separated list of addresses for blind carbon copies (optional). |
void |
setCc(java.lang.String cc)
A comma separated list of addresses for carbon copies (optional). |
void |
setCommand(java.lang.String command)
Used to send additional commands directly to the server. |
void |
setConnected(boolean connected)
Shows whether the bean is connected. |
void |
setDeliveryNotificationTo(java.lang.String deliveryNotificationTo)
Email address to send to which to send a delivery notification. |
void |
setFirewall(Firewall firewall)
A set of properties related to firewall access. |
void |
setFrom(java.lang.String from)
The email address of the sender (required). |
void |
setImportance(int importance)
Importance of the mail message (optional). |
void |
setLocalHost(java.lang.String localHost)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
void |
setMailPort(int mailPort)
The server port for SMTP (default 25). |
void |
setMailServer(java.lang.String mailServer)
The name or address of a mail server (mail relay). |
void |
setMessageDate(java.lang.String messageDate)
Date of the mail message (optional). |
void |
setMessageId(java.lang.String messageId)
The Message Identifier for the message. |
void |
setMessageStream(java.io.InputStream messageStream)
Sets the stream to be uploaded to the server as part of the message. |
void |
setMessageText(java.lang.String messageText)
The full text of the message to send (without headers). |
void |
setOtherHeaders(java.lang.String otherHeaders)
An RFC 822 compliant string consisting of extra headers. |
void |
setPassword(java.lang.String password)
A password for logon to the MailServer . |
void |
setPriority(int priority)
Priority of the mail message (optional). |
void |
setReadReceiptTo(java.lang.String readReceiptTo)
Email address to send a read receipt to. |
void |
setReplyTo(java.lang.String replyTo)
A mail address to which to reply (optional). |
void |
setSendTo(java.lang.String sendTo)
A comma separated list of addresses for destinations (required). |
void |
setSensitivity(int sensitivity)
Sensitivity of the mail message (optional). |
void |
setSubject(java.lang.String subject)
The subject of the mail message (optional). |
void |
setTimeout(int timeout)
A timeout for the bean. |
void |
setUser(java.lang.String user)
A user identifier to login as in the MailServer . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int amUserPassword
public static final int amCRAMMD5
public static final int amNTLM
public static final int amKerberos
public static final int miUnspecified
public static final int miHigh
public static final int miNormal
public static final int miLow
public static final int epUnspecified
public static final int epNormal
public static final int epUrgent
public static final int epNonUrgent
public static final int esUnspecified
public static final int esPersonal
public static final int esPrivate
public static final int esCompanyConfidential
Constructor Detail |
---|
public Filemailer()
public Filemailer(java.lang.String runtimeLicense)
Method Detail |
---|
public FileAttachmentList getAttachments()
This property contains the path of a file on your system that you would like to send as an attachment with your message. The bean will open the file and encode its contents in MIME format.
Example (Adding an Attachment)
Control.AddAttachment("C:\\file1.zip")
Control.AddAttachment("C:\\file2.zip")
Control.Send()
or Example (Using Attachments Collection)
Control.Attachments.Add(New nsoftware.IPWorks.FileAttachment("name", "C:\\file.txt"))
This collection is indexed from 0 to size - 1.
public int getAuthMechanism()
The authentication mechanism property to be used when connecting to the mail server.
By default, this property is amUserPassword (0), and if the User
and Password
properties are set, the AUTH command is sent to the
server for authentication. If this property is set to amCRAMMD5 (1), CRAM-MD5
authentication is used instead.
If this property is set to amNTLM (2) NTLM authentication will be used.
If this property is set to amKerberos (6) Kerberos authentication will be used. NOTE: This functionality is only available in Windows.
public void setAuthMechanism(int authMechanism) throws IPWorksException
The authentication mechanism property to be used when connecting to the mail server.
By default, this property is amUserPassword (0), and if the User
and Password
properties are set, the AUTH command is sent to the
server for authentication. If this property is set to amCRAMMD5 (1), CRAM-MD5
authentication is used instead.
If this property is set to amNTLM (2) NTLM authentication will be used.
If this property is set to amKerberos (6) Kerberos authentication will be used. NOTE: This functionality is only available in Windows.
IPWorksException
public java.lang.String getBCc()
This property specifies a comma separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination, but no BCc SMTP header is created containing the destination addresses, so individual recipients never see the list of the other recipients.
The bean will return an error if the MailServer
returns an error code
about any email address specified in SendTo
or Cc
but it will only fire an Error
event if the same happens
with an email address specified in this property.
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
NOTE: You must clear the MessageRecipients
collection
before setting
this property to remove previous recipients.
public void setBCc(java.lang.String BCc) throws IPWorksException
This property specifies a comma separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination, but no BCc SMTP header is created containing the destination addresses, so individual recipients never see the list of the other recipients.
The bean will return an error if the MailServer
returns an error code
about any email address specified in SendTo
or Cc
but it will only fire an Error
event if the same happens
with an email address specified in this property.
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
NOTE: You must clear the MessageRecipients
collection
before setting
this property to remove previous recipients.
IPWorksException
public java.lang.String getCc()
This property specifies a comma separated list of destinations
for carbon copies of the mail message. A copy of the message
is sent to each destination, and a Cc SMTP header is created
containing the destination addresses. This header is sent to every
recipient of the message. If you don't want to copy this information
to every recipient, then use blind carbon copies instead (see the
description of the BCc
).
The bean will return an error if the MailServer
returns an error code
about any email address specified in SendTo
or Cc
but it will only fire an Error
event
if the same happens
with an email address specified in BCc
.
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
NOTE: You must clear the MessageRecipients
collection
before setting
this property to remove previous recipients.
public void setCc(java.lang.String cc) throws IPWorksException
This property specifies a comma separated list of destinations
for carbon copies of the mail message. A copy of the message
is sent to each destination, and a Cc SMTP header is created
containing the destination addresses. This header is sent to every
recipient of the message. If you don't want to copy this information
to every recipient, then use blind carbon copies instead (see the
description of the BCc
).
The bean will return an error if the MailServer
returns an error code
about any email address specified in SendTo
or Cc
but it will only fire an Error
event
if the same happens
with an email address specified in BCc
.
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
NOTE: You must clear the MessageRecipients
collection
before setting
this property to remove previous recipients.
IPWorksException
public void setCommand(java.lang.String command) throws IPWorksException
This property can be used to send additional commands directly to the server. Check the LastReply
property and/or trap the PITrail
events
coming from the server to get the response.
IPWorksException
public boolean isConnected()
This property is used to determine whether or not the bean is connected to the remote host.
public void setConnected(boolean connected) throws IPWorksException
This property is used to determine whether or not the bean is connected to the remote host.
IPWorksException
public java.lang.String getDeliveryNotificationTo()
This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address which should receive the delivery notification.
public void setDeliveryNotificationTo(java.lang.String deliveryNotificationTo) throws IPWorksException
This property contains the email address to send to which to send a delivery notification. When set, a Return-Receipt-To header is added to the message. This property should be set to an email address which should receive the delivery notification.
IPWorksException
public Firewall getFirewall()
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
public void setFirewall(Firewall firewall) throws IPWorksException
This is a Firewall
type property which
contains fields describing the firewall
through which the bean will attempt to connect.
IPWorksException
public java.lang.String getFrom()
This property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
public void setFrom(java.lang.String from) throws IPWorksException
This property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
IPWorksException
public boolean isIdle()
Idle
will be False if the component is currently busy (communicating
and/or waiting for an answer), and True at all other times.
public int getImportance()
This property indicates the importance of the mail message (optional). When set, an Importance header will added to the message.
Importance is an indication to the recipient(s) about how important the message is. The possible values are High (1), Normal (2), and Low (3).
public void setImportance(int importance) throws IPWorksException
This property indicates the importance of the mail message (optional). When set, an Importance header will added to the message.
Importance is an indication to the recipient(s) about how important the message is. The possible values are High (1), Normal (2), and Low (3).
IPWorksException
public java.lang.String getLastReply()
This property indicates the last reply received from the server. It
can be used for informational purposes. The same information
and more can also be retrieved through the PITrail
event.
public java.lang.String getLocalHost()
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
public void setLocalHost(java.lang.String localHost) throws IPWorksException
The LocalHost
property contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.
If the bean is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
IPWorksException
public int getMailPort()
This property contains the server port for SMTP (default 25). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
public void setMailPort(int mailPort) throws IPWorksException
This property contains the server port for SMTP (default 25). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
IPWorksException
public java.lang.String getMailServer()
This property specifies the IP address (IP number in dotted internet format) or Domain Name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.
The current version of the bean does not provide a default
value for the mail relay. You must provide a host name yourself.
Generally, any internet host with an SMTP server will suffice
(a UNIX host for example), but it is preferable to select a MailServer
that is close to the machine sending mail.
If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.
If the bean is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.
public void setMailServer(java.lang.String mailServer) throws IPWorksException
This property specifies the IP address (IP number in dotted internet format) or Domain Name for a mail relay through which messages will be routed. It is set before a connection is attempted and cannot be changed once a connection is in progress.
The current version of the bean does not provide a default
value for the mail relay. You must provide a host name yourself.
Generally, any internet host with an SMTP server will suffice
(a UNIX host for example), but it is preferable to select a MailServer
that is close to the machine sending mail.
If this property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.
If the bean is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.
IPWorksException
public java.lang.String getMessageDate()
If this property contains a non-empty string, then a Date SMTP header is created and attached to the message. If it is an empty string, then the date information is added by the mail relay(s) the message goes through.
Special case: if this property is set to the special value "*", a Date SMTP header reflecting the current date and time is generated when MessageHeaders
is computed and the message is sent. This is the default behavior of the bean
RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".
public void setMessageDate(java.lang.String messageDate) throws IPWorksException
If this property contains a non-empty string, then a Date SMTP header is created and attached to the message. If it is an empty string, then the date information is added by the mail relay(s) the message goes through.
Special case: if this property is set to the special value "*", a Date SMTP header reflecting the current date and time is generated when MessageHeaders
is computed and the message is sent. This is the default behavior of the bean
RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".
IPWorksException
public java.lang.String getMessageId()
This property contains the Message Identifier for the message. When set, the value of MessageId is used as the Message-ID header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.
public void setMessageId(java.lang.String messageId) throws IPWorksException
This property contains the Message Identifier for the message. When set, the value of MessageId is used as the Message-ID header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.
IPWorksException
public MessageRecipientList getMessageRecipients()
This property contains a collection which describes to whom the message is being sent. You may include all recipients in this property, even Cc's and BCc's, which are specified by the type field.
This collection is indexed from 0 to size - 1.
public java.lang.String getMessageText()
This property contains the full text of the message.
It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\\r\\n") . The text in the message lines must contain 7-bit characters so that the message can be successfully pass through the multitude of mail systems on the Internet.
The bean automatically escapes lines that start with a "." by adding another as specified in RFC 821. The message text is unescaped by the receiving agent, so the process is fully transparent.
public void setMessageText(java.lang.String messageText) throws IPWorksException
This property contains the full text of the message.
It is advisable that the text contained in this property be a collection of lines with lengths less than or equal to 80 bytes separated by CRLF ("\\r\\n") . The text in the message lines must contain 7-bit characters so that the message can be successfully pass through the multitude of mail systems on the Internet.
The bean automatically escapes lines that start with a "." by adding another as specified in RFC 821. The message text is unescaped by the receiving agent, so the process is fully transparent.
IPWorksException
public java.lang.String getOtherHeaders()
This property contains a string of headers
to be appended to the message headers created from other
properties like SendTo
, Subject
, etc.
The headers must of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\\r\\n") .
Use this property with caution. If this property contains invalid headers, message delivery might not be successful.
This property is useful for extending the functionality of the bean. A good example is delivery of MIME encoded messages.
SPECIAL CASE: if this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed message headers.
Example (Send an Email With Additional Header)
control.MailServer = "MyServer"
control.From = "me@server.com"
control.SendTo = "recipient@server.com"
control.Subject = "My Subject"
control.MessageText = "This is the message body"
control.OtherHeaders = "HeaderName: Headervalue"
control.Send()
public void setOtherHeaders(java.lang.String otherHeaders) throws IPWorksException
This property contains a string of headers
to be appended to the message headers created from other
properties like SendTo
, Subject
, etc.
The headers must of the format "header: value" as specified in RFC 822. Header lines should be separated by CRLF ("\\r\\n") .
Use this property with caution. If this property contains invalid headers, message delivery might not be successful.
This property is useful for extending the functionality of the bean. A good example is delivery of MIME encoded messages.
SPECIAL CASE: if this property starts with an empty line (CRLF), then the value of this property is used instead of the normally computed message headers.
Example (Send an Email With Additional Header)
control.MailServer = "MyServer"
control.From = "me@server.com"
control.SendTo = "recipient@server.com"
control.Subject = "My Subject"
control.MessageText = "This is the message body"
control.OtherHeaders = "HeaderName: Headervalue"
control.Send()
IPWorksException
public java.lang.String getPassword()
MailServer
.
If this property is set to a non-empty string,
then when connecting to the MailServer
an AUTH or CRAM-MD5 (depending on the value of AuthMechanism
)
command is sent in order to provide authentication
information for the user.
public void setPassword(java.lang.String password) throws IPWorksException
MailServer
.
If this property is set to a non-empty string,
then when connecting to the MailServer
an AUTH or CRAM-MD5 (depending on the value of AuthMechanism
)
command is sent in order to provide authentication
information for the user.
IPWorksException
public int getPriority()
When this property is set, a Priority header will be added to the message. Priority is an indication about the delivery priority of the message. The possible values are epNormal, epUrgent, and epNonUrgent.
public void setPriority(int priority) throws IPWorksException
When this property is set, a Priority header will be added to the message. Priority is an indication about the delivery priority of the message. The possible values are epNormal, epUrgent, and epNonUrgent.
IPWorksException
public java.lang.String getReadReceiptTo()
When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address which should receive the read-receipt.
public void setReadReceiptTo(java.lang.String readReceiptTo) throws IPWorksException
When this property is set, a Disposition-Notification-To header is added to the message. This property should be set to an email address which should receive the read-receipt.
IPWorksException
public java.lang.String getReplyTo()
If this property contains a non-empty string,
a Reply-To SMTP header is created for the message.
This header shows the address to use for replies (useful
if this address is different from the one in From
).
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
public void setReplyTo(java.lang.String replyTo) throws IPWorksException
If this property contains a non-empty string,
a Reply-To SMTP header is created for the message.
This header shows the address to use for replies (useful
if this address is different from the one in From
).
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
IPWorksException
public java.lang.String getSendTo()
This property specifies a comma separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.
Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com
The bean will fail if the MailServer
returns an error code
about any email address specified in SendTo or Cc
but it
will silently ignore the error if the same happens
with an email address specified in BCc
.
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
NOTE: You must clear the MessageRecipients
collection
before setting
this property to remove previous recipients.
public void setSendTo(java.lang.String sendTo) throws IPWorksException
This property specifies a comma separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.
Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com
The bean will fail if the MailServer
returns an error code
about any email address specified in SendTo or Cc
but it
will silently ignore the error if the same happens
with an email address specified in BCc
.
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
NOTE: You must clear the MessageRecipients
collection
before setting
this property to remove previous recipients.
IPWorksException
public int getSensitivity()
This property is an indication of how sensitive it is to disclose the message to people other than the recipients of the message. When set, a Sensitivity header will added to the message. Possible values are: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).
public void setSensitivity(int sensitivity) throws IPWorksException
This property is an indication of how sensitive it is to disclose the message to people other than the recipients of the message. When set, a Sensitivity header will added to the message. Possible values are: esPersonal (1), esPrivate (2), and esCompanyConfidential (3).
IPWorksException
public java.lang.String getSubject()
The string in this property is sent with a Subject SMTP header to the mail recipient.
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
public void setSubject(java.lang.String subject) throws IPWorksException
The string in this property is sent with a Subject SMTP header to the mail recipient.
If the resulting header is longer than MaxHeaderLength
,
then it is folded according to RFC 822 specifications.
IPWorksException
public int getTimeout()
If the Timeout
property is set to 0, all operations
will run uninterrupted until successful completion or an error condition
is encountered.
If Timeout
is set to a positive value, the bean will
wait for the operation to complete before returning control.
The bean will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and remains responsive.
If Timeout
expires, and the operation is not yet complete,
the bean throws an exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of data is successfully sent or received.
Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum
of Timeout
seconds since the beginning of the operation, without
extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
public void setTimeout(int timeout) throws IPWorksException
If the Timeout
property is set to 0, all operations
will run uninterrupted until successful completion or an error condition
is encountered.
If Timeout
is set to a positive value, the bean will
wait for the operation to complete before returning control.
The bean will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and remains responsive.
If Timeout
expires, and the operation is not yet complete,
the bean throws an exception.
Please note that by default, all timeouts are inactivity timeouts ,
i.e. the timeout period is extended by Timeout
seconds when
any amount of data is successfully sent or received.
Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum
of Timeout
seconds since the beginning of the operation, without
extending the timeout period during communications.
This behavior is controlled by the AbsoluteTimeout
configuration setting.
The default value for the Timeout
property is 60 (seconds).
IPWorksException
public java.lang.String getUser()
MailServer
.
If this property is set to a non-empty string,
then when connecting to the MailServer
an AUTH or CRAM-MD5 (depending on the value of AuthMechanism
)
command is sent in order to provide authentication
information for the user.
public void setUser(java.lang.String user) throws IPWorksException
MailServer
.
If this property is set to a non-empty string,
then when connecting to the MailServer
an AUTH or CRAM-MD5 (depending on the value of AuthMechanism
)
command is sent in order to provide authentication
information for the user.
IPWorksException
public void addAttachment(java.lang.String fileName) throws IPWorksException
This method adds the file name as an attachment, the full list of attachments is contained in the Attachments
property.
Example (Adding an Attachment)
Control.AddAttachment("C:\\file1.zip")
Control.AddAttachment("C:\\file2.zip")
Control.Send()
or Example (Using Attachments Collection)
Control.Attachments.Add(New nsoftware.IPWorks.FileAttachment("name", "C:\\file.txt"))
IPWorksException
public java.lang.String config(java.lang.String configurationString) throws IPWorksException
Config
is a generic method available in every bean.
It is used to set and retrieve configuration settings
for the
bean.
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the bean, access to these internal properties is provided through the Config
method.
To set a configuration setting named PROPERTY , you must call Config("PROPERTY=VALUE") , where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY") . The value will be returned as a string.
The bean accepts one or more of the following configuration settings .
Configuration settings are similar in functionality to properties,
but they are rarely used. In order to avoid "polluting" the property
namespace of the bean, access to these internal properties is provided through the Config
method.
MessageText
) part header. The default value is "" (empty string) in which case the charset
attribute will not be added to the Content-Type header.MessageText
properties will be encoded using the specified
encoding. The "Content-Transfer-Encoding" header will also be set for the plain text part. The following
encodings are supported:
Attachments
array property. Valid array indices are from 0 to AttachmentCount - 1. To set the Content-Type for the attachment
at index 2 you would set the string "AttachmentType[2]=application/octet-stream".
SendTo
property is required to send a message. If AllowEmptyTo is True,
then this is not the case, and messages can be sent with just one or both of Cc
and BCc
set.
MailServer
at connection time as an
argument to the SMTP HELO command. This generally identifies the host sending mail, and that's
why the Hello property defaults to the name of the local host. The property is provided in case
the bean does not accept the default value and a custom value (such as, for example, a fully
qualified domain name) must be sent.If AllowExtensions
is true the EHLO command will be sent instead of the HELO command.
ProcessQueue
deletes queued files after processing them. If KeepQueue is True,
the file extension is instead changed to ".sent" and the files are not deleted.
OtherHeaders
property. This setting is exposed here for use by beans that
inherit from SMTP.ReturnPath
property. This setting is exposed here for use by beans that
inherit from SMTP.
FirewallHost
is given, requested connections will be authenticated through the specified firewall
when connecting.If the FirewallHost
setting is set to a Domain Name, a DNS request is initiated. Upon successful termination
of the request, the FirewallHost
setting is set to the corresponding address. If the search is not successful,
an error is returned.
NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.
RemoteHost
and RemotePort
are used to tell the SOCKS firewall
in which address and port to listen to. The firewall rules may ignore RemoteHost
, and it is recommended that RemoteHost
be set to empty string in this case.
RemotePort
is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The
binding (address and port) is provided through the ConnectionStatus
event.
The connection to the firewall is made by calling the Connect
method.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
settings
are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallPort
is set automatically when FirewallType
is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallPort
is set to 80.
FirewallPort
is set to 1080.
FirewallPort
is set to 1080.
FirewallHost
is specified, the FirewallUser
and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.
TCPKeepAlive
will automatically be set to true.
By default the operating system will determine the
time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many
cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.
TCPKeepAlive
will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime
. If no acknowledgement is received from the remote host the keep-alive packet
will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.
LingerTime
is 0 (default), the
system will attempt to send pending data for a connection until the default
IP protocol timeout expires.
In the second scenario, LingerTime
is a positive value, the system will
attempt to send pending data until the specified LingerTime
is reached.
If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.
LocalHost
setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.In multi-homed hosts (machines with more than one IP interface)
setting LocalHost to the value of an interface will make the
bean initiate connections (or accept in the case of server
beans) only through that interface.
If the bean is connected, the LocalHost
setting shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multi-homed
hosts (machines with more than one IP interface).
LocalPort
after the connection is established.
LocalPort
cannot be changed once a connection is made.
Any attempt to set this when a connection is active will
generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
MaxLineLength
is the size of an internal buffer, which holds received data while waiting for an EOL
string.If an EOL
string is found in the input stream before MaxLineLength
bytes are received, the DataIn
event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL
is found, and MaxLineLength
bytes are accumulated in the buffer, the DataIn
event is
fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength
is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.
KeepAliveTime
and KeepAliveInterval
to
configure the timing of the keep-alive packets.Note: This value is not applicable in Java.
IPWorksException
public void connect() throws IPWorksException
This method connects to the mail relay and sends the SMTP HELO command, thus
preparing for sending messages. Any number of messages can later be sent
using the Send
method.
Example (Connect and Send an Email)
control.MailServer = "MyServer"
control.From = "me@server.com"
control.SendTo = "recipient@server.com"
control.Subject = "My Subject"
control.MessageText = "This is the message body"
control.Connect()
control.Send()
control.Disconnect()
IPWorksException
public void disconnect() throws IPWorksException
This method disconnects from the mail relay.
IPWorksException
public void doEvents() throws IPWorksException
When DoEvents
is called, the bean processes any
available events. If no events are available, it waits for a
preset period of time, and then returns.
IPWorksException
public void interrupt() throws IPWorksException
If there is no method in progress, Interrupt
simply returns, doing nothing.
IPWorksException
public void processQueue(java.lang.String queueDir) throws IPWorksException
This method sends the messages which have previously been queued into QueueDir . The PITrail
event shows the interaction with the server as
messages as are processed.
This method looks in the directory for files with extension ".queued" and starts processing them.
When processing starts, the file extension is changed to ".sending". If an error happens at this stage, the sending process is aborted, and the file extension is changed to ".failed".
If the file is successfully sent, the file is normally deleted, unless
the KeepQueue
configuration setting is set to True, in
which case the file extension is instead changed to ".sent" and the queue
file is not deleted.
IPWorksException
public java.lang.String queue(java.lang.String queueDir) throws IPWorksException
This method queues the message into QueueDir . The message is queued into a unique file into the directory QueueDir for future processing.
QueueDir must already exist, or an error will be generated.
The method returns the name of the unique queue file created in QueueDir . The file extension is ".queued".
Please refer to the ProcessQueue
method for more information on email queue
processing.
IPWorksException
public void resetHeaders() throws IPWorksException
This method resets all the message headers to "" (empty string). Use this method before creating a new message, so that headers from the previous message are not carried over to the next one.
IPWorksException
public void send() throws IPWorksException
This method sends the current message and MIME encoded attachment. If the bean is not connected to the mail relay, a connection is created, the message is sent, and then the connection is closed unless an error occurs.
If the bean is already connected (by use of the Connect
method), the
connection will remain open after the message is sent. To disconnect, call the Disconnect
method.
IPWorksException
public void setMessageStream(java.io.InputStream messageStream) throws IPWorksException
This method sets the stream to be uploaded to the server as part of the message. If an upload stream is set before the Send
method is called, the content of the stream will be read by the bean and uploaded to the server; The stream should be open and normally set to position 0.
The bean will automatically close this stream if CloseStreamAfterTransfer
is set to true (default). If the stream is closed, you will need to call this method again before calling Send
again.
The content of the stream will be read from the current position all the way to the end.
Note: This method and LocalFile
will reset the other.
IPWorksException
public void addFilemailerEventListener(FilemailerEventListener l) throws java.util.TooManyListenersException
java.util.TooManyListenersException
public void removeFilemailerEventListener(FilemailerEventListener l)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |