IP*Works!

ipworks
Class Imap

java.lang.Object
  |
  +--ipworks.Imap

public class Imap
extends java.lang.Object

The IMAP control is used to communicate with IMAP servers using the IMAP (Internet Message Access) protocol.

The IMAP control implements a standard IMAP client as specified in RFC 1730 and RFC 2060.

The first step in using the control is specifying a MailServer , a User to connect as, and a Password to authenticate with. After that, one or more requests may be sent to the server via the control's methods or by setting a corresponding Action . Results are retrieved through events and a number of key properties.

Normally, after connecting to the server, a Mailbox is selected (or examined) using the ExamineMailbox method or setting the corresponding Action code. After the Mailbox is selected, MessageCount and RecentMessageCount show the number of messages in the mailbox, and MailboxFlags show the flags pertaining to the mailbox.

A number of operations may be performed by the server in response to commands sent via the control's methods or the Action property. The main arguments for most commands is the Mailbox property or the MessageSet property. The MessageSet property denotes either a single message, or a range of messages. Other arguments are specified through other properties such as SearchCriteria , MessageFlags , etc.

Responses are received through events such as MessageInfo , MailboxList , and also reflected to properties such as MessageText , MessageSubject , etc.

The MessagePart event describes the MIME structure of retrieved messages. One MessagePart event is fired for every message part, giving information about the particular part. Later on, message parts may be retrieved separately through the FetchMessagePart method or appropriate Action . This speeds up processing, by avoiding the need to retrieve full messages from the server.

The PITrail event traces the interaction between the client and the server. It includes all exchanges except for transfers of messages, message parts, and message headers.


Field Summary
static int fwNone
           
static int fwSOCKS4
           
static int fwSOCKS5
           
static int fwTunnel
           
static int imapAppendToMailbox
           
static int imapCheckMailbox
           
static int imapCloseMailbox
           
static int imapConnect
           
static int imapCopyToMailbox
           
static int imapCreateMailbox
           
static int imapDeleteMailbox
           
static int imapDisconnect
           
static int imapExamineMailbox
           
static int imapExpungeMailbox
           
static int imapGetMessageHeaders
           
static int imapGetMessageInfo
           
static int imapGetMessagePart
           
static int imapGetMessageText
           
static int imapIdle
           
static int imapListMailboxes
           
static int imapListSubscribedMailboxes
           
static int imapNoop
           
static int imapRenameMailbox
           
static int imapResetMessageFlags
           
static int imapSearchMailbox
           
static int imapSelectMailbox
           
static int imapSetMessageFlags
           
static int imapSubscribeMailbox
           
static int imapUnsetMessageFlags
           
