Search: 
Available in: S/MIME
SPOP Component [IP*Works! S/MIME V8]

Properties   Methods   Events   Configuration Settings  

The SPOP component is used retrieve electronic mail from Internet Post Office servers (POP).

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The SPOP component is the S/MIME enabled equivalent of the IP*Works! POP component. In addition to standard POP functions the SPOP component can decrypt and/or verify message signatures. The methods and properties for decrypting, and verifying signatures are identical to those provided with the S/MIME component. When attempting to verify a signed message or when decrypting a message call the Decrypt, VerifySignature, or DecryptAndVerifySignature methods and the resulting text will be replaced in Message.

The SPOP component implements a standard internet post office (POP3) client as specified in RFC 1725.

To connect to a MailServer first set the appropriate User and Password and then connect by calling the Connect method. Upon successful connection to the MailServer, the number of waiting messages is shown by the MessageCount property. A message is selected by setting the MessageNumber property to a number between 1 and MessageCount (inclusive). Then, message text and/or headers are received by calling the Retrieve method.

The message text is received through the Transfer event, whereas the message headers are received through the Header event. Additionally, up to MaxLines from the message body are provided in the MessageText property. The body of the message is also saved in the file specified by the LocalFile property. StartTransfer and EndTransfer events are fired at the beginning and end of message transmission. The PITrail event provides a trace of the interaction between the client and server (excluding message transfers).

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AuthMechanismThe authentication mechanism to be used when connecting to the mail server.
CertificateThe current selected certificate.
CommandCan be used to send additional commands directly to the server.
ConnectedShows whether the component is connected.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
IncludeHeadersInstructs the component to include the headers in the MessageText and LocalFile .
LastReplyThe last reply from the server.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailPortThe server port for POP (default 110).
MailServerThe name or address of a mail server (internet post office server).
MaxLinesThe maximum number of message lines besides headers to retrieve.
MessageCcThe value of the Cc header of the last retrieved message.
MessageCountThe number of messages waiting in the mailbox.
MessageDateThe value of the Date: header of the last retrieved message.
MessageEncryptedWhether or not the current message is encrypted.
MessageFromThe value of the From header of the last retrieved message.
MessageHeadersCollection of the message headers as retrieved from the server.
MessageHeadersStringA string representation of the full headers of the message as retrieved from the server.
MessageNumberCurrent (selected) message.
MessageRecipientsA collection of recipients for the current message.
MessageReplyToThe value of the Reply-To header of the last retrieved message.
MessageSignedWhether or not the current message is signed.
MessageSizeThe size in bytes of the current message.
MessageSubjectThe value of the Subject header of the last retrieved message.
MessageTextThe full text of the message as retrieved from the server.
MessageToThe value of the To header of the last retrieved message.
MessageUIDThe unique id of the message as specified by the server.
PasswordThe password for the mailbox user.
SignerCertContains the certificate of the message signer.
SignerCertChainThe certificate chain of the signing certificate.
SigningAlgorithmTextual description of the signature hash algorithm.
TimeoutA timeout for the component.
TotalSizeCumulative size in bytes of messages in the mailbox (including headers).
UserThe user id for the mailbox.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
ConnectConnects to the mail server and attempts to login.
DecryptDecrypts the current Message .
DecryptAndVerifySignatureDecrypts and verifies the signature of the current Message .
DeleteDelete a message specified by MessageNumber on the server.
DisconnectDisconnects from the mail server.
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
ListMessageSizesRetrieves a list of all message sizes from the server.
ListMessageUIDsRetrieves a list of all message UID-s from the server.
LocalizeDateConverts a valid RFC 822 message date to local date and time.
ResetReset all changes and revert back to the state when the user first connected.
RetrieveRetrieve a message specified by MessageNumber from the server.
RetrieveHeadersRetrieve headers for a message specified by MessageNumber .
SetMessageStreamSets the stream to which the message downloaded from the server will be written.
VerifySignatureVerify the signature of the current Message .

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ConnectionStatusFired to indicate changes in connection state.
EndTransferFired when the message completes transferring.
ErrorInformation about errors during data delivery.
HeaderFired for every message header being retrieved.
MessageListFired for every message listed by ListMessageSizes and/or ListMessageUIDs .
PITrailTraces the commands sent to the mail server, and the respective replies.
StartTransferFired when the message starts transferring.
TransferFired while the message gets transferred from MailServer .

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

GetMessageSizeWhether to poll the server for the message size prior to retrieving it.
IncludeHeadersWhether to include message headers in the .
MaxLineLengthThe maximum expected length for message lines
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
AutoDecodeSubjectInstructs the component to automatically decode message subjects.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only).

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.