The methods of the ReceivePOP3EmailAgent class are listed below. For a complete list of ReceivePOP3EmailAgent class members, see the ReceivePOP3EmailAgent Members topic.
Public Instance Methods
 addListener (inherited from Props) | Adds an IPropsChangeListener to the list of listeners for this object. |
| addScheduleChangeListener (inherited from ScheduledAgent) | Listeners are not implemented. Always returns false. |
| append (inherited from Props) | If the specified object is a String, it is the specified String is appended to it. Otherwise the call is ignored. |
| copy (inherited from Props) | Copies the value of the property with the same name as key from srcProps into the IPropsContainer for this object. |
| copyFrom (inherited from Props) | Copies the contents of the specified Props into this one. |
| copyTo (inherited from Props) | Copies the contents of this Props into the one specified. |
| currentStateEquals (inherited from Agent) | Returns true if the specified state is the current state. |
| debug (inherited from Agent) | Prints a debug message tagged with this agent's identity to the output stream. |
| decrementInteger (inherited from Props) | Decrements the integer value of the specified key by 1. |
| deliverMessage | This method creates an AgentRequest from the specified IMessage, and delivers it to the RequestAgent that is registered as the message recipient. |
| destroy (inherited from Agent) | Override this method to perform special cleanup before an agent is destroyed. |
| dump (inherited from Props) | Dumps a list of properties and their values to System.out. |
| dumpToString (inherited from Props) | This returns the name/value pairs in a human-readable string. |
| enableListeners (inherited from Props) | |
| enumerateKeys (inherited from Props) | Returns an Enumeration of keys representing properties contained by this object's IPropsContainer. |
| Equals (inherited from Object) | |
| error (inherited from Agent) | Overloaded. Prints an error message tagged with this agent's identity to the error stream. |
| format (inherited from Props) | Uses the specified MessageFormat pattern this method generates a string containing the inserted values from the corresponding properties. The pattern string is passed to java.text.MessageFormat.format() after substituting appropriate argument indexes for property names. |
| getBoolean (inherited from Props) | Returns the boolean value of the requested property |
| getByteArray (inherited from Props) | Returns specified object as a byte array. If the object is a String its getBytes methods is called to obtain a byte array. Otherwise, the object's String value is used to obtain a byte array. |
| getCharacter (inherited from Props) | Returns the char value of the requested property |
| getDouble (inherited from Props) | Returns the double value of the requested property |
| getFloat (inherited from Props) | Returns the float value of the requested property |
| GetHashCode (inherited from Object) | |
| getHexString (inherited from Props) | Returns the specified object as a String of hexadecimal bytes. |
| getInteger (inherited from Props) | Returns the int value of the requested property |
| getLong (inherited from Props) | Returns the long value of the requested property |
| getProperty (inherited from Props) | Returns the property with the same name as the key parameter if available. If the requested property does not exist, null is returned instead. |
| getServiceImpl (inherited from Agent) | Returns a reference to the requested Service from the ServiceManager or null (Nothing in Visual Basic) if the requested service does not exist, or the ServiceManager has not been loaded. |
| getSize (inherited from Props) | Returns the size of the specified object. If the object is a Vector, the number of elements it contains is returned. If the object is a String, its length is returned. For other objects the length of the object's string value is returned. If the object does not exist, zero is returned. |
| getString (inherited from Props) | Returns the String value of the requested property |
| getTokens (inherited from Props) | Overloaded. Returns a Vector of Strings representing the tokens stored stored in the specified property separated by a comma, semi-colon, carriage return, or line-feed. |
| getTrimmedString (inherited from Props) | Returns the specified object as a trimmed String. |
| GetType (inherited from Object) | |
| getVector (inherited from Props) | Returns the specified object as a Vector. If the specified object is not a Vector, it is placed in a Vector and returned. if the object does not exist, an empty Vector is returned. |
| hasProperty (inherited from Props) | Tests the existence of the specified property. |
| incrementInteger (inherited from Props) | Increments the integer value of the specified key by 1. |
| initProps | Initializes the default Props for this agent: "schedule" is specifies the schedule this agent uses to check the POP3 server (default: every 60 seconds), "pop3_host" is the POP3 server's host name (default: localhost), "pop3_port" is the POP3 server's port (default: 110), "username" is the POP3 account username, "password" is the POP3 account password, "max_trys" is the number of connection attempt to the POP3 server before giving up, "delete_messages" is set to true if the messages are to be deleted after downloading (default: true). |
| insertProps (inherited from Props) | Inserts property String values into the passed string where property names are surrounded by angle brackets. |
| notifyPropsChanged (inherited from Props) | Can be called externally to manually send props changes messages to all registered IPropsChangeListeners. |
| notifyPropsChangedIgnore (inherited from Props) | Overloaded. Can be called externally to manually send props changes messages to all registered IPropsChangeListeners, except the one passed. Passing a null IPropsChangeLister will result in the notification of all registered listeners; the same as notifyPropsChanged. |
| println (inherited from Agent) | Prints a message tagged with this agent's identity to the output stream. Can be disabled by setting hide_println prop to "true". |
| register (inherited from Agent) | Registers this instance with the service manager using the service_name prop. |
| registerService (inherited from Agent) | Registers the specified object with the service manager using the specified prop. |
| removeAll (inherited from Props) | Removes all properties referenced by this class. |
| removeListener (inherited from Props) | Removes an IPropsChangeListener from the list of listeners for this object. |
| removeProperty (inherited from Props) | Removes the property with the same name as the key parameter if available. If the requested property does not exist, false is returned. |
| removeScheduleChangeListener (inherited from ScheduledAgent) | Listeners are not implemented. Always returns false. |
| resumeNotify (inherited from Props) | Resumes the automatic notification of IPropsChangeListeners. Calling this method will immediately call the propsChanged method of its IPropsChangeListeners passing an array of property names which have changed since suspendNotify was called. |
| setBoolean (inherited from Props) | Sets the property key to a Boolean of the passed value. |
| setCharacter (inherited from Props) | Sets the property key to a Character of the passed value. |
| setDefault (inherited from Props) | If there is no value for the specified object, it is set to the value specified as default. |
| setDouble (inherited from Props) | Sets the property key to a Double of the passed value. |
| setFloat (inherited from Props) | Sets the property key to a Float of the passed value. |
| setInteger (inherited from Props) | Sets the property key to a Integer of the passed value. |
| setLong (inherited from Props) | Sets the property key to a Long of the passed value. |
| setProperty (inherited from Props) | Overloaded. Sets the property key to the passed value. |
| start (inherited from ScheduledAgent) | Creates a Schedule according to the string specified in the schedule prop, and schedules this agent so it's wakeup() method is called at the scheduled times. |
| stop (inherited from ScheduledAgent) | Unschedules this agent. |
| suspendNotify (inherited from Props) | Suspends the automatic notification of IPropsChangeListeners. This is useful for when several property changes need to be made without calling the propsChanged method of the IPropsChangeListeners for each one. After this method is called, property changes are queued until the resumeNotify method is called. Each successive call to this method must be matched with a call to resumeNotify in order for notification to work correctly. |
| ToString (inherited from Agent) | Returns the string representation of this agent using the format <agent_id>_<name> taken from this agent's Props the first time this method is called, and cached for future calls. This format follows the standard naming conventions for agent Props files and allows the agent's output to be formatted in a manner consistent with these files. |
| unregister (inherited from Agent) | Unregisters this service implementation instance with the service manager using the service_name prop. |
| unregisterService (inherited from Agent) | Unregisters the service implementation instance with the service manager using the specified prop. |
| wakeup | On wakeup, this agent connects to the POP3 server and downloads any new messages it finds. New messsages are delivered to RequestAgents using the deliverMessage method of this class. |
| warning (inherited from Agent) | Overloaded. Prints a warning message tagged with this agent's identity to the error stream. |
Protected Instance Methods
 closeConnection | Closes the connection to the POP3 server. |
| deleteMessage | Deletes the specified message from the POP3 server. |
| Finalize (inherited from Object) | |
| getMessage | Downloads the specified message from the POP3 server and returns it as an IMessage. |
| getNextKey (inherited from Props) | |
| getRange | Return a vector holding (Integer {msg_num},(String {msg_header},String {msg_body})). start - first message to get stop - last message to get |
| last | Returns the number of the highest message accesed. |
| listMessage | This method lists a message on the POP3 server by its message number. Returns the pair (int {msg_num} ,int {msg_size}) |
| listMessages | Returns a vector of pairs. Each pair contains (int {msg_num} ,int {msg_size}) |
| logon | Sends the logon command to the POP3 server using the specified username and password. |
| MemberwiseClone (inherited from Object) | |
| noop | Sends a NOOP command to the POP3 server. |
| okResponse | Overloaded. Return true if input String starts with '+OK'. |
| openConnection | Opens a connection to the POP3 server for the agent to use. |
| parseAllMessages | Parses a Vector containing Pairs referencing message headers and bodies into a Vector of Hashtables containing message attributes including the message body. |
| parseMessage | Overloaded. Parses the message header and body in the specified Pair into a Hashtable containing attributes, with the "body" attribute set to the specified body. |
| quit | End connection to server. |
| reset | Reset maildrop to previous state. |
| scheduleTheAgent (inherited from ScheduledAgent) | Creates a Schedule as specified by the schedule prop and schedules this agent. Call this method instead of super.start for clarification when overriding start method. |
| send | If connected, send a line to the server. pop_msg - the message to send to the server |
| splitInt | |
| stat | Get the status of the current user. Returns a (;<num_message;>,<total_size;>) int pair |
| unschedule (inherited from ScheduledAgent) | Unschedules this agent. Call this method instead of super.stop for clarification when overriding stop method. |
See Also
ReceivePOP3EmailAgent Class | com.neokernel.email Namespace