static int imapUnsubscribeMailbox
           
 
Constructor Summary
Imap()
           
 
Method Summary
 void addImapEventListener(ImapEventListener l)
           
 void addMessageFlags(java.lang.String flags)
          Add the specified flags to the messages specified by MessageSet .
 void appendToMailbox()
          Appends the message in MessageText to the mailbox specified by Mailbox .
 void checkMailbox()
          Sends a 'CHECK' command to the server.
 void closeMailbox()
          Remove all messages marked with 'Deleted' flag from the currently selected mailbox and unselect mailbox.
 void connect()
          Connect to an IMAP server.
 void copyToMailbox()
          Copies the messages specified by MessageSet to the mailbox specified by Mailbox .
 void createMailbox()
          Create a new mailbox specified by Mailbox .
 void deleteMailbox()
          Delete a mailbox specified by Mailbox .
 void disconnect()
          Disconnect from an IMAP server.
 void examineMailbox()
          Select a Mailbox (Read-only mode).
 void expungeMailbox()
          Remove all messages marked with 'Deleted' flag from the currently selected mailbox.
 void fetchMessageHeaders()
          Get the message headers of messages specified by the MessageSet property.
 void fetchMessageInfo()
          Get information about messages specified by the MessageSet property.
 void fetchMessagePart()
          Get a message part specified by PartId .
 void fetchMessageText()
          Get the message text of messages specified by the MessageSet property.
 void fireEndTransfer()
          Fired when the message or the part data finishes transferring.
 void fireError(int errorCode, java.lang.String description)
          Information about errors during data delivery.
 void fireMailboxList(java.lang.String mailbox, java.lang.String separator, java.lang.String flags)
          Fired for each mailbox received through the various imapListMailbox actions.
 void fireMessageInfo(java.lang.String messageId, java.lang.String subject, java.lang.String messageDate, java.lang.String from, java.lang.String flags, int size)
          Fired with information for the message(s) retrieved by the server.
 void fireMessagePart(java.lang.String partId, int size, java.lang.String contentType, java.lang.String filename, java.lang.String contentEncoding, java.lang.String parameters, java.lang.String multipartMode)
          Fired for each message part when an imapGetMessageInfo action is performed.
 void firePITrail(int direction, java.lang.String message)
          Traces the commands sent to the mail server, and the respective replies.
 void fireStartTransfer()
          Fired when the message or the part data starts transferring.
 void fireTransfer(int bytesTransferred, java.lang.String text)
          Fired while the message gets transferred from the MailServer .
 int getAction()
          An action code for the component.
 int getEndByte()
          The byte index where to end the transfer.
 byte[] getFirewallData()
          Used to send other data to firewall.
 java.lang.String getFirewallHost()
          Name or IP address of firewall (optional).
 java.lang.String getFirewallPassword()
          A password if authentication is to be used connecting through the firewall.
 int getFirewallPort()
          Port of the firewall to connect to.
 int getFirewallType()
          Determines the type of firewall to connect through.
 java.lang.String getFirewallUser()
          A user name if authentication is to be used connecting through a firewall.
 java.lang.String getLastReply()
          The last reply from the server.
 java.lang.String getLocalFile()
          The path to a local file for downloading the message body.
 java.lang.String getLocalHost()
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 java.lang.String getMailbox()
          Name of the mailbox selected on the server.
 java.lang.String getMailboxFlags()
          Defined flags in the selected mailbox.
 int getMailPort()
          The port of the IMAP server (default is 143).
 java.lang.String getMailServer()
          The name or address of the mail server (IMAP server).
 java.lang.String getMessageBCc(int addressIndex)
          Array property with the list of BCc recipients of the message.
 java.lang.String getMessageCc(int addressIndex)
          Array property with the list of Cc recipients of the message.
 java.lang.String getMessageContentEncoding()
          The ContentEncoding of the selected message.
 java.lang.String getMessageContentType()
          The ContentType of the message.
 int getMessageCount()
          The total number of messages on the Mailbox .
 java.lang.String getMessageDate()
          The time the message was created.
 java.lang.String getMessageDeliveryTime()
          The time the message was delivered to the mail server.
 java.lang.String getMessageFlags()
          Flags of the current message.
 java.lang.String getMessageFrom()
          The address of the author of the message.
 java.lang.String getMessageHeaders()
          RFC822-encoded headers of the message.
 java.lang.String getMessageId()
          The message id of the current message.
 java.lang.String getMessageInReplyTo()
          The unique message ID of the message this one is in reply to.
 java.lang.String getMessageNetId()
          The globally unique id of the message.
 java.lang.String getMessageReplyTo()
          Email address(s) where replies to the message should be sent.
 java.lang.String getMessageSender()
          The address of the sender of the message.
 java.lang.String getMessageSet()
          The set of messages to operate on.
 int getMessageSize()
          The size of the selected message.
 java.lang.String getMessageSubject()
          The subject of the message.
 java.lang.String getMessageText()
          The body of the retrieved message The control fills out MessageText with the contents of the message body (in RFC822 format) when an imapGetMessageText operation is triggered via the Action property.
 java.lang.String getMessageTo(int addressIndex)
          Array property with the list of direct recipients of the message.
 java.lang.String getNewMailbox()
          The new name of the mailbox during an imapRenameMailbox operation.
 java.lang.String getPartId()
          The PartId of the part to retrieve.
 java.lang.String getPassword()
          The password used to authenticate to the MailServer .
 int getRecentMessageCount()
          Number of new messages on the Mailbox .
 java.lang.String getSearchCriteria()
          Search criteria to use for search operations.
 int getStartByte()
          The byte index where to start the transfer from.
 int getTimeout()
          A timeout for the component.
 java.lang.String getUser()
          The user name used to authenticate to the MailServer .
 void interrupt()
          Interrupt the Action in progress (if any).
 boolean isConnected()
          Shows whether the component is connected.
 boolean isPeekMode()
          When set to True, the message Seen flag is not changed during reading.
 boolean isUIDMode()
          If true, permanent message id-s are used instead of the default temporary id-s.
 void listMailboxes()
          List all mailboxes matching all criteria in the Mailbox property.
 void listSubscribedMailboxes()
          List all subscribed mailboxes matching all criteria in the Mailbox property.
 void noop()
          Sends a 'NOOP' command to the server.
 void removeImapEventListener(ImapEventListener l)
           
 void renameMailbox()
          Change the name of Mailbox to NewMailbox .
 void resetMessageFlags()
          Replace the flags of the messages specified by MessageSet with the flags specified by MessageFlags .
 void searchMailbox()
          Search selected mailbox for specified text.
 void selectMailbox()
          Select a Mailbox.
 void setAction(int action)
          An action code for the component.
 void setCommand(java.lang.String command)
          Can be used to send additional commands directly to the IMAP server.
 void setEndByte(int endByte)
          The byte index where to end the transfer.
 void setFirewallData(byte[] firewallData)
          Used to send other data to firewall.
 void setFirewallHost(java.lang.String firewallHost)
          Name or IP address of firewall (optional).
 void setFirewallPassword(java.lang.String firewallPassword)
          A password if authentication is to be used connecting through the firewall.
 void setFirewallPort(int firewallPort)
          Port of the firewall to connect to.
 void setFirewallType(int firewallType)
          Determines the type of firewall to connect through.
 void setFirewallUser(java.lang.String firewallUser)
          A user name if authentication is to be used connecting through a firewall.
 void setLocalFile(java.lang.String localFile)
          The path to a local file for downloading the message body.
 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 setMailbox(java.lang.String mailbox)
          Name of the mailbox selected on the server.
 void setMailPort(int mailPort)
          The port of the IMAP server (default is 143).
 void setMailServer(java.lang.String mailServer)
          The name or address of the mail server (IMAP server).
 void setMessageFlags(java.lang.String messageFlags)
          Flags of the current message.
 void setMessageHeaders(java.lang.String messageHeaders)
          RFC822-encoded headers of the message.
 void setMessageSet(java.lang.String messageSet)
          The set of messages to operate on.
 void setMessageText(java.lang.String messageText)
          The body of the retrieved message The control fills out MessageText with the contents of the message body (in RFC822 format) when an imapGetMessageText operation is triggered via the Action property.
 void setNewMailbox(java.lang.String newMailbox)
          The new name of the mailbox during an imapRenameMailbox operation.
 void setPartId(java.lang.String partId)
          The PartId of the part to retrieve.
 void setPassword(java.lang.String password)
          The password used to authenticate to the MailServer .
 void setPeekMode(boolean peekMode)
          When set to True, the message Seen flag is not changed during reading.
 void setSearchCriteria(java.lang.String searchCriteria)
          Search criteria to use for search operations.
 void setStartByte(int startByte)
          The byte index where to start the transfer from.
 void setTimeout(int timeout)
          A timeout for the component.
 void setUIDMode(boolean UIDMode)
          If true, permanent message id-s are used instead of the default temporary id-s.
 void setUser(java.lang.String user)
          The user name used to authenticate to the MailServer .
 void subscribeMailbox()
          Subscribe to the mailbox specified by Mailbox .
 void unsetMessageFlags()
          Remove the flags specified by MessageFlags from the messages specified by MessageSet .
 void unsubscribeMailbox()
          Unsubscribe from the mailbox specified by Mailbox .
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

imapIdle

public static final int imapIdle

imapNoop

public static final int imapNoop

imapConnect

public static final int imapConnect

imapDisconnect

public static final int imapDisconnect

imapSelectMailbox

public static final int imapSelectMailbox

imapExamineMailbox

public static final int imapExamineMailbox

imapCreateMailbox

public static final int imapCreateMailbox

imapDeleteMailbox

public static final int imapDeleteMailbox

imapRenameMailbox

public static final int imapRenameMailbox

imapSearchMailbox

public static final int imapSearchMailbox

imapAppendToMailbox

public static final int imapAppendToMailbox

imapCopyToMailbox

public static final int imapCopyToMailbox

imapCheckMailbox

public static final int imapCheckMailbox

imapExpungeMailbox

public static final int imapExpungeMailbox

imapCloseMailbox

public static final int imapCloseMailbox

imapListMailboxes

public static final int imapListMailboxes

imapListSubscribedMailboxes

public static final int imapListSubscribedMailboxes

imapSubscribeMailbox

public static final int imapSubscribeMailbox

imapUnsubscribeMailbox

public static final int imapUnsubscribeMailbox

imapGetMessageInfo

public static final int imapGetMessageInfo

imapGetMessageHeaders

