POP Class
Properties Methods Events Configuration Settings Errors
The POP Class is used to easily retrieve electronic mail from Internet Post Office servers (POP).
Syntax
POP
Remarks
The POP Class supports both plaintext and SSL/TLS connections (RFC 2595). When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.
The POP Class 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 class with short descriptions. Click on the links for further details.
AuthMechanism | The authentication mechanism to be used when connecting to the mail server. |
Connected | Shows whether the class is connected. |
FirewallAutoDetect | This property tells the class 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 class. |
IncludeHeaders | Instructs the class to include the headers in the MessageText and LocalFile. |
LastReply | The last reply from the server. |
LocalFile | The path to a local file for downloading the message body. If the file exists, it is overwritten (optional). |
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. |
Message | Provides the raw message content. |
MessageCc | The value of the CC header of the last retrieved message. |
MessageCount | The number of messages in the mailbox. |
MessageDate | The value of the date header of the last retrieved message. |
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. |
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. |
Password | The password for the mailbox user. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLEnabled | Whether TLS/SSL is enabled. |
SSLProvider | TBD. |
SSLServerCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLStartMode | Determines how the class starts the SSL negotiation. |
Timeout | A timeout for the class. |
User | The user identifier for the mailbox. |
Method List
The following is the full list of the methods of the class 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. |
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. |
QueryMessageSize | Returns the size in bytes of the current message. |
QueryMessageUID | Returns the unique identifier of the message as specified by the server. |
QueryTotalSize | Returns the cumulative size in bytes of messages in the mailbox (including headers). |
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 . |
SendCommand | Sends the exact command directly to the server. |
SetMessageStream | Sets the stream to which the message downloaded from the server will be written. |
Event List
The following is the full list of the events fired by the class 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. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
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 class 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 class to automatically decode message subjects. |
GetMessageSize | Whether to poll the server for the message size prior to retrieving it. |
MaxLineLength | The maximum expected length for message lines. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedProtocol | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13Provider | The TLS 1.3 implementation to be used. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
AuthMechanism Property (POP Class)
The authentication mechanism to be used when connecting to the mail server.
Syntax
ANSI (Cross Platform) int GetAuthMechanism();
int SetAuthMechanism(int iAuthMechanism); Unicode (Windows) INT GetAuthMechanism();
INT SetAuthMechanism(INT iAuthMechanism);
Possible Values
AM_USER_PASSWORD(0),
AM_CRAMMD5(1),
AM_NTLM(2),
AM_APOP(3),
AM_SASLPLAIN(4),
AM_SASLDIGEST_MD5(5),
AM_KERBEROS(6),
AM_XOAUTH2(7)
@property (nonatomic,readwrite,assign,getter=authMechanism,setter=setAuthMechanism:) int authMechanism; - (int)authMechanism; - (void)setAuthMechanism:(int)newAuthMechanism;
Possible Values
AM_USER_PASSWORD(0),
AM_CRAMMD5(1),
AM_NTLM(2),
AM_APOP(3),
AM_SASLPLAIN(4),
AM_SASLDIGEST_MD5(5),
AM_KERBEROS(6),
AM_XOAUTH2(7)
int ipworks_pop_getauthmechanism(void* lpObj);
int ipworks_pop_setauthmechanism(void* lpObj, int iAuthMechanism);
Default Value
0
Remarks
This property is used as the authentication mechanism when connecting to the mail server. By default, this property is amUserPassword (0), and default plaintext authentication is used to login to the server. Other, more secure, options include amCRAMMD5 (1) for CRAM-MD5, amNTLM (2) for NTLM authentication, amAPOP (3) for APOP authentication, and amSASLDigestMD5 (5) for SASL DIGEST-MD5 authentication.
amSASLPlain (4) is also available, but most servers require a secure SSL connection when utilizing this authentication mechanism.
amKerberos (6) is for Kerberos authentication. NOTE: This functionality is only available in Windows.
Data Type
Integer
Connected Property (POP Class)
Shows whether the class is connected.
Syntax
ANSI (Cross Platform) int GetConnected();
int SetConnected(int bConnected); Unicode (Windows) BOOL GetConnected();
INT SetConnected(BOOL bConnected);
@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected; - (BOOL)connected; - (void)setConnected:(BOOL)newConnected;
int ipworks_pop_getconnected(void* lpObj);
int ipworks_pop_setconnected(void* lpObj, int bConnected);
Default Value
FALSE
Remarks
This property is used to determine whether or not the class is connected to the remote host.
Note: It is recommended to use the Connect or Disconnect method instead of setting this property.
This property is not available at design time.
Data Type
Boolean
FirewallAutoDetect Property (POP Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
ANSI (Cross Platform) int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect); Unicode (Windows) BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);
@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect; - (BOOL)firewallAutoDetect; - (void)setFirewallAutoDetect:(BOOL)newFirewallAutoDetect;
int ipworks_pop_getfirewallautodetect(void* lpObj);
int ipworks_pop_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (POP Class)
This property determines the type of firewall to connect through.
Syntax
ANSI (Cross Platform) int GetFirewallType();
int SetFirewallType(int iFirewallType); Unicode (Windows) INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);
Possible Values
FW_NONE(0),
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType; - (int)firewallType; - (void)setFirewallType:(int)newFirewallType;
Possible Values
FW_NONE(0),
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
int ipworks_pop_getfirewalltype(void* lpObj);
int ipworks_pop_setfirewalltype(void* lpObj, int iFirewallType);
Default Value
0
Remarks
This property 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. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (POP Class)
This property contains the name or IP address of firewall (optional).
Syntax
ANSI (Cross Platform) char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost); Unicode (Windows) LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);
@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost; - (NSString*)firewallHost; - (void)setFirewallHost:(NSString*)newFirewallHost;
char* ipworks_pop_getfirewallhost(void* lpObj);
int ipworks_pop_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
Data Type
String
FirewallPassword Property (POP Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword); Unicode (Windows) LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);
@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword; - (NSString*)firewallPassword; - (void)setFirewallPassword:(NSString*)newFirewallPassword;
char* ipworks_pop_getfirewallpassword(void* lpObj);
int ipworks_pop_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
Default Value
""
Remarks
This property contains a password if authentication is to be used when 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, the class fails with an error.
Data Type
String
FirewallPort Property (POP Class)
This property contains the TCP port for the firewall Host .
Syntax
ANSI (Cross Platform) int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); Unicode (Windows) INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);
@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort; - (int)firewallPort; - (void)setFirewallPort:(int)newFirewallPort;
int ipworks_pop_getfirewallport(void* lpObj);
int ipworks_pop_setfirewallport(void* lpObj, int iFirewallPort);
Default Value
0
Remarks
This property contains the TCP port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note that this property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (POP Class)
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
ANSI (Cross Platform) char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser); Unicode (Windows) LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);
@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser; - (NSString*)firewallUser; - (void)setFirewallUser:(NSString*)newFirewallUser;
char* ipworks_pop_getfirewalluser(void* lpObj);
int ipworks_pop_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
Idle Property (POP Class)
The current status of the class.
Syntax
ANSI (Cross Platform) int GetIdle(); Unicode (Windows) BOOL GetIdle();
@property (nonatomic,readonly,assign,getter=idle) BOOL idle; - (BOOL)idle;
int ipworks_pop_getidle(void* lpObj);
Default Value
TRUE
Remarks
Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
IncludeHeaders Property (POP Class)
Instructs the class to include the headers in the MessageText and LocalFile.
Syntax
ANSI (Cross Platform) int GetIncludeHeaders();
int SetIncludeHeaders(int bIncludeHeaders); Unicode (Windows) BOOL GetIncludeHeaders();
INT SetIncludeHeaders(BOOL bIncludeHeaders);
@property (nonatomic,readwrite,assign,getter=includeHeaders,setter=setIncludeHeaders:) BOOL includeHeaders; - (BOOL)includeHeaders; - (void)setIncludeHeaders:(BOOL)newIncludeHeaders;
int ipworks_pop_getincludeheaders(void* lpObj);
int ipworks_pop_setincludeheaders(void* lpObj, int bIncludeHeaders);
Default Value
FALSE
Remarks
This property instructs the component to include the headers in the MessageText and LocalFile. If set to true, the headers for the message you are retrieving will be placed before the message body in the MessageText property;. If LocalFile is set, then the headers will be written to that file before the message body. In this manner, the whole content of a MIME-encoded message can be passed to the MIME class for further message processing.
Data Type
Boolean
LastReply Property (POP Class)
The last reply from the server.
Syntax
ANSI (Cross Platform) char* GetLastReply(); Unicode (Windows) LPWSTR GetLastReply();
@property (nonatomic,readonly,assign,getter=lastReply) NSString* lastReply; - (NSString*)lastReply;
char* ipworks_pop_getlastreply(void* lpObj);
Default Value
""
Remarks
This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more can also be retrieved through the PITrail event.
This property is read-only.
Data Type
String
LocalFile Property (POP Class)
The path to a local file for downloading the message body. If the file exists, it is overwritten (optional).
Syntax
ANSI (Cross Platform) char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only Unicode (Windows) LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);
@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile; - (NSString*)localFile; - (void)setLocalFile:(NSString*)newLocalFile;
char* ipworks_pop_getlocalfile(void* lpObj);
wchar_t* ipworks_pop_getlocalfile_W(void* lpObj); // Windows only
int ipworks_pop_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworks_pop_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only
Default Value
""
Remarks
This property is used when retrieving a message. If this property is empty then the received data is provided through the parameters of the Transfer event. Note: If you are not retrieving the entire message (MaxLines is nonzero), no data will be written to LocalFile.
Data Type
String
LocalHost Property (POP Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost; - (NSString*)localHost; - (void)setLocalHost:(NSString*)newLocalHost;
char* ipworks_pop_getlocalhost(void* lpObj);
int ipworks_pop_setlocalhost(void* lpObj, const char* lpszLocalHost);
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
MailPort Property (POP Class)
The server port for POP (default 110).
Syntax
ANSI (Cross Platform) int GetMailPort();
int SetMailPort(int iMailPort); Unicode (Windows) INT GetMailPort();
INT SetMailPort(INT iMailPort);
@property (nonatomic,readwrite,assign,getter=mailPort,setter=setMailPort:) int mailPort; - (int)mailPort; - (void)setMailPort:(int)newMailPort;
int ipworks_pop_getmailport(void* lpObj);
int ipworks_pop_setmailport(void* lpObj, int iMailPort);
Default Value
110
Remarks
This property contains the server port for POP (default 110). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
For implicit SSL, use port 995 (please refer to the SSLStartMode property for more information).
This property is not available at design time.
Data Type
Integer
MailServer Property (POP Class)
The name or address of a mail server (internet post office server).
Syntax
ANSI (Cross Platform) char* GetMailServer();
int SetMailServer(const char* lpszMailServer); Unicode (Windows) LPWSTR GetMailServer();
INT SetMailServer(LPCWSTR lpszMailServer);
@property (nonatomic,readwrite,assign,getter=mailServer,setter=setMailServer:) NSString* mailServer; - (NSString*)mailServer; - (void)setMailServer:(NSString*)newMailServer;
char* ipworks_pop_getmailserver(void* lpObj);
int ipworks_pop_setmailserver(void* lpObj, const char* lpszMailServer);
Default Value
""
Remarks
This property specifies the IP address (IP number in dotted internet format) or the 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 this; property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful the class fails with an error.
If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.
Data Type
String
MaxLines Property (POP Class)
The maximum number of message lines besides headers to retrieve.
Syntax
ANSI (Cross Platform) int GetMaxLines();
int SetMaxLines(int iMaxLines); Unicode (Windows) INT GetMaxLines();
INT SetMaxLines(INT iMaxLines);
@property (nonatomic,readwrite,assign,getter=maxLines,setter=setMaxLines:) int maxLines; - (int)maxLines; - (void)setMaxLines:(int)newMaxLines;
int ipworks_pop_getmaxlines(void* lpObj);
int ipworks_pop_setmaxlines(void* lpObj, int iMaxLines);
Default Value
0
Remarks
This property is used to limit the number of text lines besides headers retrieved for messages. It can be used to preview message headers and a portion of their contents, without incurring the overhead of downloading the entire message.
The default value of the property is 0. In this case the entire message will be retrieved, without interruptions. Note: If you are not retrieving the entire message (MaxLines is nonzero), no data will be written to LocalFile.
Data Type
Integer
Message Property (POP Class)
Provides the raw message content.
Syntax
ANSI (Cross Platform) int GetMessage(char* &lpMessage, int &lenMessage); Unicode (Windows) INT GetMessage(LPSTR &lpMessage, INT &lenMessage);
@property (nonatomic,readonly,assign,getter=message) NSString* message; - (NSString*)message;
@property (nonatomic,readonly,assign,getter=messageB) NSData* messageB; - (NSData*)messageB;
int ipworks_pop_getmessage(void* lpObj, char** lpMessage, int* lenMessage);
Default Value
""
Remarks
This property is populated after calling Retrieve and holds the raw message content. This can be used to access the data before any processing is done by the class.
This property is read-only and not available at design time.
Data Type
Binary String
MessageCc Property (POP Class)
The value of the CC header of the last retrieved message.
Syntax
ANSI (Cross Platform) char* GetMessageCc(); Unicode (Windows) LPWSTR GetMessageCc();
@property (nonatomic,readonly,assign,getter=messageCc) NSString* messageCc; - (NSString*)messageCc;
char* ipworks_pop_getmessagecc(void* lpObj);
Default Value
""
Remarks
This property contains the value of the CC header of the last retrieved message. The same information may also be retrieved through the Header event.
This property is read-only.
Data Type
String
MessageCount Property (POP Class)
The number of messages in the mailbox.
Syntax
ANSI (Cross Platform) int GetMessageCount(); Unicode (Windows) INT GetMessageCount();
@property (nonatomic,readonly,assign,getter=messageCount) int messageCount; - (int)messageCount;
int ipworks_pop_getmessagecount(void* lpObj);
Default Value
0
Remarks
This property contains the number of messages in the mailbox. When the class is not connected to the server, the value of this property is 0. When connected, it contains the number of messages in the mail box as reported by the POP server.
This property is read-only.
Data Type
Integer
MessageDate Property (POP Class)
The value of the date header of the last retrieved message.
Syntax
ANSI (Cross Platform) char* GetMessageDate(); Unicode (Windows) LPWSTR GetMessageDate();
@property (nonatomic,readonly,assign,getter=messageDate) NSString* messageDate; - (NSString*)messageDate;
char* ipworks_pop_getmessagedate(void* lpObj);
Default Value
""
Remarks
This property contains the value of the date header of the last retrieved message. The same information may also be retrieved through the Header event.
This property is read-only.
Data Type
String
MessageFrom Property (POP Class)
The value of the from header of the last retrieved message.
Syntax
ANSI (Cross Platform) char* GetMessageFrom(); Unicode (Windows) LPWSTR GetMessageFrom();
@property (nonatomic,readonly,assign,getter=messageFrom) NSString* messageFrom; - (NSString*)messageFrom;
char* ipworks_pop_getmessagefrom(void* lpObj);
Default Value
""
Remarks
This property contains the value of the from header of the last retrieved message. The same information may also be retrieved through the Header event.
This property is read-only.
Data Type
String
MessageHeaderCount Property (POP Class)
The number of records in the MessageHeader arrays.
Syntax
ANSI (Cross Platform) int GetMessageHeaderCount(); Unicode (Windows) INT GetMessageHeaderCount();
@property (nonatomic,readonly,assign,getter=messageHeaderCount) int messageHeaderCount; - (int)messageHeaderCount;
int ipworks_pop_getmessageheadercount(void* lpObj);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MessageHeaderCount - 1.This property is read-only and not available at design time.
Data Type
Integer
MessageHeaderField Property (POP Class)
This property contains the name of the HTTP header (same case as it is delivered).
Syntax
ANSI (Cross Platform) char* GetMessageHeaderField(int iMessageHeaderIndex); Unicode (Windows) LPWSTR GetMessageHeaderField(INT iMessageHeaderIndex);
- (NSString*)messageHeaderField:(int)messageHeaderIndex;
char* ipworks_pop_getmessageheaderfield(void* lpObj, int messageheaderindex);
Default Value
""
Remarks
This property contains the name of the HTTP Header (same case as it is delivered).
The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
MessageHeaderValue Property (POP Class)
This property contains the header contents.
Syntax
ANSI (Cross Platform) char* GetMessageHeaderValue(int iMessageHeaderIndex); Unicode (Windows) LPWSTR GetMessageHeaderValue(INT iMessageHeaderIndex);
- (NSString*)messageHeaderValue:(int)messageHeaderIndex;
char* ipworks_pop_getmessageheadervalue(void* lpObj, int messageheaderindex);
Default Value
""
Remarks
This property contains the Header contents.
The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
MessageHeadersString Property (POP Class)
A string representation of the full headers of the message as retrieved from the server.
Syntax
ANSI (Cross Platform) char* GetMessageHeadersString(); Unicode (Windows) LPWSTR GetMessageHeadersString();
@property (nonatomic,readonly,assign,getter=messageHeadersString) NSString* messageHeadersString; - (NSString*)messageHeadersString;
char* ipworks_pop_getmessageheadersstring(void* lpObj);
Default Value
""
Remarks
This property contains a string representation of the full headers of the message as retrieved from the server. If the class is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the full headers of the mail message as reported by the server.
The MailServer is asked about the headers of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.
Example (Connect and Retrieve Message)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
MessageText = POPControl.MessageText
MessageHeadersString = POPControl.MessageHeadersString
This property is read-only.
Data Type
String
MessageNumber Property (POP Class)
Current (selected) message.
Syntax
ANSI (Cross Platform) int GetMessageNumber();
int SetMessageNumber(int iMessageNumber); Unicode (Windows) INT GetMessageNumber();
INT SetMessageNumber(INT iMessageNumber);
@property (nonatomic,readwrite,assign,getter=messageNumber,setter=setMessageNumber:) int messageNumber; - (int)messageNumber; - (void)setMessageNumber:(int)newMessageNumber;
int ipworks_pop_getmessagenumber(void* lpObj);
int ipworks_pop_setmessagenumber(void* lpObj, int iMessageNumber);
Default Value
1
Remarks
This property indicates the current/selected message. This property specifies a message number in between 1 and MessageCount. The various class methods related to single messages use this property as a message pointer (see method descriptions and the MessageSize property).
Data Type
Integer
MessageRecipientCount Property (POP Class)
The number of records in the MessageRecipient arrays.
Syntax
ANSI (Cross Platform) int GetMessageRecipientCount(); Unicode (Windows) INT GetMessageRecipientCount();
@property (nonatomic,readonly,assign,getter=messageRecipientCount) int messageRecipientCount; - (int)messageRecipientCount;
int ipworks_pop_getmessagerecipientcount(void* lpObj);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MessageRecipientCount - 1.This property is read-only and not available at design time.
Data Type
Integer
MessageRecipientAddress Property (POP Class)
This property contains the email address of the recipient.
Syntax
ANSI (Cross Platform) char* GetMessageRecipientAddress(int iRecipientIndex); Unicode (Windows) LPWSTR GetMessageRecipientAddress(INT iRecipientIndex);
- (NSString*)messageRecipientAddress:(int)recipientIndex;
char* ipworks_pop_getmessagerecipientaddress(void* lpObj, int recipientindex);
Default Value
""
Remarks
This property contains the email address of the recipient.
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is read-only and not available at design time.
Data Type
String
MessageRecipientName Property (POP Class)
This property contains name of the recipient.
Syntax
ANSI (Cross Platform) char* GetMessageRecipientName(int iRecipientIndex); Unicode (Windows) LPWSTR GetMessageRecipientName(INT iRecipientIndex);
- (NSString*)messageRecipientName:(int)recipientIndex;
char* ipworks_pop_getmessagerecipientname(void* lpObj, int recipientindex);
Default Value
""
Remarks
This property contains name of the recipient.
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is read-only and not available at design time.
Data Type
String
MessageRecipientOptions Property (POP Class)
This property contains the recipient sending options (used only by SMTP).
Syntax
ANSI (Cross Platform) char* GetMessageRecipientOptions(int iRecipientIndex); Unicode (Windows) LPWSTR GetMessageRecipientOptions(INT iRecipientIndex);
- (NSString*)messageRecipientOptions:(int)recipientIndex;
char* ipworks_pop_getmessagerecipientoptions(void* lpObj, int recipientindex);
Default Value
""
Remarks
This property contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).
One type of option is a delivery status notification sent per recipient which is specified by RFC 1891.
component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is read-only and not available at design time.
Data Type
String
MessageRecipientType Property (POP Class)
This property contains the recipient type: To, Cc, or BCc.
Syntax
ANSI (Cross Platform) int GetMessageRecipientType(int iRecipientIndex); Unicode (Windows) INT GetMessageRecipientType(INT iRecipientIndex);
Possible Values
RT_TO(0),
RT_CC(1),
RT_BCC(2)
- (int)messageRecipientType:(int)recipientIndex;
Possible Values
RT_TO(0),
RT_CC(1),
RT_BCC(2)
int ipworks_pop_getmessagerecipienttype(void* lpObj, int recipientindex);
Default Value
0
Remarks
This property contains the recipient type: To, Cc, or BCc.
The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.
This property is read-only and not available at design time.
Data Type
Integer
MessageReplyTo Property (POP Class)
The value of the Reply-To header of the last retrieved message.
Syntax
ANSI (Cross Platform) char* GetMessageReplyTo(); Unicode (Windows) LPWSTR GetMessageReplyTo();
@property (nonatomic,readonly,assign,getter=messageReplyTo) NSString* messageReplyTo; - (NSString*)messageReplyTo;
char* ipworks_pop_getmessagereplyto(void* lpObj);
Default Value
""
Remarks
This property contains the value of the Reply-To header of the last retrieved message. The same information may also be retrieved through the Header event.
This property is read-only.
Data Type
String
MessageSubject Property (POP Class)
The value of the Subject header of the last retrieved message.
Syntax
ANSI (Cross Platform) char* GetMessageSubject(); Unicode (Windows) LPWSTR GetMessageSubject();
@property (nonatomic,readonly,assign,getter=messageSubject) NSString* messageSubject; - (NSString*)messageSubject;
char* ipworks_pop_getmessagesubject(void* lpObj);
Default Value
""
Remarks
This property contains the value of the Subject header of the last retrieved message. The same information may also be retrieved through the Header event.
This property is read-only.
Data Type
String
MessageText Property (POP Class)
The full text of the message as retrieved from the server.
Syntax
ANSI (Cross Platform) char* GetMessageText(); Unicode (Windows) LPWSTR GetMessageText();
@property (nonatomic,readonly,assign,getter=messageText) NSString* messageText; - (NSString*)messageText;
char* ipworks_pop_getmessagetext(void* lpObj);
Default Value
""
Remarks
This property contains the full text of the message as retrieved from the server. If the class is not connected, or MessageNumber does not contain a valid message number, the value of this property is an empty string. Otherwise, it contains the text of the mail message as reported by the server (a maximum of MaxLines).
The MailServer is asked about the text of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.
Example (Connect and Retrieve Message)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
MessageText = POPControl.MessageText
MessageHeaders = POPControl.MessageHeaders
This property is read-only.
Data Type
String
MessageTo Property (POP Class)
The value of the To header of the last retrieved message.
Syntax
ANSI (Cross Platform) char* GetMessageTo(); Unicode (Windows) LPWSTR GetMessageTo();
@property (nonatomic,readonly,assign,getter=messageTo) NSString* messageTo; - (NSString*)messageTo;
char* ipworks_pop_getmessageto(void* lpObj);
Default Value
""
Remarks
This property contains the value of the To header of the last retrieved message. The same information may also be retrieved through the Header event.
This property is read-only.
Data Type
String
Password Property (POP Class)
The password for the mailbox user.
Syntax
ANSI (Cross Platform) char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password; - (NSString*)password; - (void)setPassword:(NSString*)newPassword;
char* ipworks_pop_getpassword(void* lpObj);
int ipworks_pop_setpassword(void* lpObj, const char* lpszPassword);
Default Value
""
Remarks
This property contains the password for the mailbox user. This property must be set before the class connects to the MailServer.
Data Type
String
SSLAcceptServerCertEncoded Property (POP Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded; - (NSString*)SSLAcceptServerCertEncoded; - (void)setSSLAcceptServerCertEncoded:(NSString*)newSSLAcceptServerCertEncoded;
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB; - (NSData*)SSLAcceptServerCertEncodedB; - (void)setSSLAcceptServerCertEncodedB:(NSData*)newSSLAcceptServerCertEncoded;
int ipworks_pop_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_pop_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (POP Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded; - (NSString*)SSLCertEncoded; - (void)setSSLCertEncoded:(NSString*)newSSLCertEncoded;
@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB; - (NSData*)SSLCertEncodedB; - (void)setSSLCertEncodedB:(NSData*)newSSLCertEncoded;
int ipworks_pop_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_pop_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (POP Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore; - (NSString*)SSLCertStore; - (void)setSSLCertStore:(NSString*)newSSLCertStore;
@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB; - (NSData*)SSLCertStoreB; - (void)setSSLCertStoreB:(NSData*)newSSLCertStore;
int ipworks_pop_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_pop_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (POP Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword; - (NSString*)SSLCertStorePassword; - (void)setSSLCertStorePassword:(NSString*)newSSLCertStorePassword;
char* ipworks_pop_getsslcertstorepassword(void* lpObj);
int ipworks_pop_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (POP Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_AUTO(99)
@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType; - (int)SSLCertStoreType; - (void)setSSLCertStoreType:(int)newSSLCertStoreType;
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_AUTO(99)
int ipworks_pop_getsslcertstoretype(void* lpObj);
int ipworks_pop_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
20 (cstSecurityKey) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (POP Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject; - (NSString*)SSLCertSubject; - (void)setSSLCertSubject:(NSString*)newSSLCertSubject;
char* ipworks_pop_getsslcertsubject(void* lpObj);
int ipworks_pop_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
Data Type
String
SSLEnabled Property (POP Class)
Whether TLS/SSL is enabled.
Syntax
ANSI (Cross Platform) int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled); Unicode (Windows) BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);
@property (nonatomic,readwrite,assign,getter=SSLEnabled,setter=setSSLEnabled:) BOOL SSLEnabled; - (BOOL)SSLEnabled; - (void)setSSLEnabled:(BOOL)newSSLEnabled;
int ipworks_pop_getsslenabled(void* lpObj);
int ipworks_pop_setsslenabled(void* lpObj, int bSSLEnabled);
Default Value
FALSE
Remarks
This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.
TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.
This property is not available at design time.
Data Type
Boolean
SSLProvider Property (POP Class)
TBD.
Syntax
ANSI (Cross Platform) int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider; - (int)SSLProvider; - (void)setSSLProvider:(int)newSSLProvider;
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int ipworks_pop_getsslprovider(void* lpObj);
int ipworks_pop_setsslprovider(void* lpObj, int iSSLProvider);
Default Value
0
Remarks
TBD.
Data Type
Integer
SSLServerCertEncoded Property (POP Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded); Unicode (Windows) INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded; - (NSString*)SSLServerCertEncoded;
@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB; - (NSData*)SSLServerCertEncodedB;
int ipworks_pop_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
SSLStartMode Property (POP Class)
Determines how the class starts the SSL negotiation.
Syntax
ANSI (Cross Platform) int GetSSLStartMode();
int SetSSLStartMode(int iSSLStartMode); Unicode (Windows) INT GetSSLStartMode();
INT SetSSLStartMode(INT iSSLStartMode);
Possible Values
SSL_AUTOMATIC(0),
SSL_IMPLICIT(1),
SSL_EXPLICIT(2),
SSL_NONE(3)
@property (nonatomic,readwrite,assign,getter=SSLStartMode,setter=setSSLStartMode:) int SSLStartMode; - (int)SSLStartMode; - (void)setSSLStartMode:(int)newSSLStartMode;
Possible Values
SSL_AUTOMATIC(0),
SSL_IMPLICIT(1),
SSL_EXPLICIT(2),
SSL_NONE(3)
int ipworks_pop_getsslstartmode(void* lpObj);
int ipworks_pop_setsslstartmode(void* lpObj, int iSSLStartMode);
Default Value
3
Remarks
The SSLStartMode property may have one of the following values:
0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). |
1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. |
2 (sslExplicit) | The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS. |
3 (sslNone - default) | No SSL negotiation, no SSL security. All communication will be in plaintext mode. |
Data Type
Integer
Timeout Property (POP Class)
A timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout; - (int)timeout; - (void)setTimeout:(int)newTimeout;
int ipworks_pop_gettimeout(void* lpObj);
int ipworks_pop_settimeout(void* lpObj, int iTimeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
User Property (POP Class)
The user identifier for the mailbox.
Syntax
ANSI (Cross Platform) char* GetUser();
int SetUser(const char* lpszUser); Unicode (Windows) LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);
@property (nonatomic,readwrite,assign,getter=user,setter=setUser:) NSString* user; - (NSString*)user; - (void)setUser:(NSString*)newUser;
char* ipworks_pop_getuser(void* lpObj);
int ipworks_pop_setuser(void* lpObj, const char* lpszUser);
Default Value
""
Remarks
This property contains the user identifier for the mailbox. This property must be set before the class connects to the MailServer.
Data Type
String
Config Method (POP Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
- (NSString*)config:(NSString*)configurationString;
char* ipworks_pop_config(void* lpObj, const char* lpszConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Connect Method (POP Class)
Connects to the mail server and attempts to login.
Syntax
ANSI (Cross Platform) int Connect(); Unicode (Windows) INT Connect();
- (void)connect;
int ipworks_pop_connect(void* lpObj);
Remarks
This method connects to the mail server and attempts to login using the current User and Password. Then it retrieves initial statistics about the mailbox contents (MessageCount and TotalSize).
Example (Connect to POP Mailbox)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
POPControl.Retrieve()
MessageText = POPControl.MessageText
MessageHeaders = POPControl.MessageHeaders
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Delete Method (POP Class)
Deletes a message specified by MessageNumber on the server.
Syntax
ANSI (Cross Platform) int Delete(); Unicode (Windows) INT Delete();
- (void)delete;
int ipworks_pop_delete(void* lpObj);
Remarks
This method asks the MailServer to delete the message specified by MessageNumber. The message will not actually be deleted from the server until the connection is closed. In order to cancel a previous Delete, use the Reset method.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Disconnect Method (POP Class)
Disconnects from the mail server.
Syntax
ANSI (Cross Platform) int Disconnect(); Unicode (Windows) INT Disconnect();
- (void)disconnect;
int ipworks_pop_disconnect(void* lpObj);
Remarks
This method makes the class disconnect from the MailServer by sending the QUIT command. If successful, all changes to the mailbox are committed by the server. Otherwise, changes are rolled back to the initial state that the server was in before the connection.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (POP Class)
Processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
- (void)doEvents;
int ipworks_pop_doevents(void* lpObj);
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Interrupt Method (POP Class)
Interrupt the current method.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
- (void)interrupt;
int ipworks_pop_interrupt(void* lpObj);
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListMessageSizes Method (POP Class)
Retrieves a list of all message sizes from the server.
Syntax
ANSI (Cross Platform) int ListMessageSizes(); Unicode (Windows) INT ListMessageSizes();
- (void)listMessageSizes;
int ipworks_pop_listmessagesizes(void* lpObj);
Remarks
This message retrieves a list of all message sizes from the server. For each message listed, a MessageList event will fire containing the number and size of the message.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ListMessageUIDs Method (POP Class)
Retrieves a list of all message UIDs from the server.
Syntax
ANSI (Cross Platform) int ListMessageUIDs(); Unicode (Windows) INT ListMessageUIDs();
- (void)listMessageUIDs;
int ipworks_pop_listmessageuids(void* lpObj);
Remarks
This method retrieves a list of all message UIDs from the server. For each message listed, a MessageList event will fire containing the number and UID of the message.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
LocalizeDate Method (POP Class)
Converts a valid RFC 822 message date to local date and time.
Syntax
ANSI (Cross Platform) char* LocalizeDate(const char* lpszDateTime); Unicode (Windows) LPWSTR LocalizeDate(LPCWSTR lpszDateTime);
- (NSString*)localizeDate:(NSString*)dateTime;
char* ipworks_pop_localizedate(void* lpObj, const char* lpszDateTime);
Remarks
This method can be used to convert an RFC 822 date/time string to the corresponding local date and time.
Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
QueryMessageSize Method (POP Class)
Returns the size in bytes of the current message.
Syntax
ANSI (Cross Platform) int64 QueryMessageSize(); Unicode (Windows) LONG64 QueryMessageSize();
- (long long)queryMessageSize;
int64 ipworks_pop_querymessagesize(void* lpObj);
Remarks
This method queries the server for the size in bytes of the message specified by MessageNumber. The method returns the size (in bytes) of the message.
If the class is not connected, or MessageNumber does not contain a valid message number, the return value is 0. Otherwise, it returns the size of the mail message (including headers) as reported by the server.
The MailServer is asked about the size of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.
Error Handling (C++)
This method returns a Long64 value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
QueryMessageUID Method (POP Class)
Returns the unique identifier of the message as specified by the server.
Syntax
ANSI (Cross Platform) char* QueryMessageUID(); Unicode (Windows) LPWSTR QueryMessageUID();
- (NSString*)queryMessageUID;
char* ipworks_pop_querymessageuid(void* lpObj);
Remarks
This method returns the unique identifier of the message specified by MessageNumber. If the class is not connected, or MessageNumber does not contain a valid message number, the return value of this method is an empty string. Otherwise, it returns the UID of the mail message as reported by the server.
The MailServer is asked about the UID of the message only if the MessageNumber property has changed. If MessageNumber has not changed, the class returns a cached value.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
QueryTotalSize Method (POP Class)
Returns the cumulative size in bytes of messages in the mailbox (including headers).
Syntax
ANSI (Cross Platform) int64 QueryTotalSize(); Unicode (Windows) LONG64 QueryTotalSize();
- (long long)queryTotalSize;
int64 ipworks_pop_querytotalsize(void* lpObj);
Remarks
This method returns the cumulative size in bytes of messages in the mailbox (including headers). When the class is not connected to the server, the return value of this method is 0. When connected, it returns the cumulative size of all the messages in the mail box as reported by the POP server.
Error Handling (C++)
This method returns a Long64 value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Reset Method (POP Class)
Resets all changes and revert back to the state when the user first connected.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
- (void)reset;
int ipworks_pop_reset(void* lpObj);
Remarks
This method is used to reset all changes and revert back to the state when the user first connected. Asks the MailServer to reset all changes and revert back to the state it was when connected.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Retrieve Method (POP Class)
Retrieves a message specified by MessageNumber from the server.
Syntax
ANSI (Cross Platform) int Retrieve(); Unicode (Windows) INT Retrieve();
- (void)retrieve;
int ipworks_pop_retrieve(void* lpObj);
Remarks
This method is used to retrieve a message specified by MessageNumber from the server. It asks the MailServer to retrieve the message specified by MessageNumber. The message headers will arrive in the Header event, and the message text will arrive in the Transfer event.
The MaxLines property defines the number of lines retrieved.
Example (Connect and Retrieve Message)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
POPControl.Retrieve()
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
RetrieveHeaders Method (POP Class)
Retrieves headers for a message specified by MessageNumber .
Syntax
ANSI (Cross Platform) int RetrieveHeaders(); Unicode (Windows) INT RetrieveHeaders();
- (void)retrieveHeaders;
int ipworks_pop_retrieveheaders(void* lpObj);
Remarks
Calling this method will retrieve the headers for the message specified by the MessageNumber property. The message headers will be provided by the Header event and also stored in the MessageHeaders property.
Example (Connect and Retrieve Message Headers)
POPControl.MailServer = "MyPOPServer"
POPControl.User = "username"
POPControl.Password = "password"
POPControl.Connect()
POPControl.MessageNumber = 1
POPControl.RetrieveHeaders()
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendCommand Method (POP Class)
Sends the exact command directly to the server.
Syntax
ANSI (Cross Platform) int SendCommand(const char* lpszCommand); Unicode (Windows) INT SendCommand(LPCWSTR lpszCommand);
- (void)sendCommand:(NSString*)command;
int ipworks_pop_sendcommand(void* lpObj, const char* lpszCommand);
Remarks
This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.
After calling this method check the LastReply property and/or monitor the PITrail event to obtain the server's response.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetMessageStream Method (POP Class)
Sets the stream to which the message downloaded from the server will be written.
Syntax
ANSI (Cross Platform) int SetMessageStream(IPWorksStream* sMessageStream); Unicode (Windows) INT SetMessageStream(IPWorksStream* sMessageStream);
int ipworks_pop_setmessagestream(void* lpObj, IPWorksStream* sMessageStream);
Remarks
This method sets the stream to which the message downloaded from the server will be written. If a download stream is set before the Retrieve method is called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is set to true (default). If the stream is closed, you will need to call SetMessageStream again before calling Retrieve again. The downloaded content will be written starting at the current position in the stream.
Note: SetMessageStream and LocalFile will reset the other.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ConnectionStatus Event (POP Class)
Fired to indicate changes in connection state.
Syntax
ANSI (Cross Platform) virtual int FireConnectionStatus(POPConnectionStatusEventParams *e);
typedef struct {
const char *ConnectionEvent;
int StatusCode;
const char *Description; int reserved; } POPConnectionStatusEventParams;
Unicode (Windows) virtual INT FireConnectionStatus(POPConnectionStatusEventParams *e);
typedef struct {
LPCWSTR ConnectionEvent;
INT StatusCode;
LPCWSTR Description; INT reserved; } POPConnectionStatusEventParams;
- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;
#define EID_POP_CONNECTIONSTATUS 1 virtual INT IPWORKS_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);
Remarks
The ConnectionStatus event is fired when the connection state changes: completion of a firewall or proxy connection, completion of a security handshake, etc.
The ConnectionEvent parameter indicates the type of connection event. Values may include:
Firewall connection complete. | |
SSL or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
EndTransfer Event (POP Class)
Fired when the message completes transferring.
Syntax
ANSI (Cross Platform) virtual int FireEndTransfer(POPEndTransferEventParams *e);
typedef struct {
int Direction; int reserved; } POPEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(POPEndTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } POPEndTransferEventParams;
- (void)onEndTransfer:(int)direction;
#define EID_POP_ENDTRANSFER 2 virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);
Remarks
The EndTransfer event is fired when the message body completes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (POP Class)
Information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(POPErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } POPErrorEventParams;
Unicode (Windows) virtual INT FireError(POPErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } POPErrorEventParams;
- (void)onError:(int)errorCode :(NSString*)description;
#define EID_POP_ERROR 3 virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Header Event (POP Class)
Fired for every message header being retrieved.
Syntax
ANSI (Cross Platform) virtual int FireHeader(POPHeaderEventParams *e);
typedef struct {
const char *Field;
const char *Value; int reserved; } POPHeaderEventParams;
Unicode (Windows) virtual INT FireHeader(POPHeaderEventParams *e);
typedef struct {
LPCWSTR Field;
LPCWSTR Value; INT reserved; } POPHeaderEventParams;
- (void)onHeader:(NSString*)field :(NSString*)value;
#define EID_POP_HEADER 4 virtual INT IPWORKS_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);
Remarks
The Field parameter contains the name of the header (same case as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
MessageList Event (POP Class)
Fired for every message listed by ListMessageSizes and/or ListMessageUIDs .
Syntax
ANSI (Cross Platform) virtual int FireMessageList(POPMessageListEventParams *e);
typedef struct {
int MessageNumber;
const char *MessageUID;
int MessageSize; int reserved; } POPMessageListEventParams;
Unicode (Windows) virtual INT FireMessageList(POPMessageListEventParams *e);
typedef struct {
INT MessageNumber;
LPCWSTR MessageUID;
INT MessageSize; INT reserved; } POPMessageListEventParams;
- (void)onMessageList:(int)messageNumber :(NSString*)messageUID :(int)messageSize;
#define EID_POP_MESSAGELIST 5 virtual INT IPWORKS_CALL FireMessageList(INT &iMessageNumber, LPSTR &lpszMessageUID, INT &iMessageSize);
Remarks
When ListMessageSizes is called, MessageSize is valid, and MessageUID is always an empty string.
When ListMessageUIDs is called, MessageUID is valid, and MessageSize is 0.
PITrail Event (POP Class)
Traces the commands sent to the mail server, and the respective replies.
Syntax
ANSI (Cross Platform) virtual int FirePITrail(POPPITrailEventParams *e);
typedef struct {
int Direction;
const char *Message; int reserved; } POPPITrailEventParams;
Unicode (Windows) virtual INT FirePITrail(POPPITrailEventParams *e);
typedef struct {
INT Direction;
LPCWSTR Message; INT reserved; } POPPITrailEventParams;
- (void)onPITrail:(int)direction :(NSString*)message;
#define EID_POP_PITRAIL 6 virtual INT IPWORKS_CALL FirePITrail(INT &iDirection, LPSTR &lpszMessage);
Remarks
The PITrail event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line, except for message header and body transfers.
The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:
0 (Client) | The Message originates from the client. |
1 (Server) | The Message originates from the server. |
2 (Info) | The Message is an informative message originating from the client software (the class code). |
SSLServerAuthentication Event (POP Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(POPSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } POPSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(POPSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } POPSSLServerAuthenticationEventParams;
- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;
#define EID_POP_SSLSERVERAUTHENTICATION 7 virtual INT IPWORKS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (POP Class)
Shows the progress of the secure connection.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(POPSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } POPSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(POPSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } POPSSLStatusEventParams;
- (void)onSSLStatus:(NSString*)message;
#define EID_POP_SSLSTATUS 8 virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
StartTransfer Event (POP Class)
Fired when the message starts transferring.
Syntax
ANSI (Cross Platform) virtual int FireStartTransfer(POPStartTransferEventParams *e);
typedef struct {
int Direction; int reserved; } POPStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(POPStartTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } POPStartTransferEventParams;
- (void)onStartTransfer:(int)direction;
#define EID_POP_STARTTRANSFER 9 virtual INT IPWORKS_CALL FireStartTransfer(INT &iDirection);
Remarks
The StartTransfer event is fired when the message body starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (POP Class)
Fired while the message gets transferred from MailServer .
Syntax
ANSI (Cross Platform) virtual int FireTransfer(POPTransferEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText;
int EOL; int reserved; } POPTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(POPTransferEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText;
BOOL EOL; INT reserved; } POPTransferEventParams;
- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text :(BOOL)EOL;
#define EID_POP_TRANSFER 10 virtual INT IPWORKS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText, BOOL &bEOL);
Remarks
The Text parameter contains the portion of the message data being retrieved.
The BytesTransferred parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e. when the last Transfer event is fired), BytesTransferred equals the value of the MessageSize property.
The Transfer event is fired for every line of the message. For complete lines, there is no terminating newline at the end of the Text parameter, and EOL is True. The EOL parameter is False when a line is broken (usually for being too long).
A faster way to retrieve a message is to assign a value to the LocalFile property and use the Transfer event to check the progress rather than to get the actual data.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.
NOTE: For the PercentDone parameter value to be correct, the GetMessageSize must be set to true.
IPWorksStream Type
Syntax
IPWorksStream (declared in ipworks.h)
Remarks
The POP class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksStream interface and pass the POP class an instance of that concrete class.
When implementing the IPWorksStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Properties | |
CanRead |
Whether the stream supports reading.
bool CanRead() { return true; } |
CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; } |
CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; } |
Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {} This method is called automatically when an IPWorksStream object is deleted. |
Flush |
Forces all data held by the stream's buffers to be written out to storage.
int Flush() { return 0; } Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
int Read(void* buffer, int count) = 0; Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
Seek |
Sets the current position within the stream based on a particular point of origin.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
int Write(const void* buffer, int count) = 0; Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
Configuration Settings (POP Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.POP Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AuthorizationIdentity: The value to use as the authorization identity when SASL authentication is used. When AuthMechanism is set to amSASLPlain or amSASLDigestMD5 you may use this setting to specify an authorization identity to be used when authenticating. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AutoDecodeSubject: Instructs the class to automatically decode message subjects.Subjects that have been Quoted-Printable or Base-64 encoded are automatically decoded when this configuration setting is True (default). Only subjects in the format "=?iso-8859-1?Q?data?=" will be correctly decoded. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GetMessageSize: Whether to poll the server for the message size prior to retrieving it.By default this value is False. When set to true, the class will retrieve the message size from the server before downloading it and the PercentDone parameter of the Transfer event will be populated. When this value is False (default), the PercentDone parameter of the Transfer event will not be updated and will evaluate to -1. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxLineLength: The maximum expected length for message lines.Normally, internet mail message lines are up to 80 bytes long, however, different mail systems might use other values. Change the value of this property if you are expecting longer lines. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IPPort Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConnectionTimeout: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.This setting is provided for use by classs that do not directly expose Firewall properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallHost:
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 setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPassword:
Password to be used if authentication is to be used when connecting through the firewall.If FirewallHost is specified, the FirewallUser and FirewallPassword settings
are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
NOTE: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPort:
The TCP port for the FirewallHost;.Note that the FirewallPort is set automatically when FirewallType is set to a valid value.
NOTE: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallType:
Determines the type of firewall to connect through.The appropriate values are as follows:
NOTE: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallUser:
A user name if authentication is to be used connecting through a firewall.If the FirewallHost is specified, the FirewallUser and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
NOTE: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveInterval:
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, TCPKeepAlive will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet
will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveRetryCount:
The number of keep-alive packets to be sent before the remotehost is considered disconnected.When set, TCPKeepAlive will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet
will be re-sent. This setting specifies the number of times that the keep-alive packets will be re-sent before the remote host
is considered disconnected.
The system default if this value is not specified here is 9.
Note: This configuration setting is only available in the Unix platform, and isn't supported in Mac OS or FreeBSD. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Linger:
When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires. In the second scenario, LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LingerTime: Time in seconds to have the connection linger. LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalHost:
The name of the local host through which connections are initiated or accepted.
The LocalHost setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalPort:
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxLineLength:
The maximum amount of data to accumulate when no EOL is found.MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL
string.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset. If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxTransferRate: The transfer rate limit in bytes per second.This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyExceptionsList:
A semicolon separated list of hosts and IPs to bypass when using a proxy.This setting optionally specifies a semicolon separated list of hostnames or IP addresses to bypass when a proxy is in use.
When requests are made to hosts specified in this property the proxy will not be used. For instance:
www.google.com;www.nsoftware.com |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPKeepAlive:
Determines whether or not the keep alive socket option is enabled.If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically
to maintain the connection. Set KeepAliveTime and KeepAliveInterval to
configure the timing of the keep-alive packets.
Note: This value is not applicable in Java. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TcpNoDelay:
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSL Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogSSLPackets:
Controls whether SSL packets are logged when using the internal security API.When the UseInternalSecurityAPI configuration setting is True, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if UseInternalSecurityAPI is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLCADir:
The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLCAFile:
Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLCipherList:
A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OpenSSLPrngSeedData:
The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the class will reuse the context if and only if the following criteria are met:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCACertFilePaths:
The paths to CA certificate files on Unix/Linux.This setting specifies the paths on disk to CA certificate files on Unix/Linux.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server certificates. The default value is: /etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCACerts:
A newline separated list of CA certificate to use during SSL client authentication.This setting specifies one or more CA certificates to be included in the request when performing
SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented
when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCipherStrength:
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnabledCipherSuites:
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when UseInternalSecurityAPI is False (default):
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when UseInternalSecurityAPI is True include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
SSLEnabledCipherSuites is used together with SSLCipherStrength. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnabledProtocols:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList setting. Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7. Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLEnableRenegotiation:
Whether the renegotiation_info SSL extension is supported.This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API.
This setting is true by default, but can be set to false to disable the extension.
This setting is only applicable when UseInternalSecurityAPI is set to true. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains
the full certificate chain. By default this value is False and only the leaf certificate will be present
in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLKeyLogFile:
The location of a file where per-session secrets are written for debugging purposes.This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values. Note: This setting is only applicable when UseInternalSecurityAPI is set to True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipher:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength.Returns the strength of the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchange:
Returns the negotiated key exchange algorithm.Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedKeyExchangeStrength:
Returns the negotiated key exchange algorithm strength.Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLNegotiatedProtocol:
Returns the negotiated protocol version.Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLProvider:
The name of the security provider to use.
Change this setting to use security providers other than the system default.
Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application. The special value "*" (default) picks the default SSL provider defined in the system. Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed . |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLSecurityFlags:
Flags that control certificate verification.The following flags are defined (specified in hexadecimal
notation). They can be or-ed together to exclude multiple
conditions:
This functionality is currently not available when the provider is OpenSSL. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLServerCACerts:
A newline separated list of CA certificate to use during SSL server certificate validation.This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS12SignatureAlgorithms:
Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is
True and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error. The format of this value is a comma separated list of hash-signature combinations. For instance:
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS12SupportedGroups:
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13KeyShareGroups:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13Provider:
The TLS 1.3 implementation to be used.This setting specifies the TLS 1.3 implementation which will be used when TLS 1.3 is enabled via SSLEnabledProtocols. Possible values are:
The platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to 1 (Platform provider) please be aware of the following notes:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SupportedGroups:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation. By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API. |
Trappable Errors (POP Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
POP Errors
116 MailPort can't be zero. Please specify a valid service port number. | |
118 Firewall error. Error message contains detailed description. | |
171 POP protocol error. Description contains the server reply. | |
172 Error communicating with server. Error text is attached. | |
173 Please specify a valid MailServer. | |
174 Busy executing current method. |
The class may also return one of the following error codes, which are inherited from other classes.
IPPort Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 Cannot change UseConnection option while the class is Active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |