IP*Works! S/MIME SPOP Component : SPOP OCX, SPOP .NET Component, SPOP Class, SPOP Bean, SPOP Object

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.


AuthMechanism	The authentication mechanism to be used when connecting to the mail server.
CertEncoded	The certificate (PEM/base64 encoded).
CertStore	The name of the certificate store for the client certificate.
CertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
CertStoreType	The type of certificate store for this certificate.
CertSubject	The subject of the certificate used for client authentication.
Command	Used to send additional commands directly to the server.
Connected	Shows whether the component is connected.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
Idle	The current status of the component.
IncludeHeaders	Instructs the component to include the headers in the MessageText and LocalFile.
LastReply	The last reply from the server.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailPort	The server port for POP (default 110).
MailServer	The name or address of a mail server (internet post office server).
MaxLines	The maximum number of message lines besides headers to retrieve.
MessageCc	The value of the CC header of the last retrieved message.
MessageCount	The number of messages waiting in the mailbox.
MessageDate	The value of the date header of the last retrieved message.
MessageEncrypted	Whether or not the current message is encrypted.
MessageFrom	The value of the from header of the last retrieved message.
MessageHeaderCount	The number of records in the MessageHeader arrays.
MessageHeaderField	This property contains the name of the HTTP header (same case as it is delivered).
MessageHeaderValue	This property contains the header contents.
MessageHeadersString	A string representation of the full headers of the message as retrieved from the server.
MessageNumber	Current (selected) message.
MessageRecipientCount	The number of records in the MessageRecipient arrays.
MessageRecipientAddress	This property contains the email address of the recipient.
MessageRecipientName	This property contains name of the recipient.
MessageRecipientOptions	This property contains the recipient sending options (used only by SMTP).
MessageRecipientType	This property contains the recipient type: To, Cc, or BCc.
MessageReplyTo	The value of the Reply-To header of the last retrieved message.
MessageSigned	Whether or not the current message is signed.
MessageSize	The size in bytes of the current message.
MessageSubject	The value of the Subject header of the last retrieved message.
MessageText	The full text of the message as retrieved from the server.
MessageTo	The value of the To header of the last retrieved message.
MessageUID	The unique identifier of the message as specified by the server.
Password	The password for the mailbox user.
SignerCertEncoded	The certificate (PEM/base64 encoded).
SignerCertIssuer	The issuer of the certificate.
SignerCertSerialNumber	The serial number of the certificate encoded as a string.
SignerCertSubject	The subject of the certificate used for client authentication.
SignerCertChainCount	The number of records in the SignerCertChain arrays.
SignerCertChainEncoded	The certificate (PEM/base64 encoded).
SigningAlgorithm	Textual description of the signature hash algorithm.
Timeout	A timeout for the component.
TotalSize	Cumulative size in bytes of messages in the mailbox (including headers).
User	The user identifier 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.


Config	Sets or retrieves a configuration setting.
Connect	Connects to the mail server and attempts to login.
Decrypt	Decrypts the current Message.
DecryptAndVerifySignature	Decrypts and verifies the signature of the current Message.
Delete	Deletes a message specified by MessageNumber on the server.
Disconnect	Disconnects from the mail server.
DoEvents	Processes events from the internal message queue.
Interrupt	Interrupt the current method.
ListMessageSizes	Retrieves a list of all message sizes from the server.
ListMessageUIDs	Retrieves a list of all message UIDs from the server.
LocalizeDate	Converts a valid RFC 822 message date to local date and time.
Reset	Resets all changes and revert back to the state when the user first connected.
Retrieve	Retrieves a message specified by MessageNumber from the server.
RetrieveHeaders	Retrieves headers for a message specified by MessageNumber.
VerifySignature	Verifies 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.


ConnectionStatus	Fired to indicate changes in connection state.
EndTransfer	Fired when the message completes transferring.
Error	Information about errors during data delivery.
Header	Fired for every message header being retrieved.
MessageList	Fired for every message listed by ListMessageSizes and/or ListMessageUIDs.
PITrail	Traces the commands sent to the mail server, and the respective replies.
StartTransfer	Fired when the message starts transferring.
Transfer	Fired 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.


AuthorizationIdentity	The value to use as the authorization identity when SASL authentication is used.
AutoDecodeSubject	Instructs the component to automatically decode message subjects.
GetMessageSize	Whether to poll the server for the message size prior to retrieving it.
IncludeHeaders	Whether to include message headers in the LocalFile.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxLineLength	The maximum expected length for message lines.
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.

|

About

|

Privacy Policy

|

Terms of Use

|