public static final int imapGetMessageHeaders

imapGetMessageText

public static final int imapGetMessageText

imapGetMessagePart

public static final int imapGetMessagePart

imapResetMessageFlags

public static final int imapResetMessageFlags

imapSetMessageFlags

public static final int imapSetMessageFlags

imapUnsetMessageFlags

public static final int imapUnsetMessageFlags

fwNone

public static final int fwNone

fwTunnel

public static final int fwTunnel

fwSOCKS4

public static final int fwSOCKS4

fwSOCKS5

public static final int fwSOCKS5
Constructor Detail

Imap

public Imap()
Method Detail

getAction

public int getAction()
An action code for the component. Setting the Action property to a valid action code makes the control perform the associated action. If the action completes successfully, execution continues normally, and Action is reset to 0 (Idle). If an error happens, then an IPWorksException exception is raised.

Each action sends a command to the server, and waits until a reply is received. If there is no connection to the server, a connection is established automatically using the imapConnect action below.

The following are the possible values for the Action property and the corresponding descriptions:

imapIdle (0)
Default action. It can also be used to interrupt the current operation.
imapNoop (1)
Sends an IMAP 'NOOP' command to the server. This is useful when the connection needs to be kept alive for long periods of time. (Normally, servers break the connection automatically after 30 minutes of inactivity).
imapConnect (2)
Connect to the IMAP server specified by MailServer and authenticate using the user name and password supplied in the User and Password properties.
imapDisconnect(3)
Logout and disconnect from the IMAP server.
imapSelectMailbox(4)
Ask the server to select the mailbox specified in the Mailbox property. The mailbox is selected in read/write mode (if the server permits).
imapExamineMailbox(5)
Ask the server to select the mailbox specified in the Mailbox property in read-only mode.
imapCreateMailbox(6)
Create a new mailbox. The mailbox name is specified by the Mailbox property.
imapDeleteMailbox (7)
Delete a mailbox. The mailbox name is specified by the Mailbox property.
imapRenameMailbox (8)
Rename a mailbox. The mailbox is specified by the Mailbox property, and the new name is specified by the NewMailbox property.
imapSearchMailbox (9)
Search the selected mailbox using the criteria specified in the SearchCriteria property. For every message matching the criteria, the equivalent of a imapGetMessageInfo action is performed and a MessageInfo event is fired. For more information about the format of the search criteria, please refer to the SearchCriteria property.
imapAppendToMailbox (10)
Appends the RFC822-encoded message in MessageText to the mailbox specified by Mailbox . If the MessageFlags property is not an empty string, it's contents are supplied with the 'APPEND' command sent to the server.
imapCopyToMailbox (11)
Copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.
imapCheckMailbox (12)
Sends a 'CHECK' command to the server, asking it to perform any neccessary 'housekeeping' operations on, and update the state of the currently selected mailbox.
imapExpungeMailbox (13)
Permanently remove all messages that have the 'Deleted' flag set from the current (selected) mailbox.
imapCloseMailbox (14)
Permanently remove all messages that have the 'Deleted' flag set from the current (selected) mailbox, and then close (deselect) the mailbox.
imapListMailboxes (15)
List all mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through the MailboxList event.
imapListSubscribedMailboxes (16)
List all subscribed mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through MailboxList event.
imapSubscribeMailbox (17)
Subscribe to the mailbox specified by the Mailbox property.
imapUnsubscribeMailbox (18)
Unsubscribe from the mailbox specified by the Mailbox property.
imapGetMessageInfo (19)
Retrieves message information for the messages specified by the MessageSet property. This includes information about the message envelope as well as message structure. Every time a message envelope is retrieved, a MessageInfo event is fired, and message envelope information is stored in properties such as: MessageSubject , MessageFrom , MessageTo , MessageCc , etc.. If the message is a multipart message, one or more MessagePart events are fired before the MessageInfo event - one for each message part.
imapGetMessageHeaders (20)
Retrieves RFC822 headers of the message specified by MessageSet and stores them in the MessageHeaders property.
imapGetMessageText (21)
Retrieves the RFC822-encoded text of the message specified by MessageSet . If the LocalFile property contains a file name, the text is stored in LocalFile , and the Transfer events denote the progress. If the LocalFile property contains an empty string, the text is stored in the MessageText property, as well as provided through the Transfer event.
imapGetMessagePart (22)
Retrieves the contents message part specified by the PartId property of the message specified by the MessageSet property. If the LocalFile property contains a file name, the message part is stored in LocalFile , and the Transfer events denote the progress. If the LocalFile property contains an empty string, the message part is stored in the MessageText property, as well as provided through the Transfer event.
imapResetMessageFlags (23)
Replace the flags of the messages specified by the MessageSet property with the flags specified by the MessageFlags property. The format of the flags is specified by the IMAP RFCs.
imapSetMessageFlags (24)
Add the flags specified by the MessageFlags property to the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.
imapUnsetMessageFlags (25)
Remove the flags specified by the MessageFlags property from the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.


setAction

public void setAction(int action)
               throws IPWorksException
An action code for the component. Setting the Action property to a valid action code makes the control perform the associated action. If the action completes successfully, execution continues normally, and Action is reset to 0 (Idle). If an error happens, then an IPWorksException exception is raised.

Each action sends a command to the server, and waits until a reply is received. If there is no connection to the server, a connection is established automatically using the imapConnect action below.

The following are the possible values for the Action property and the corresponding descriptions:

imapIdle (0)
Default action. It can also be used to interrupt the current operation.
imapNoop (1)
Sends an IMAP 'NOOP' command to the server. This is useful when the connection needs to be kept alive for long periods of time. (Normally, servers break the connection automatically after 30 minutes of inactivity).
imapConnect (2)
Connect to the IMAP server specified by MailServer and authenticate using the user name and password supplied in the User and Password properties.
imapDisconnect(3)
Logout and disconnect from the IMAP server.
imapSelectMailbox(4)
Ask the server to select the mailbox specified in the Mailbox property. The mailbox is selected in read/write mode (if the server permits).
imapExamineMailbox(5)
Ask the server to select the mailbox specified in the Mailbox property in read-only mode.
imapCreateMailbox(6)
Create a new mailbox. The mailbox name is specified by the Mailbox property.
imapDeleteMailbox (7)
Delete a mailbox. The mailbox name is specified by the Mailbox property.
imapRenameMailbox (8)
Rename a mailbox. The mailbox is specified by the Mailbox property, and the new name is specified by the NewMailbox property.
imapSearchMailbox (9)
Search the selected mailbox using the criteria specified in the SearchCriteria property. For every message matching the criteria, the equivalent of a imapGetMessageInfo action is performed and a MessageInfo event is fired. For more information about the format of the search criteria, please refer to the SearchCriteria property.
imapAppendToMailbox (10)
Appends the RFC822-encoded message in MessageText to the mailbox specified by Mailbox . If the MessageFlags property is not an empty string, it's contents are supplied with the 'APPEND' command sent to the server.
imapCopyToMailbox (11)
Copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.
imapCheckMailbox (12)
Sends a 'CHECK' command to the server, asking it to perform any neccessary 'housekeeping' operations on, and update the state of the currently selected mailbox.
imapExpungeMailbox (13)
Permanently remove all messages that have the 'Deleted' flag set from the current (selected) mailbox.
imapCloseMailbox (14)
Permanently remove all messages that have the 'Deleted' flag set from the current (selected) mailbox, and then close (deselect) the mailbox.
imapListMailboxes (15)
List all mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through the MailboxList event.
imapListSubscribedMailboxes (16)
List all subscribed mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through MailboxList event.
imapSubscribeMailbox (17)
Subscribe to the mailbox specified by the Mailbox property.
imapUnsubscribeMailbox (18)
Unsubscribe from the mailbox specified by the Mailbox property.
imapGetMessageInfo (19)
Retrieves message information for the messages specified by the MessageSet property. This includes information about the message envelope as well as message structure. Every time a message envelope is retrieved, a MessageInfo event is fired, and message envelope information is stored in properties such as: MessageSubject , MessageFrom , MessageTo , MessageCc , etc.. If the message is a multipart message, one or more MessagePart events are fired before the MessageInfo event - one for each message part.
imapGetMessageHeaders (20)
Retrieves RFC822 headers of the message specified by MessageSet and stores them in the MessageHeaders property.
imapGetMessageText (21)
Retrieves the RFC822-encoded text of the message specified by MessageSet . If the LocalFile property contains a file name, the text is stored in LocalFile , and the Transfer events denote the progress. If the LocalFile property contains an empty string, the text is stored in the MessageText property, as well as provided through the Transfer event.
imapGetMessagePart (22)
Retrieves the contents message part specified by the PartId property of the message specified by the MessageSet property. If the LocalFile property contains a file name, the message part is stored in LocalFile , and the Transfer events denote the progress. If the LocalFile property contains an empty string, the message part is stored in the MessageText property, as well as provided through the Transfer event.
imapResetMessageFlags (23)
Replace the flags of the messages specified by the MessageSet property with the flags specified by the MessageFlags property. The format of the flags is specified by the IMAP RFCs.
imapSetMessageFlags (24)
Add the flags specified by the MessageFlags property to the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.
imapUnsetMessageFlags (25)
Remove the flags specified by the MessageFlags property from the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.


setCommand

public void setCommand(java.lang.String command)
                throws IPWorksException
Can be used to send additional commands directly to the IMAP server. Setting the Command property directs the control to send the assigned command to the MailServer . Check the LastReply property and/or trap the PITrail events comming from the server to get the response(s).


isConnected

public boolean isConnected()
Shows whether the component is connected. Use this property to determine whether the control is connected to the remote host or not.


getEndByte

public int getEndByte()
The byte index where to end the transfer. When StartByte or EndByte contain values other than the defaults (0), only the corresponding portion of the message part is retrieved from the server.

Byte indexes start from 1. The default value for EndByte is 0 corresponding with the end of the message.


setEndByte

public void setEndByte(int endByte)
                throws IPWorksException
The byte index where to end the transfer. When StartByte or EndByte contain values other than the defaults (0), only the corresponding portion of the message part is retrieved from the server.

Byte indexes start from 1. The default value for EndByte is 0 corresponding with the end of the message.


getFirewallData

public byte[] getFirewallData()
Used to send other data to firewall. When the firewall is a tunneling proxy, use this property to to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).


setFirewallData

public void setFirewallData(byte[] firewallData)
                     throws IPWorksException
Used to send other data to firewall. When the firewall is a tunneling proxy, use this property to to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).


getFirewallHost

public java.lang.String getFirewallHost()
Name or IP address of firewall (optional). If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.


setFirewallHost

public void setFirewallHost(java.lang.String firewallHost)
                     throws IPWorksException
Name or IP address of firewall (optional). If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the FirewallHost property is set to the corresponding address. If the search is not successful, an error is returned.


getFirewallPassword

public java.lang.String getFirewallPassword()
A password if authentication is to be used connecting through the firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


setFirewallPassword

public void setFirewallPassword(java.lang.String firewallPassword)
                         throws IPWorksException
A password if authentication is to be used connecting through the firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


getFirewallPort

public int getFirewallPort()
Port of the firewall to connect to. The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.


setFirewallPort

public void setFirewallPort(int firewallPort)
                     throws IPWorksException
Port of the firewall to connect to. The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.


getFirewallType

public int getFirewallType()
Determines the type of firewall to connect through. The applicable values are the following:
fwNone (0)
No firewall (default setting).
fwTunnel (1)
Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)
Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)
Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.


setFirewallType

public void setFirewallType(int firewallType)
                     throws IPWorksException
Determines the type of firewall to connect through. The applicable values are the following:
fwNone (0)
No firewall (default setting).
fwTunnel (1)
Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)
Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)
Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.


getFirewallUser

public java.lang.String getFirewallUser()
A user name if authentication is to be used connecting through a firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


setFirewallUser

public void setFirewallUser(java.lang.String firewallUser)
                     throws IPWorksException
A user name if authentication is to be used connecting through a firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


getLastReply

public java.lang.String getLastReply()
The last reply from the server. This is the last reply received from the server. It can be used for information purposes. The same information and more can also be retrieved through the PITrail event.


getLocalFile

public java.lang.String getLocalFile()
The path to a local file for downloading the message body. If the file exists, it is overwritten (optional). The LocalFile property is used when retrieving a message via the Action property. If LocalFile is empty then the received data is provided through the parameters of the Transfer event.


setLocalFile

public void setLocalFile(java.lang.String localFile)
                  throws IPWorksException
The path to a local file for downloading the message body. If the file exists, it is overwritten (optional). The LocalFile property is used when retrieving a message via the Action property. If LocalFile is empty then the received data is provided through the parameters of the Transfer event.


getLocalHost

public java.lang.String getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. The LocalHost property contains the name of the local host as obtained by the gethostname() Winsock call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control 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 multihomed 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.


setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksException
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. The LocalHost property contains the name of the local host as obtained by the gethostname() Winsock call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control 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 multihomed 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.


getMailbox

public java.lang.String getMailbox()
Name of the mailbox selected on the server. Also used as argument to many other actions. For more information please refer to the Action property.


setMailbox

public void setMailbox(java.lang.String mailbox)
                throws IPWorksException
Name of the mailbox selected on the server. Also used as argument to many other actions. For more information please refer to the Action property.


getMailboxFlags

public java.lang.String getMailboxFlags()
Defined flags in the selected mailbox. The control fills out MessageCount , RecentMessageCount , and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox .


getMailPort

public int getMailPort()
The port of the IMAP server (default is 143). 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 while a connection is in progress. Any attempt to change the MailPort property while connected will fail with an error.


setMailPort

public void setMailPort(int mailPort)
                 throws IPWorksException
The port of the IMAP server (default is 143). 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 while a connection is in progress. Any attempt to change the MailPort property while connected will fail with an error.


getMailServer

public java.lang.String getMailServer()
The name or address of the mail server (IMAP server). The MailServer property specifies the IP address (IP number in dotted internet format) or Domain Name of the mail server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If the MailServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the MailServer property is set to the corresponding address. If the search is not successful, an error is returned.


setMailServer

public void setMailServer(java.lang.String mailServer)
                   throws IPWorksException
The name or address of the mail server (IMAP server). The MailServer property specifies the IP address (IP number in dotted internet format) or Domain Name of the mail server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If the MailServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the MailServer property is set to the corresponding address. If the search is not successful, an error is returned.


getMessageBCc

public java.lang.String getMessageBCc(int addressIndex)
                               throws IPWorksException
Array property with the list of BCc recipients of the message. Recipient addresses are provided in the array starting from index 0 and going up. After the last address, empty strings are returned.

The BCc addresses are never shown to any of the recipients of the message but are stored in the original outgoing message.


getMessageCc

public java.lang.String getMessageCc(int addressIndex)
                              throws IPWorksException
Array property with the list of Cc recipients of the message. Recipient addresses are provided in the array starting from index 0 and going up. After the last address, empty strings are returned.


getMessageContentEncoding

public java.lang.String getMessageContentEncoding()
The ContentEncoding of the selected message. The property is set when message information is retrieved via the imapGetMessageInfo Action .


getMessageContentType

public java.lang.String getMessageContentType()
The ContentType of the message. The MessageContentType property denotes the type of content contained in the message, such as plain, multipart, multipart/alternative etc. You may eventually need to check the MessageContentEncoding property or read the individual message parts.


getMessageCount

public int getMessageCount()
The total number of messages on the Mailbox . The control fills out MessageCount , RecentMessageCount , and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox .


getMessageDate

public java.lang.String getMessageDate()
The time the message was created. The MessageDate holds the date and time when the message was created. The format is described in RFC821.


getMessageDeliveryTime

public java.lang.String getMessageDeliveryTime()
The time the message was delivered to the mail server. The time format is defined in RFC821.


getMessageFlags

public java.lang.String getMessageFlags()
Flags of the current message. Also used to specify flags when an imapAppendToMailbox operation is specified through the Action property.


setMessageFlags

public void setMessageFlags(java.lang.String messageFlags)
                     throws IPWorksException
Flags of the current message. Also used to specify flags when an imapAppendToMailbox operation is specified through the Action property.


getMessageFrom

public java.lang.String getMessageFrom()
The address of the author of the message. MessageFrom has normally the same value as MessageSender .

There are cases when a message may have more than one From address. If this is the case, the addresses are provided in the MessageFrom property separated by commas.


getMessageHeaders

public java.lang.String getMessageHeaders()
RFC822-encoded headers of the message. This property holds the full headers of the message in RFC822 format. The headers are retrieved through the imapGetMessageHeaders Action .


setMessageHeaders

public void setMessageHeaders(java.lang.String messageHeaders)
                       throws IPWorksException
RFC822-encoded headers of the message. This property holds the full headers of the message in RFC822 format. The headers are retrieved through the imapGetMessageHeaders Action .


getMessageId

public java.lang.String getMessageId()
The message id of the current message. The control fills out the MessageId property when message information is retrieved from the MailServer through the Action property.

The id is permanent if UIDMode is set, and temporary otherwise.


getMessageInReplyTo

public java.lang.String getMessageInReplyTo()
The unique message ID of the message this one is in reply to. The control fills out MessageInReplyTo with the value of the In-Reply-To: message header.

This value can be useful when threading messages by referring to the message you are replying to.

The unique message Id of the message itself is given by the MessageNetId property.


getMessageNetId

public java.lang.String getMessageNetId()
The globally unique id of the message. The control fills the MessageId with the value of the Message-Id: header. This is a globally unique value normally created by the first mail server the message is sent to.


getMessageReplyTo

public java.lang.String getMessageReplyTo()
Email address(s) where replies to the message should be sent. There are cases when a message may have more than one Reply-To address. If this is the case, the addresses are provided in the MessageReplyTo property separated by commas.


getMessageSender

public java.lang.String getMessageSender()
The address of the sender of the message. MessageSender has normally the same value as MessageFrom .

There are cases when a message may have more than one sender. If this is the case, the addresses are provided in the MessageSender property separated by commas.


getMessageSet

public java.lang.String getMessageSet()
The set of messages to operate on. Used as an argument to most actions triggered by the Action property.

It may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g. "1:5"), and/or individual message numbers separated by ',' (e.g. "1:5,7,10").


setMessageSet

public void setMessageSet(java.lang.String messageSet)
                   throws IPWorksException
The set of messages to operate on. Used as an argument to most actions triggered by the Action property.

It may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g. "1:5"), and/or individual message numbers separated by ',' (e.g. "1:5,7,10").


getMessageSize

public int getMessageSize()
The size of the selected message. The control fills out the MessageSize property when message information is retrieved from the MailServer through the Action property.


getMessageSubject

public java.lang.String getMessageSubject()
The subject of the message. The control fills out the MessageSubject property when message information is retrieved from the MailServer through the Action property.


getMessageText

public java.lang.String getMessageText()
The body of the retrieved message The control fills out MessageText with the contents of the message body (in RFC822 format) when an imapGetMessageText operation is triggered via the Action property.


setMessageText

public void setMessageText(java.lang.String messageText)
                    throws IPWorksException
The body of the retrieved message The control fills out MessageText with the contents of the message body (in RFC822 format) when an imapGetMessageText operation is triggered via the Action property.


getMessageTo

public java.lang.String getMessageTo(int addressIndex)
                              throws IPWorksException
Array property with the list of direct recipients of the message. Recipient addresses are provided in the array starting from index 0 and going up. After the last address, empty strings are returned.


getNewMailbox

public java.lang.String getNewMailbox()
The new name of the mailbox during an imapRenameMailbox operation. Mailboxes are renamed by setting the Action property to the corresponding action value.


setNewMailbox

public void setNewMailbox(java.lang.String newMailbox)
                   throws IPWorksException
The new name of the mailbox during an imapRenameMailbox operation. Mailboxes are renamed by setting the Action property to the corresponding action value.


getPartId

public java.lang.String getPartId()
The PartId of the part to retrieve. The control will retrieve the part specified in PartId when Action is set to imapGetMessagePart .

The part id-s of each message part (if any) are provided through the corresponding MessagePart events.


setPartId

public void setPartId(java.lang.String partId)
               throws IPWorksException
The PartId of the part to retrieve. The control will retrieve the part specified in PartId when Action is set to imapGetMessagePart .

The part id-s of each message part (if any) are provided through the corresponding MessagePart events.


getPassword

public java.lang.String getPassword()
The password used to authenticate to the MailServer . Both the User and Password properties must be set before connecting to the MailServer .


setPassword

public void setPassword(java.lang.String password)
                 throws IPWorksException
The password used to authenticate to the MailServer . Both the User and Password properties must be set before connecting to the MailServer .


isPeekMode

public boolean isPeekMode()
When set to True, the message Seen flag is not changed during reading. When PeekMode is True, a "PEEK" option is added to all IMAP FETCH commands sent to the server. An RFC compliant IMAP server should not set the "Seen" flag on the message in this case.


setPeekMode

public void setPeekMode(boolean peekMode)
                 throws IPWorksException
When set to True, the message Seen flag is not changed during reading. When PeekMode is True, a "PEEK" option is added to all IMAP FETCH commands sent to the server. An RFC compliant IMAP server should not set the "Seen" flag on the message in this case.


getRecentMessageCount

public int getRecentMessageCount()
Number of new messages on the Mailbox . The control fills out MessageCount , RecentMessageCount , and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox .


getSearchCriteria

public java.lang.String getSearchCriteria()
Search criteria to use for search operations. The exact format of the search criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces, for example: "SINCE 1-Feb-1994 NOT FROM Smith".

Possible search keys include:

Messages with message sequence numbers corresponding to the specified message sequence number set
ALL
All messages in the mailbox - this is the default initial key for AND-ing.
ANSWERED
Messages with the \\Answered flag set.
BCC
Messages that contain the specified string in the envelope structure's BCC field.
BEFORE
Messages whose internal date is earlier than the specified date.
BODY
Messages that contain the specified string in the body of the message.
CC
Messages that contain the specified string in the envelope structure's CC field.
DELETED
Messages with the \\Deleted flag set.
DRAFT
Messages with the \\Draft flag set.
FLAGGED
Messages with the \\Flagged flag set.
FROM
Messages that contain the specified string in the envelope structure's FROM field.
HEADER
Messages that have a header with the specified field-name (as defined in [RFC-822]) and that contains the specified string in the [RFC-822] field-body.
KEYWORD
Messages with the specified keyword set.
LARGER
Messages with an RFC822.SIZE larger than the specified number of octets.
NEW
Messages that have the \\Recent flag set but not the \\Seen flag. This is functionally equivalent to "(RECENT UNSEEN)".
NOT
Messages that do not match the specified search key.
OLD
Messages that do not have the \\Recent flag set. This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW").
ON
Messages whose internal date is within the specified date.
OR
Messages that match either search key.
RECENT
Messages that have the \\Recent flag set.
SEEN
Messages that have the \\Seen flag set.
SENTBEFORE
Messages whose [RFC-822] Date: header is earlier than the specified date.
SENTON
Messages whose [RFC-822] Date: header is within the specified date.
SENTSINCE
Messages whose [RFC-822] Date: header is within or later than the specified date.
SINCE
Messages whose internal date is within or later than the specified date.
SMALLER
Messages with an RFC822.SIZE smaller than the specified number of octets.
SUBJECT
Messages that contain the specified string in the envelope structure's SUBJECT field.
TEXT
Messages that contain the specified string in the header or body of the message.
TO
Messages that contain the specified string in the envelope structure's TO field.
UID
Messages with unique identifiers corresponding to the specified unique identifier set.
UNANSWERED
Messages that do not have the \\Answered flag set.
UNDELETED
Messages that do not have the \\Deleted flag set.
UNDRAFT
Messages that do not have the \\Draft flag set.
UNFLAGGED
Messages that do not have the \\Flagged flag set.
UNKEYWORD
Messages that do not have the specified keyword set.
UNSEEN
Messages that do not have the \\Seen flag set.


setSearchCriteria

public void setSearchCriteria(java.lang.String searchCriteria)
                       throws IPWorksException
Search criteria to use for search operations. The exact format of the search criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces, for example: "SINCE 1-Feb-1994 NOT FROM Smith".

Possible search keys include:

Messages with message sequence numbers corresponding to the specified message sequence number set
ALL
All messages in the mailbox - this is the default initial key for AND-ing.
ANSWERED
Messages with the \\Answered flag set.
BCC
Messages that contain the specified string in the envelope structure's BCC field.
BEFORE
Messages whose internal date is earlier than the specified date.
BODY
Messages that contain the specified string in the body of the message.
CC
Messages that contain the specified string in the envelope structure's CC field.
DELETED
Messages with the \\Deleted flag set.
DRAFT
Messages with the \\Draft flag set.
FLAGGED
Messages with the \\Flagged flag set.
FROM
Messages that contain the specified string in the envelope structure's FROM field.
HEADER
Messages that have a header with the specified field-name (as defined in [RFC-822]) and that contains the specified string in the [RFC-822] field-body.
KEYWORD
Messages with the specified keyword set.
LARGER
Messages with an RFC822.SIZE larger than the specified number of octets.
NEW
Messages that have the \\Recent flag set but not the \\Seen flag. This is functionally equivalent to "(RECENT UNSEEN)".
NOT
Messages that do not match the specified search key.
OLD
Messages that do not have the \\Recent flag set. This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW").
ON
Messages whose internal date is within the specified date.
OR
Messages that match either search key.
RECENT
Messages that have the \\Recent flag set.
SEEN
Messages that have the \\Seen flag set.
SENTBEFORE
Messages whose [RFC-822] Date: header is earlier than the specified date.
SENTON
Messages whose [RFC-822] Date: header is within the specified date.
SENTSINCE
Messages whose [RFC-822] Date: header is within or later than the specified date.
SINCE
Messages whose internal date is within or later than the specified date.
SMALLER
Messages with an RFC822.SIZE smaller than the specified number of octets.
SUBJECT
Messages that contain the specified string in the envelope structure's SUBJECT field.
TEXT
Messages that contain the specified string in the header or body of the message.
TO
Messages that contain the specified string in the envelope structure's TO field.
UID
Messages with unique identifiers corresponding to the specified unique identifier set.
UNANSWERED
Messages that do not have the \\Answered flag set.
UNDELETED
Messages that do not have the \\Deleted flag set.
UNDRAFT
Messages that do not have the \\Draft flag set.
UNFLAGGED
Messages that do not have the \\Flagged flag set.
UNKEYWORD
Messages that do not have the specified keyword set.
UNSEEN
Messages that do not have the \\Seen flag set.


getStartByte

public int getStartByte()
The byte index where to start the transfer from. When StartByte or EndByte contain values other than the defaults (0), only the corresponding portion of the message part is retrieved from the server.

Byte indexes start from 1.


setStartByte

public void setStartByte(int startByte)
                  throws IPWorksException
The byte index where to start the transfer from. When StartByte or EndByte contain values other than the defaults (0), only the corresponding portion of the message part is retrieved from the server.

Byte indexes start from 1.


getTimeout

public int getTimeout()
A timeout for the component. If the Timeout property is set to 0 (default value) all actions will run uninterrupted until succesful completion, or an error condition is encountered.

If Timeout is set to a positive value, and any action does not complete within Timeout seconds, the action is aborted, and a 'Timeout' error is fired..

The control 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 always remains responsive.


setTimeout

public void setTimeout(int timeout)
                throws IPWorksException
A timeout for the component. If the Timeout property is set to 0 (default value) all actions will run uninterrupted until succesful completion, or an error condition is encountered.

If Timeout is set to a positive value, and any action does not complete within Timeout seconds, the action is aborted, and a 'Timeout' error is fired..

The control 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 always remains responsive.


isUIDMode

public boolean isUIDMode()
If true, permanent message id-s are used instead of the default temporary id-s. Normally, the IMAP server uses temporary message id-s that are valid only during the current session. If UIDMode is true, permanent message id-s are used instead.

The IMAP protocol operations where UID mode is used are the following: COPY , FETCH , STORE , SEARCH .


setUIDMode

public void setUIDMode(boolean UIDMode)
                throws IPWorksException
If true, permanent message id-s are used instead of the default temporary id-s. Normally, the IMAP server uses temporary message id-s that are valid only during the current session. If UIDMode is true, permanent message id-s are used instead.

The IMAP protocol operations where UID mode is used are the following: COPY , FETCH , STORE , SEARCH .


getUser

public java.lang.String getUser()
The user name used to authenticate to the MailServer . Both the User and Password properties must be set before connecting to the MailServer .


setUser

public void setUser(java.lang.String user)
             throws IPWorksException
The user name used to authenticate to the MailServer . Both the User and Password properties must be set before connecting to the MailServer .


fireEndTransfer

public void fireEndTransfer()
Fired when the message or the part data finishes transferring. (Called internally to dispatch the event.)
See Also:
ImapEndTransferEvent

fireError

public void fireError(int errorCode,
                      java.lang.String description)
Information about errors during data delivery. (Called internally to dispatch the event.)
See Also:
ImapErrorEvent

fireMailboxList

public void fireMailboxList(java.lang.String mailbox,
                            java.lang.String separator,
                            java.lang.String flags)
Fired for each mailbox received through the various imapListMailbox actions. (Called internally to dispatch the event.)
See Also:
ImapMailboxListEvent

fireMessageInfo

public void fireMessageInfo(java.lang.String messageId,
                            java.lang.String subject,
                            java.lang.String messageDate,
                            java.lang.String from,
                            java.lang.String flags,
                            int size)
Fired with information for the message(s) retrieved by the server. (Called internally to dispatch the event.)
See Also:
ImapMessageInfoEvent

fireMessagePart

public void fireMessagePart(java.lang.String partId,
                            int size,
                            java.lang.String contentType,
                            java.lang.String filename,
                            java.lang.String contentEncoding,
                            java.lang.String parameters,
                            java.lang.String multipartMode)
Fired for each message part when an imapGetMessageInfo action is performed. (Called internally to dispatch the event.)
See Also:
ImapMessagePartEvent

firePITrail

public void firePITrail(int direction,
                        java.lang.String message)
Traces the commands sent to the mail server, and the respective replies. (Called internally to dispatch the event.)
See Also:
ImapPITrailEvent

fireStartTransfer

public void fireStartTransfer()
Fired when the message or the part data starts transferring. (Called internally to dispatch the event.)
See Also:
ImapStartTransferEvent

fireTransfer

public void fireTransfer(int bytesTransferred,
                         java.lang.String text)
Fired while the message gets transferred from the MailServer . (Called internally to dispatch the event.)
See Also:
ImapTransferEvent

addMessageFlags

public void addMessageFlags(java.lang.String flags)
                     throws IPWorksException
Add the specified flags to the messages specified by MessageSet . Add the specified flags to the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.


appendToMailbox

public void appendToMailbox()
                     throws IPWorksException
Appends the message in MessageText to the mailbox specified by Mailbox . Appends the RFC822-encoded message in MessageText to the mailbox specified by Mailbox . If the MessageFlags property is not an empty string, it's contents are supplied with the 'APPEND' command sent to the server.

Calling this method is equivalent to setting the Action property to imapAppendToMailbox .


checkMailbox

public void checkMailbox()
                  throws IPWorksException
Sends a 'CHECK' command to the server. Sends a 'CHECK' command to the server, asking it to perform any neccessary 'housekeeping' operations on, and update the state of the currently selected mailbox.

Calling this method is equivalent to setting the Action property to imapCheckMailbox .


closeMailbox

public void closeMailbox()
                  throws IPWorksException
Remove all messages marked with 'Deleted' flag from the currently selected mailbox and unselect mailbox. Permanently remove all messages that have the 'Deleted' flag set from the current (selected) mailbox, and then close (deselect) the mailbox.

Calling this method is equivalent to setting the Action property to imapCloseMailbox .


connect

public void connect()
             throws IPWorksException
Connect to an IMAP server. Connect to the IMAP server specified by MailServer and authenticate using the user name and password supplied in the User and Password properties.

Calling this method is equivalent to setting the Action property to imapConnect .


copyToMailbox

public void copyToMailbox()
                   throws IPWorksException
Copies the messages specified by MessageSet to the mailbox specified by Mailbox . Copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.

Calling this method is equivalent to setting the Action property to imapCopyToMailbox .


createMailbox

public void createMailbox()
                   throws IPWorksException
Create a new mailbox specified by Mailbox . Create a new mailbox. The mailbox name is specified by the Mailbox property.

Calling this method is equivalent to setting the Action property to imapCreateMailbox .


deleteMailbox

public void deleteMailbox()
                   throws IPWorksException
Delete a mailbox specified by Mailbox . Delete a mailbox. The mailbox name is specified by the Mailbox property.

Calling this method is equivalent to setting the Action property to imapDeleteMailbox .


disconnect

public void disconnect()
                throws IPWorksException
Disconnect from an IMAP server. Logout and disconnect from the IMAP server.

Calling this method is equivalent to setting the Action property to imapDisconnect .


examineMailbox

public void examineMailbox()
                    throws IPWorksException
Select a Mailbox (Read-only mode). Ask the server to select the mailbox specified in the Mailbox property in read-only mode.

Calling this method is equivalent to setting the Action property to imapExamineMailbox .


expungeMailbox

public void expungeMailbox()
                    throws IPWorksException
Remove all messages marked with 'Deleted' flag from the currently selected mailbox. Permanently remove all messages that have the 'Deleted' flag set from the current (selected) mailbox.

Calling this method is equivalent to setting the Action property to imapExpungeMailbox .


fetchMessageHeaders

public void fetchMessageHeaders()
                         throws IPWorksException
Get the message headers of messages specified by the MessageSet property. Retrieves RFC822 headers of the message specified by MessageSet and stores them in the MessageHeaders property.

Calling this method is equivalent to setting the Action property to imapGetMessageHeaders .


fetchMessageInfo

public void fetchMessageInfo()
                      throws IPWorksException
Get information about messages specified by the MessageSet property. Retrieves message information for the messages specified by the MessageSet property. This includes information about the message envelope as well as message structure. Every time a message envelope is retrieved, a MessageInfo event is fired, and message envelope information is stored in properties such as: MessageSubject , MessageFrom , MessageTo , MessageCc , etc.. If the message is a multipart message, one or more MessagePart events are fired before the MessageInfo event - one for each message part.

Calling this method is equivalent to setting the Action property to imapGetMessageInfo .


fetchMessagePart

public void fetchMessagePart()
                      throws IPWorksException
Get a message part specified by PartId . Retrieves the contents message part specified by the PartId property of the message specified by the MessageSet property. If the LocalFile property contains a file name, the message part is stored in LocalFile , and the Transfer events denote the progress. If the LocalFile property contains an empty string, the message part is stored in the MessageText property, as well as provided through the Transfer event.

Calling this method is equivalent to setting the Action property to imapGetMessagePart .


fetchMessageText

public void fetchMessageText()
                      throws IPWorksException
Get the message text of messages specified by the MessageSet property. Retrieves the RFC822-encoded text of the message specified by MessageSet . If the LocalFile property contains a file name, the text is stored in LocalFile , and the Transfer events denote the progress. If the LocalFile property contains an empty string, the text is stored in the MessageText property, as well as provided through the Transfer event.

Calling this method is equivalent to setting the Action property to imapGetMessageText .


interrupt

public void interrupt()
               throws IPWorksException
Interrupt the Action in progress (if any). Calling this method is equivalent to setting the Action property to Idle (0) .


listMailboxes

public void listMailboxes()
                   throws IPWorksException
List all mailboxes matching all criteria in the Mailbox property. List all mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through the MailboxList event.

Calling this method is equivalent to setting the Action property to imapListMailboxes .


listSubscribedMailboxes

public void listSubscribedMailboxes()
                             throws IPWorksException
List all subscribed mailboxes matching all criteria in the Mailbox property. List all subscribed mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through MailboxList event.

Calling this method is equivalent to setting the Action property to imapListSubscribedMailboxes .


noop

public void noop()
          throws IPWorksException
Sends a 'NOOP' command to the server. Sends an IMAP 'NOOP' command to the server. This is useful when the connection needs to be kept alive for long periods of time. (Normally, servers break the connection automatically after 30 minutes of inactivity).

Calling this method is equivalent to setting the Action property to imapNoop .


renameMailbox

public void renameMailbox()
                   throws IPWorksException
Change the name of Mailbox to NewMailbox . Rename a mailbox. The mailbox is specified by the Mailbox property, and the new name is specified by the NewMailbox property.

Calling this method is equivalent to setting the Action property to imapRenameMailbox .


resetMessageFlags

public void resetMessageFlags()
                       throws IPWorksException
Replace the flags of the messages specified by MessageSet with the flags specified by MessageFlags . Replace the flags of the messages specified by the MessageSet property with the flags specified by the MessageFlags property. The format of the flags is specified by the IMAP RFCs.

Calling this method is equivalent to setting the Action property to imapResetMessageFlags .


searchMailbox

public void searchMailbox()
                   throws IPWorksException
Search selected mailbox for specified text. Search the selected mailbox using the criteria specified in the SearchCriteria property. For every message matching the criteria, the equivalent of a imapGetMessageInfo action is performed and a MessageInfo event is fired. For more information about the format of the search criteria, please refer to the SearchCriteria property.

Calling this method is equivalent to setting the Action property to imapSearchMailbox .


selectMailbox

public void selectMailbox()
                   throws IPWorksException
Select a Mailbox. Ask the server to select the mailbox specified in the Mailbox property. The mailbox is selected in read/write mode (if the server permits).

Calling this method is equivalent to setting the Action property to imapSelectMailbox .


subscribeMailbox

public void subscribeMailbox()
                      throws IPWorksException
Subscribe to the mailbox specified by Mailbox . Subscribe to the mailbox specified by the Mailbox property.

Calling this method is equivalent to setting the Action property to imapSubscribeMailbox .


unsetMessageFlags

public void unsetMessageFlags()
                       throws IPWorksException
Remove the flags specified by MessageFlags from the messages specified by MessageSet . Remove the flags specified by the MessageFlags property from the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.

Calling this method is equivalent to setting the Action property to imapUnsetMessageFlags .


unsubscribeMailbox

public void unsubscribeMailbox()
                        throws IPWorksException
Unsubscribe from the mailbox specified by Mailbox . Unsubscribe from the mailbox specified by the Mailbox property.

Calling this method is equivalent to setting the Action property to imapUnsubscribeMailbox .


addImapEventListener

public void addImapEventListener(ImapEventListener l)
                          throws java.util.TooManyListenersException

removeImapEventListener

public void removeImapEventListener(ImapEventListener l)

IP*Works!

Copyright (c) 2001 /n software inc. - All rights reserved.