Struct ipworkspgp::PPOP

Properties   Methods   Events   Config Settings   Errors  

The PPOP struct is used retrieve and process OpenPGP encrypted and/or signed messages from Internet Post Office servers (POP).

Syntax

ipworkspgp::PPOP

Remarks

The PPOP struct implements a standard internet post office (POP3) client, as specified in RFC 1725, and supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. You can send an OpenPGP signed and encrypted message using the PSMTP struct by calling the encrypt, sign, and sign_and_encrypt methods.

Connect to the Server

To connect to a mail_server, first set the appropriate user and password and then connect by calling the connect method. Upon successful connection to the mail_server, the number of waiting messages is shown by the message_count property. A message is selected by setting the message_number property to a number between 1 and message_count (inclusive). Then, the message text and/or headers are received by calling the retrieve method.

Receive Messages

The message text is received through the on_transfer event, whereas the message headers are received through the on_header event. Additionally, up to max_lines from the message body are provided in the message_text property. The on_start_transfer and on_end_transfer events are fired at the beginning and end of message transmission. The on_pi_trail event provides a trace of the interaction between the client and server (excluding message transfers).

Verify

To verify the signature of a message specify the public key to be used for signature verification by setting the SignerKey* properties. For instance: PPOP1.SignerKeyCount = 1 PPOP1.SignerKeyKeyring(0) = "c:\my_keyring_dir" PPOP1.SignerKeyUserId(0) = "sender@nsoftware.com" The specified public key will be used to verify the signature when calling verify_signature.

Decrypt

To process an encrypted or signed message first retrieve the message text and headers by calling retrieve. To decrypt a message specify the private key to be used for decryption by setting the Key* properties. For instance: PPOP1.KeyCount = 1 PPOP1.KeyKeyring(0) = "c:\my_keyring_dir" PPOP1.KeyUserId(0) = "recipient@nsoftware.com" PPOP1.KeyPassphrase(0) = "password" The specified private key will be used to decrypt the message when calling decrypt.

Decrypt and Verify

To decrypt and verify in one step, you can call decrypt_and_verify_signature. Set the public key of the sender in the and the private key to be used for decryption in the Key* properties .

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksPGP. Due to this, the PPOP struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of PPOP when you have finished using the instance.

Property List

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

Method List

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

Event List

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

Config Settings

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

auth_mechanism property (PPOP Struct)

This property includes the authentication mechanism to be used when connecting to the mail server.

Syntax

fn auth_mechanism(&self ) -> Result<i32, IPWorksPGPError> 
fn set_auth_mechanism(&self, value : i32) ->  Option<IPWorksPGPError> 

Possible Values

0   // UserPassword
1   // CRAMMD5
2   // NTLM
3   // APOP
4   // SASLPlain
5   // SASLDigestMD5
6   // Kerberos
7   // XOAUTH2

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 log in 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 Sockets Layer (SSL) connection when utilizing this authentication mechanism.

amKerberos (6) is for Kerberos authentication. NOTE: This functionality is available only in Windows.

Data Type

i32

connected property (PPOP Struct)

Whether the struct is connected.

Syntax

fn connected(&self ) -> Result<bool, IPWorksPGPError> 

Default Value

false

Remarks

This property is used to determine whether or not the struct is connected to the remote host. Use the connect and disconnect methods to manage the connection.

This property is read-only.

Data Type

bool

firewall_auto_detect property (PPOP Struct)

Whether to automatically detect and use firewall system settings, if available.

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, IPWorksPGPError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<IPWorksPGPError> 

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

firewall_type property (PPOP Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, IPWorksPGPError> 
fn set_firewall_type(&self, value : i32) ->  Option<IPWorksPGPError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

i32

firewall_host property (PPOP Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, IPWorksPGPError> 
fn set_firewall_host(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host 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 struct fails with an error.

Data Type

String

firewall_password property (PPOP Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, IPWorksPGPError> 
fn set_firewall_password(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (PPOP Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, IPWorksPGPError> 
fn set_firewall_port(&self, value : i32) ->  Option<IPWorksPGPError> 

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

NOTE: This property is set automatically when firewall_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (PPOP Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, IPWorksPGPError> 
fn set_firewall_user(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

idle property (PPOP Struct)

The current status of the struct.

Syntax

fn idle(&self ) -> Result<bool, IPWorksPGPError> 

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

bool

include_headers property (PPOP Struct)

This property instructs the struct to include the headers in the MessageText and LocalFile.

Syntax

fn include_headers(&self ) -> Result<bool, IPWorksPGPError> 
fn set_include_headers(&self, value : bool) ->  Option<IPWorksPGPError> 

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 being retrieved will be placed before the message body in the message_text property;. If local_file 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 struct for further message processing.

Data Type

bool

key_count property (PPOP Struct)

The number of records in the Key arrays.

Syntax

fn key_count(&self ) -> Result<i32, IPWorksPGPError> 
fn set_key_count(&self, value : i32) ->  Option<IPWorksPGPError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• key_curve
• key_effective_date
• key_encoded
• key_expiration_date
• key_fingerprint
• key_id
• key_other_user_ids
• key_passphrase
• key_public_key
• key_public_key_algorithm
• key_public_key_length
• key_revoked
• keyring
• key_secret_key
• key_secret_key_available
• key_usage
• key_usage_flags
• key_user_id
• key_version

The array indices start at 0 and end at key_count - 1.

Data Type

i32

key_curve property (PPOP Struct)

This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 .

Syntax

fn key_curve(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property specifies the elliptic curve if key_public_key_algorithm is ECDSA, EdDSA, Ed25519, Ed448, ML-DSA-65+Ed25519, or ML-DSA-87+Ed448. Possible values are:

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

key_effective_date property (PPOP Struct)

The date when this key becomes valid.

Syntax

fn key_effective_date(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date:

23-Jan-2000 15:00:00.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

key_expiration_date property (PPOP Struct)

The date the key expires.

Syntax

fn key_expiration_date(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date:

23-Jan-2001 15:00:00.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

keyring property (PPOP Struct)

The location of the keyring.

Syntax

fn keyring(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 
fn set_keyring(&self, KeyIndex : i32, value : &str) ->  Option<IPWorksPGPError> 
fn set_keyring_ref(&self, KeyIndex : i32, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The location of the keyring.

If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.

When This property is set the struct will read the keyring and populate the key property with the first key found in the keyring. Set key_user_id to select a different key in the current keyring.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

String

key_other_user_ids property (PPOP Struct)

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

Syntax

fn key_other_user_ids(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

key_passphrase property (PPOP Struct)

The passphrase for the key's secret key (if any).

Syntax

fn key_passphrase(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 
fn set_key_passphrase(&self, KeyIndex : i32, value : &str) ->  Option<IPWorksPGPError> 
fn set_key_passphrase_ref(&self, KeyIndex : i32, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the on_key_passphrase event, which will fire when a passphrase is required.

The passphrase is required when using the following methods in KeyMgr:

• add_user_id
• sign_user_id
• change_expiration_date
• change_passphrase

When using the OpenPGP struct, or an email-based struct, the following methods require a passphrase for the key:

• decrypt
• sign
• sign_and_encrypt

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

String

key_public_key property (PPOP Struct)

The public key of the key.

Syntax

fn key_public_key(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The public key of the key. The key is provided as ASCII armored data.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

key_public_key_algorithm property (PPOP Struct)

A text description of the public key algorithm of the key.

Syntax

fn key_public_key_algorithm(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

A text description of the public key algorithm of the key. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• ML-DSA-65+Ed25519
• ML-DSA-87+Ed448
• RSA-Legacy

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

key_public_key_length property (PPOP Struct)

The length of the public key in bits.

Syntax

fn key_public_key_length(&self , KeyIndex : i32) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

The length of the public key in bits. Common values are 1024, 2048, and 3072.

If the key_public_key_algorithm property is ECDSA, EdDSA, Ed25519, Ed448, ML-DSA-65+Ed25519, or ML-DSA-87+Ed448, the length of the public key is determined by the key_curve. Possible lengths are:

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

i32

key_revoked property (PPOP Struct)

Whether or not the key is revoked.

Syntax

fn key_revoked(&self , KeyIndex : i32) -> Result<bool, IPWorksPGPError> 

Default Value

false

Remarks

Whether or not the key is revoked.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

key_secret_key property (PPOP Struct)

The secret key of the key (if available).

Syntax

fn key_secret_key(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The secret key of the key (if available). The key is provided as ASCII armored data.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

key_secret_key_available property (PPOP Struct)

Whether or not a secret key is available for the selected key.

Syntax

fn key_secret_key_available(&self , KeyIndex : i32) -> Result<bool, IPWorksPGPError> 

Default Value

false

Remarks

Whether or not a secret key is available for the selected key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

bool

key_usage property (PPOP Struct)

A text description of UsageFlags .

Syntax

fn key_usage(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

A text description of key_usage_flags.

The value will be of one or more of the following strings, separated by commas:

• Certifying Other Certificates
• Signing Emails and Files
• Encrypting Emails and Files
• Split Key
• Authenticate Against Servers
• Group Key

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

String

key_usage_flags property (PPOP Struct)

Flags that show the intended use for the key.

Syntax

fn key_usage_flags(&self , KeyIndex : i32) -> Result<i32, IPWorksPGPError> 

Default Value

47

Remarks

Flags that show the intended use for the key. The default value is 0x0F. The value of key_usage_flags is a combination of the following flags:

Please refer to the key_usage property for a text representation of key_usage_flags.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

i32

key_version property (PPOP Struct)

This property can be used to query the OpenPGP version of the currently selected Key .

Syntax

fn key_version(&self , KeyIndex : i32) -> Result<i32, IPWorksPGPError> 

Default Value

4

Remarks

This property can be used to query the OpenPGP version of the currently selected key. Possible values are:

• 4 - OpenPGP v4 (default)
• 5 - LibrePGP v5
• 6 - OpenPGP v6

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only.

Data Type

i32

key_user_id property (PPOP Struct)

The user Id of the key.

Syntax

fn key_user_id(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 
fn set_key_user_id(&self, KeyIndex : i32, value : &str) ->  Option<IPWorksPGPError> 
fn set_key_user_id_ref(&self, KeyIndex : i32, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the key_keyring. When this property is set the struct will search the key_keyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and key_other_user_ids after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as its identifier instead.

When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The struct will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP struct's on_recipient_info event.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

String

key_id property (PPOP Struct)

The hex-encoded, 4-byte or 8-byte key Id.

Syntax

fn key_id(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 
fn set_key_id(&self, KeyIndex : i32, value : &str) ->  Option<IPWorksPGPError> 
fn set_key_id_ref(&self, KeyIndex : i32, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 4-byte or 8-byte key Id. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

When a key is loaded, this property is populated with the Id associated with the key. This property may be set to load a key from the key_keyring. When this property is set the struct will search the key_keyring for a key associated with the Id specified.

The KeyIdLength setting may be set to control the length of the returned key Id.

NOTE: It is recommended to use the key_fingerprint property when loading a key from the key_keyring, as it is possible for different keys to have the same Id.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

String

key_fingerprint property (PPOP Struct)

The hex-encoded, 20-byte fingerprint of the key.

Syntax

fn key_fingerprint(&self , KeyIndex : i32) -> Result<String, IPWorksPGPError> 
fn set_key_fingerprint(&self, KeyIndex : i32, value : &str) ->  Option<IPWorksPGPError> 
fn set_key_fingerprint_ref(&self, KeyIndex : i32, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 20-byte fingerprint of the key.

When a key is loaded, this property is populated with the Fingerprint associated with the key. This property may be set to load a key from the key_keyring. When this property is set the struct will search the key_keyring for a key associated with the Fingerprint specified.

This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

String

key_encoded property (PPOP Struct)

The key.

Syntax

fn key_encoded(&self , KeyIndex : i32) -> Result<Vec<u8>, IPWorksPGPError> 
fn set_key_encoded(&self, KeyIndex : i32, value : Vec<u8>) ->  Option<IPWorksPGPError> 
fn set_key_encoded_ref(&self, KeyIndex : i32, value : &[u8]) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The key. This property can be used to assign a specific key. The key_fingerprint, key_id, and key_user_id properties may also be used to specify a key.

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

Data Type

Vec

last_reply property (PPOP Struct)

This property indicates the last reply received from the server.

Syntax

fn last_reply(&self ) -> Result<String, IPWorksPGPError> 

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 also can be retrieved through the on_pi_trail event.

This property is read-only.

Data Type

String

local_host property (PPOP Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, IPWorksPGPError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

mail_port property (PPOP Struct)

This property includes the server port for POP (default 110).

Syntax

fn mail_port(&self ) -> Result<i32, IPWorksPGPError> 
fn set_mail_port(&self, value : i32) ->  Option<IPWorksPGPError> 

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 Secure Sockets Layer (SSL), use port 995 (please refer to the ssl_start_mode property for more information).

Data Type

i32

mail_server property (PPOP Struct)

This property includes the name or address of a mail server (internet post office server).

Syntax

fn mail_server(&self ) -> Result<String, IPWorksPGPError> 
fn set_mail_server(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_mail_server_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

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. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

If the struct 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

max_lines property (PPOP Struct)

This property includes the maximum number of message lines other than headers to retrieve.

Syntax

fn max_lines(&self ) -> Result<i32, IPWorksPGPError> 
fn set_max_lines(&self, value : i32) ->  Option<IPWorksPGPError> 

Default Value

0

Remarks

This property is used to limit the number of text lines other than 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 (max_lines is nonzero), no data will be written to local_file.

Data Type

i32

message property (PPOP Struct)

This property provides the raw message content.

Syntax

fn message(&self ) -> Result<Vec<u8>, IPWorksPGPError> 

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 struct.

This property is read-only.

Data Type

Vec

message_cc property (PPOP Struct)

This property includes the value of the CC header of the last retrieved message.

Syntax

fn message_cc(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property contains the value of the CC header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

Data Type

String

message_count property (PPOP Struct)

This property includes the number of messages in the mailbox.

Syntax

fn message_count(&self ) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

This property contains the number of messages in the mailbox. When the struct is not connected to the server, the value of this property is 0. When connected, it contains the number of messages in the mailbox as reported by the POP server.

This property is read-only.

Data Type

i32

message_date property (PPOP Struct)

This property includes the value of the date header of the last retrieved message.

Syntax

fn message_date(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property contains the value of the date header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

Data Type

String

message_from property (PPOP Struct)

This property includes the value of the from header of the last retrieved message.

Syntax

fn message_from(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property contains the value of the from header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

Data Type

String

message_header_count property (PPOP Struct)

The number of records in the MessageHeader arrays.

Syntax

fn message_header_count(&self ) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_header_field
• message_header_value

The array indices start at 0 and end at message_header_count - 1.

This property is read-only.

Data Type

i32

message_header_field property (PPOP Struct)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

fn message_header_field(&self , MessageHeaderIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the 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.

Data Type

String

message_header_value property (PPOP Struct)

This property contains the header contents.

Syntax

fn message_header_value(&self , MessageHeaderIndex : i32) -> Result<String, IPWorksPGPError> 

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.

Data Type

String

message_headers_string property (PPOP Struct)

This property includes a string representation of the full headers of the message as retrieved from the server.

Syntax

fn message_headers_string(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property contains a string representation of the full headers of the message as retrieved from the server. If the struct is not connected, or message_number 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 mail_server is asked about the headers of the message only if the message_number property has changed. If message_number has not changed, the struct returns a cached value.

Example. Connect and Retrieve Messages:

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

message_number property (PPOP Struct)

This property includes the current (selected) message.

Syntax

fn message_number(&self ) -> Result<i32, IPWorksPGPError> 
fn set_message_number(&self, value : i32) ->  Option<IPWorksPGPError> 

Default Value

1

Remarks

This property indicates the current (selected) message. This property specifies a message number in between 1 and message_count. The various struct methods related to single messages use this property as a message pointer (see method descriptions and the query_message_size method).

Data Type

i32

message_recipient_count property (PPOP Struct)

The number of records in the MessageRecipient arrays.

Syntax

fn message_recipient_count(&self ) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_recipient_address
• message_recipient_name
• message_recipient_options
• message_recipient_type

The array indices start at 0 and end at message_recipient_count - 1.

This property is read-only.

Data Type

i32

message_recipient_address property (PPOP Struct)

This property contains the email address of the recipient.

Syntax

fn message_recipient_address(&self , RecipientIndex : i32) -> Result<String, IPWorksPGPError> 

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.

Data Type

String

message_recipient_name property (PPOP Struct)

This property contains the name of the recipient.

Syntax

fn message_recipient_name(&self , RecipientIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property contains the 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.

Data Type

String

message_recipient_options property (PPOP Struct)

This property contains the recipient sending options (used only by SMTP).

Syntax

fn message_recipient_options(&self , RecipientIndex : i32) -> Result<String, IPWorksPGPError> 

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.

Data Type

String

message_recipient_type property (PPOP Struct)

This property contains the recipient type: To, Cc, or Bcc.

Syntax

fn message_recipient_type(&self , RecipientIndex : i32) -> Result<i32, IPWorksPGPError> 

Possible Values

0   // To
1   // Cc
2   // BCc

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.

Data Type

i32

message_reply_to property (PPOP Struct)

This property includes the value of the Reply-To header of the last retrieved message.

Syntax

fn message_reply_to(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property contains the value of the Reply-To header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

Data Type

String

message_subject property (PPOP Struct)

This property includes the value of the Subject header of the last retrieved message.

Syntax

fn message_subject(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property contains the value of the Subject header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

Data Type

String

message_text property (PPOP Struct)

This property includes the full text of the message as retrieved from the server.

Syntax

fn message_text(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property contains the full text of the message as retrieved from the server. If the struct is not connected, or message_number 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 max_lines).

The mail_server is asked about the text of the message only if the message_number property has changed. If message_number has not changed, the struct returns a cached value.

Example. Connect and Retrieve Messages:

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

message_to property (PPOP Struct)

This property includes the value of the To header of the last retrieved message.

Syntax

fn message_to(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property contains the value of the To header of the last retrieved message. The same information also may be retrieved through the on_header event.

This property is read-only.

Data Type

String

o_auth_access_token property (PPOP Struct)

The access token returned by the authorization server.

Syntax

fn o_auth_access_token(&self ) -> Result<String, IPWorksPGPError> 
fn set_o_auth_access_token(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_o_auth_access_token_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the struct makes a request to the token server.

Data Type

String

o_auth_authorization_scope property (PPOP Struct)

The scope request or response parameter used during authorization.

Syntax

fn o_auth_authorization_scope(&self ) -> Result<String, IPWorksPGPError> 
fn set_o_auth_authorization_scope(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_o_auth_authorization_scope_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The scope request or response parameter used during authorization.

Data Type

String

o_auth_client_id property (PPOP Struct)

The id of the client assigned when registering the application.

Syntax

fn o_auth_client_id(&self ) -> Result<String, IPWorksPGPError> 
fn set_o_auth_client_id(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_o_auth_client_id_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The id of the client assigned when registering the application.

Data Type

String

o_auth_client_secret property (PPOP Struct)

The secret value for the client assigned when registering the application.

Syntax

fn o_auth_client_secret(&self ) -> Result<String, IPWorksPGPError> 
fn set_o_auth_client_secret(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_o_auth_client_secret_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

Data Type

String

o_auth_refresh_token property (PPOP Struct)

Specifies the refresh token received from or sent to the authorization server.

Syntax

fn o_auth_refresh_token(&self ) -> Result<String, IPWorksPGPError> 
fn set_o_auth_refresh_token(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_o_auth_refresh_token_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the o_auth_grant_type property is set to a grant that can use refresh tokens.

Data Type

String

o_auth_return_url property (PPOP Struct)

The URL where the user (browser) returns after authenticating.

Syntax

fn o_auth_return_url(&self ) -> Result<String, IPWorksPGPError> 
fn set_o_auth_return_url(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_o_auth_return_url_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the struct when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

Data Type

String

o_auth_server_auth_url property (PPOP Struct)

The URL of the authorization server.

Syntax

fn o_auth_server_auth_url(&self ) -> Result<String, IPWorksPGPError> 
fn set_o_auth_server_auth_url(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_o_auth_server_auth_url_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The URL of the authorization server.

Data Type

String

o_auth_server_token_url property (PPOP Struct)

The URL of the token server used to obtain the access token.

Syntax

fn o_auth_server_token_url(&self ) -> Result<String, IPWorksPGPError> 
fn set_o_auth_server_token_url(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_o_auth_server_token_url_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

Data Type

String

password property (PPOP Struct)

This property includes the password for the mailbox user.

Syntax

fn password(&self ) -> Result<String, IPWorksPGPError> 
fn set_password(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_password_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

This property contains the password for the mailbox user. This property must be set before the struct connects to the mail_server.

Data Type

String

signer_key_count property (PPOP Struct)

The number of records in the SignerKey arrays.

Syntax

fn signer_key_count(&self ) -> Result<i32, IPWorksPGPError> 
fn set_signer_key_count(&self, value : i32) ->  Option<IPWorksPGPError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• signer_key_curve
• signer_key_effective_date
• signer_key_encoded
• signer_key_expiration_date
• signer_key_fingerprint
• signer_key_id
• signer_key_keyring
• signer_key_other_user_ids
• signer_key_passphrase
• signer_key_public_key
• signer_key_public_key_algorithm
• signer_key_public_key_length
• signer_key_revoked
• signer_key_secret_key
• signer_key_secret_key_available
• signer_key_usage
• signer_key_usage_flags
• signer_key_user_id
• signer_key_version

The array indices start at 0 and end at signer_key_count - 1.

Data Type

i32

signer_key_curve property (PPOP Struct)

This property specifies the elliptic curve if PublicKeyAlgorithm is ECDSA , EdDSA , Ed25519 , Ed448 , ML-DSA-65+Ed25519 , or ML-DSA-87+Ed448 .

Syntax

fn signer_key_curve(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

This property specifies the elliptic curve if signer_key_public_key_algorithm is ECDSA, EdDSA, Ed25519, Ed448, ML-DSA-65+Ed25519, or ML-DSA-87+Ed448. Possible values are:

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

String

signer_key_effective_date property (PPOP Struct)

The date when this key becomes valid.

Syntax

fn signer_key_effective_date(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date:

23-Jan-2000 15:00:00.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

String

signer_key_expiration_date property (PPOP Struct)

The date the key expires.

Syntax

fn signer_key_expiration_date(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date:

23-Jan-2001 15:00:00.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

String

signer_key_keyring property (PPOP Struct)

The location of the keyring.

Syntax

fn signer_key_keyring(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 
fn set_signer_key_keyring(&self, SignerKeyIndex : i32, value : &str) ->  Option<IPWorksPGPError> 
fn set_signer_key_keyring_ref(&self, SignerKeyIndex : i32, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The location of the keyring.

If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.

When This property is set the struct will read the keyring and populate the key property with the first key found in the keyring. Set key_user_id to select a different key in the current keyring.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

String

signer_key_other_user_ids property (PPOP Struct)

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

Syntax

fn signer_key_other_user_ids(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

If the specified key has alternate user Ids associated with it, this property returns a comma-separated list of the other user Ids.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

String

signer_key_passphrase property (PPOP Struct)

The passphrase for the key's secret key (if any).

Syntax

fn signer_key_passphrase(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 
fn set_signer_key_passphrase(&self, SignerKeyIndex : i32, value : &str) ->  Option<IPWorksPGPError> 
fn set_signer_key_passphrase_ref(&self, SignerKeyIndex : i32, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this property or through the on_key_passphrase event, which will fire when a passphrase is required.

The passphrase is required when using the following methods in KeyMgr:

• add_user_id
• sign_user_id
• change_expiration_date
• change_passphrase

When using the OpenPGP struct, or an email-based struct, the following methods require a passphrase for the key:

• decrypt
• sign
• sign_and_encrypt

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

String

signer_key_public_key property (PPOP Struct)

The public key of the key.

Syntax

fn signer_key_public_key(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The public key of the key. The key is provided as ASCII armored data.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

String

signer_key_public_key_algorithm property (PPOP Struct)

A text description of the public key algorithm of the key.

Syntax

fn signer_key_public_key_algorithm(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

A text description of the public key algorithm of the key. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• ML-DSA-65+Ed25519
• ML-DSA-87+Ed448
• RSA-Legacy

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

String

signer_key_public_key_length property (PPOP Struct)

The length of the public key in bits.

Syntax

fn signer_key_public_key_length(&self , SignerKeyIndex : i32) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

The length of the public key in bits. Common values are 1024, 2048, and 3072.

If the signer_key_public_key_algorithm property is ECDSA, EdDSA, Ed25519, Ed448, ML-DSA-65+Ed25519, or ML-DSA-87+Ed448, the length of the public key is determined by the signer_key_curve. Possible lengths are:

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

i32

signer_key_revoked property (PPOP Struct)

Whether or not the key is revoked.

Syntax

fn signer_key_revoked(&self , SignerKeyIndex : i32) -> Result<bool, IPWorksPGPError> 

Default Value

false

Remarks

Whether or not the key is revoked.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

bool

signer_key_secret_key property (PPOP Struct)

The secret key of the key (if available).

Syntax

fn signer_key_secret_key(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The secret key of the key (if available). The key is provided as ASCII armored data.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

String

signer_key_secret_key_available property (PPOP Struct)

Whether or not a secret key is available for the selected key.

Syntax

fn signer_key_secret_key_available(&self , SignerKeyIndex : i32) -> Result<bool, IPWorksPGPError> 

Default Value

false

Remarks

Whether or not a secret key is available for the selected key.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

bool

signer_key_usage property (PPOP Struct)

A text description of UsageFlags .

Syntax

fn signer_key_usage(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

A text description of signer_key_usage_flags.

The value will be of one or more of the following strings, separated by commas:

• Certifying Other Certificates
• Signing Emails and Files
• Encrypting Emails and Files
• Split Key
• Authenticate Against Servers
• Group Key

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

String

signer_key_usage_flags property (PPOP Struct)

Flags that show the intended use for the key.

Syntax

fn signer_key_usage_flags(&self , SignerKeyIndex : i32) -> Result<i32, IPWorksPGPError> 

Default Value

47

Remarks

Flags that show the intended use for the key. The default value is 0x0F. The value of signer_key_usage_flags is a combination of the following flags:

Please refer to the signer_key_usage property for a text representation of signer_key_usage_flags.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

i32

signer_key_version property (PPOP Struct)

This property can be used to query the OpenPGP version of the currently selected Key .

Syntax

fn signer_key_version(&self , SignerKeyIndex : i32) -> Result<i32, IPWorksPGPError> 

Default Value

4

Remarks

This property can be used to query the OpenPGP version of the currently selected key. Possible values are:

• 4 - OpenPGP v4 (default)
• 5 - LibrePGP v5
• 6 - OpenPGP v6

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

This property is read-only.

Data Type

i32

signer_key_user_id property (PPOP Struct)

The user Id of the key.

Syntax

fn signer_key_user_id(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 
fn set_signer_key_user_id(&self, SignerKeyIndex : i32, value : &str) ->  Option<IPWorksPGPError> 
fn set_signer_key_user_id_ref(&self, SignerKeyIndex : i32, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The user Id of the key. When a key is loaded this property is populated with the user Id associated with the key. This property may be set to load a key from the signer_key_keyring. When this property is set the struct will search the signer_key_keyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this property will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this property and key_other_user_ids after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as its identifier instead.

When using this property to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The struct will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP struct's on_recipient_info event.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

String

signer_key_id property (PPOP Struct)

The hex-encoded, 4-byte or 8-byte key Id.

Syntax

fn signer_key_id(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 
fn set_signer_key_id(&self, SignerKeyIndex : i32, value : &str) ->  Option<IPWorksPGPError> 
fn set_signer_key_id_ref(&self, SignerKeyIndex : i32, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 4-byte or 8-byte key Id. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

When a key is loaded, this property is populated with the Id associated with the key. This property may be set to load a key from the signer_key_keyring. When this property is set the struct will search the signer_key_keyring for a key associated with the Id specified.

The KeyIdLength setting may be set to control the length of the returned key Id.

NOTE: It is recommended to use the signer_key_fingerprint property when loading a key from the signer_key_keyring, as it is possible for different keys to have the same Id.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

String

signer_key_fingerprint property (PPOP Struct)

The hex-encoded, 20-byte fingerprint of the key.

Syntax

fn signer_key_fingerprint(&self , SignerKeyIndex : i32) -> Result<String, IPWorksPGPError> 
fn set_signer_key_fingerprint(&self, SignerKeyIndex : i32, value : &str) ->  Option<IPWorksPGPError> 
fn set_signer_key_fingerprint_ref(&self, SignerKeyIndex : i32, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 20-byte fingerprint of the key.

When a key is loaded, this property is populated with the Fingerprint associated with the key. This property may be set to load a key from the signer_key_keyring. When this property is set the struct will search the signer_key_keyring for a key associated with the Fingerprint specified.

This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

String

signer_key_encoded property (PPOP Struct)

The key.

Syntax

fn signer_key_encoded(&self , SignerKeyIndex : i32) -> Result<Vec<u8>, IPWorksPGPError> 
fn set_signer_key_encoded(&self, SignerKeyIndex : i32, value : Vec<u8>) ->  Option<IPWorksPGPError> 
fn set_signer_key_encoded_ref(&self, SignerKeyIndex : i32, value : &[u8]) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The key. This property can be used to assign a specific key. The signer_key_fingerprint, signer_key_id, and signer_key_user_id properties may also be used to specify a key.

The SignerKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerKeyCount property.

Data Type

Vec

ssl_accept_server_cert_effective_date property (PPOP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (PPOP Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (PPOP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (PPOP Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (PPOP Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (PPOP Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (PPOP Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (PPOP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (PPOP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, IPWorksPGPError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (PPOP Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (PPOP Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (PPOP Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (PPOP Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (PPOP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (PPOP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (PPOP Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksPGPError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksPGPError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksPGPError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_accept_server_cert_store_password property (PPOP Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, IPWorksPGPError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

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

ssl_accept_server_cert_store_type property (PPOP Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, IPWorksPGPError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<IPWorksPGPError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (PPOP Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (PPOP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (PPOP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (PPOP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (PPOP Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (PPOP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (PPOP Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (PPOP Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, IPWorksPGPError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_accept_server_cert_encoded property (PPOP Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksPGPError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksPGPError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

Data Type

Vec

ssl_cert_effective_date property (PPOP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (PPOP Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (PPOP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (PPOP Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (PPOP Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (PPOP Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (PPOP Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (PPOP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (PPOP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksPGPError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (PPOP Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (PPOP Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (PPOP Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (PPOP Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (PPOP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (PPOP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (PPOP Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksPGPError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksPGPError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksPGPError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (PPOP Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksPGPError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

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

ssl_cert_store_type property (PPOP Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksPGPError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksPGPError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (PPOP Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (PPOP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (PPOP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (PPOP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (PPOP Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (PPOP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (PPOP Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (PPOP Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksPGPError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (PPOP Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksPGPError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksPGPError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_enabled property (PPOP Struct)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

fn ssl_enabled(&self ) -> Result<bool, IPWorksPGPError> 
fn set_ssl_enabled(&self, value : bool) ->  Option<IPWorksPGPError> 

Default Value

false

Remarks

This property specifies whether TLS/SSL is enabled in the struct. When False (default), the struct operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting ssl_start_mode. Setting ssl_start_mode will automatically update this property value.

Data Type

bool

ssl_provider property (PPOP Struct)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

fn ssl_provider(&self ) -> Result<i32, IPWorksPGPError> 
fn set_ssl_provider(&self, value : i32) ->  Option<IPWorksPGPError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

i32

ssl_server_cert_effective_date property (PPOP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (PPOP Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (PPOP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (PPOP Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (PPOP Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (PPOP Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (PPOP Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (PPOP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (PPOP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, IPWorksPGPError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (PPOP Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (PPOP Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (PPOP Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (PPOP Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (PPOP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (PPOP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_store property (PPOP Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksPGPError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (PPOP Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, IPWorksPGPError> 

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.

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (PPOP Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, IPWorksPGPError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (PPOP Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (PPOP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (PPOP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (PPOP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_usage property (PPOP Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (PPOP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, IPWorksPGPError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_server_cert_version property (PPOP Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_server_cert_subject property (PPOP Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, IPWorksPGPError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (PPOP Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksPGPError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

Data Type

Vec

ssl_start_mode property (PPOP Struct)

This property determines how the struct starts the Secure Sockets Layer (SSL) negotiation.

Syntax

fn ssl_start_mode(&self ) -> Result<i32, IPWorksPGPError> 
fn set_ssl_start_mode(&self, value : i32) ->  Option<IPWorksPGPError> 

Possible Values

0   // Automatic
1   // Implicit
2   // Explicit
3   // None

Default Value

3

Remarks

The ssl_start_mode property may have one of the following values:

Data Type

i32

timeout property (PPOP Struct)

The timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, IPWorksPGPError> 
fn set_timeout(&self, value : i32) ->  Option<IPWorksPGPError> 

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 struct will wait for the operation to complete before returning control.

The struct will use do_events 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 struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, 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

i32

user property (PPOP Struct)

This property includes the user identifier for the mailbox.

Syntax

fn user(&self ) -> Result<String, IPWorksPGPError> 
fn set_user(&self, value : &str) ->  Option<IPWorksPGPError> 
fn set_user_ref(&self, value : &String) ->  Option<IPWorksPGPError> 

Default Value

""

Remarks

This property contains the user identifier for the mailbox. This property must be set before the struct connects to the mail_server.

Data Type

String

config method (PPOP Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksPGPError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.

connect method (PPOP Struct)

This method connects to the mail server and attempts to log in.

Syntax

fn connect(&self) -> Result<(), IPWorksPGPError>

Remarks

This method connects to the mail server and attempts to log in using the current user and password. Then it retrieves the initial statistics about the mailbox contents (message_count and query_total_size).

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

decrypt method (PPOP Struct)

Decrypts the message.

Syntax

fn decrypt(&self) -> Result<(), IPWorksPGPError>

Remarks

This method decrypts the specified message.

The message will be decrypted using the keys specified in keys. Before decryption begins the struct will fire the on_recipient_info event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into keys.

decrypt_and_verify_signature method (PPOP Struct)

Decrypts and verifies the signature of the message.

Syntax

fn decrypt_and_verify_signature(&self) -> Result<(), IPWorksPGPError>

Remarks

This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the decrypt and verify_signature methods are affected in the same manner.

This method may be used when the data is signed, encrypted, or signed and encrypted. For instance, if the data is encrypted but not signed you may still use this method and the struct will perform the decryption without error.

The message will be decrypted using the keys specified in keys. Before decryption begins the struct will fire the on_recipient_info event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into keys.

The message will be verified using the keys specified in signer_keys. Before verification begins the struct will fire the on_signature_info event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into signer_keys.

By default, if the signature is not valid the struct fails with an error. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the on_verification_status event should be checked to determine the result of the operation.

NOTE: This method does not attempt to check the validity of the signing key itself.

delete method (PPOP Struct)

This method deletes a message specified by MessageNumber on the server.

Syntax

fn delete(&self) -> Result<(), IPWorksPGPError>

Remarks

This method asks the mail_server to delete the message specified by message_number. The message will not actually be deleted from the server until the connection is closed. To cancel a previous Delete, use the reset method.

disconnect method (PPOP Struct)

This method disconnects from the mail server.

Syntax

fn disconnect(&self) -> Result<(), IPWorksPGPError>

Remarks

This method makes the struct disconnect from the mail_server 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.

do_events method (PPOP Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksPGPError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

interrupt method (PPOP Struct)

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), IPWorksPGPError>

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_message_sizes method (PPOP Struct)

This method retrieves a list of all message sizes from the server.

Syntax

fn list_message_sizes(&self) -> Result<(), IPWorksPGPError>

Remarks

This message retrieves a list of all message sizes from the server. For each message listed, a on_message_list event will fire containing the number and size of the message.

list_message_ui_ds method (PPOP Struct)

This method retrieves a list of all message UIDs from the server.

Syntax

fn list_message_ui_ds(&self) -> Result<(), IPWorksPGPError>

Remarks

This method retrieves a list of all message UIDs from the server. For each message listed, a on_message_list event will fire containing the number and UID of the message.

localize_date method (PPOP Struct)

This method converts a valid RFC 822 message date to a local date and time.

Syntax

fn localize_date(&self, date_time : &str) ->  Result<String, IPWorksPGPError>

Remarks

This method can be used to convert an RFC 822 date and time string to the corresponding local date and time.

NOTE: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

query_message_size method (PPOP Struct)

This method returns the size in bytes of the current message.

Syntax

fn query_message_size(&self) ->  Result<i64, IPWorksPGPError>

Remarks

This method queries the server for the size in bytes of the message specified by message_number. The method returns the size (in bytes) of the message.

If the struct is not connected, or message_number 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 mail_server is asked about the size of the message only if the message_number property has changed. If message_number has not changed, the struct returns a cached value.

query_message_uid method (PPOP Struct)

This method returns the unique identifier (UID) of the message as specified by the server.

Syntax

fn query_message_uid(&self) ->  Result<String, IPWorksPGPError>

Remarks

This method returns the unique identifier (UID) of the message specified by message_number. If the struct is not connected, or message_number 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 mail_server is asked about the UID of the message only if the message_number property has changed. If message_number has not changed, the struct returns a cached value.

query_total_size method (PPOP Struct)

This method returns the cumulative size in bytes of messages in the mailbox (including headers).

Syntax

fn query_total_size(&self) ->  Result<i64, IPWorksPGPError>

Remarks

This method returns the cumulative size in bytes of messages in the mailbox (including headers). When the struct 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.

reset method (PPOP Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksPGPError>

Remarks

This method will reset the struct's properties to their default values.

retrieve method (PPOP Struct)

This method retrieves a message specified by MessageNumber from the server.

Syntax

fn retrieve(&self) -> Result<(), IPWorksPGPError>

Remarks

This method is used to retrieve a message specified by message_number from the server. It asks the mail_server to retrieve the message specified by message_number. The message headers will arrive in the on_header event, and the message text will arrive in the on_transfer event.

The max_lines property defines the number of lines retrieved.

Example. Connect and Retrieve Messages:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.Retrieve()

retrieve_headers method (PPOP Struct)

This method retrieves headers for a message specified by MessageNumber .

Syntax

fn retrieve_headers(&self) -> Result<(), IPWorksPGPError>

Remarks

Calling this method will retrieve the headers for the message specified by the message_number property. The message headers will be provided by the on_header event and also stored in the message_headers property.

Example. Connect and Retrieve Message Headers:

POPControl.MailServer = "MyPOPServer" POPControl.User = "username" POPControl.Password = "password" POPControl.Connect() POPControl.MessageNumber = 1 POPControl.RetrieveHeaders()

send_command method (PPOP Struct)

This method sends the exact command directly to the server.

Syntax

fn send_command(&self, command : &str) -> Result<(), IPWorksPGPError>

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 last_reply property or monitor the on_pi_trail event to obtain the server's response.

verify_signature method (PPOP Struct)

Verifies the signature of the current message.

Syntax

fn verify_signature(&self) -> Result<(), IPWorksPGPError>

Remarks

This method verifies the signature of the message.

The message will be verified using the keys specified in signer_keys. Before verification begins the struct will fire the on_signature_info event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into signer_keys.

By default, if the signature is not valid the struct fails with an error. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the on_verification_status event should be checked to determine the result of the operation.

on_connection_status event (PPOP Struct)

Fired to indicate changes in the connection state.

Syntax

// PPOPConnectionStatusEventArgs carries the PPOP ConnectionStatus event's parameters.
pub struct PPOPConnectionStatusEventArgs {
  fn connection_event(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// PPOPConnectionStatusEvent defines the signature of the PPOP ConnectionStatus event's handler function.
pub trait PPOPConnectionStatusEvent {
  fn on_connection_status(&self, sender : PPOP, e : &mut PPOPConnectionStatusEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_connection_status(&self) -> &'a dyn PPOPConnectionStatusEvent;
  pub fn set_on_connection_status(&mut self, value : &'a dyn PPOPConnectionStatusEvent);
  ...
}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The connection_event parameter indicates the type of connection event. Values may include the following:

on_end_transfer event (PPOP Struct)

This event is fired when the message completes transferring.

Syntax

// PPOPEndTransferEventArgs carries the PPOP EndTransfer event's parameters.
pub struct PPOPEndTransferEventArgs {
  fn direction(&self) -> i32
}

// PPOPEndTransferEvent defines the signature of the PPOP EndTransfer event's handler function.
pub trait PPOPEndTransferEvent {
  fn on_end_transfer(&self, sender : PPOP, e : &mut PPOPEndTransferEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn PPOPEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn PPOPEndTransferEvent);
  ...
}

Remarks

The on_end_transfer 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.

on_error event (PPOP Struct)

Fired when information is available about errors during data delivery.

Syntax

// PPOPErrorEventArgs carries the PPOP Error event's parameters.
pub struct PPOPErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// PPOPErrorEvent defines the signature of the PPOP Error event's handler function.
pub trait PPOPErrorEvent {
  fn on_error(&self, sender : PPOP, e : &mut PPOPErrorEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_error(&self) -> &'a dyn PPOPErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn PPOPErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_header event (PPOP Struct)

This event is fired for every message header being retrieved.

Syntax

// PPOPHeaderEventArgs carries the PPOP Header event's parameters.
pub struct PPOPHeaderEventArgs {
  fn field(&self) -> &String
  fn value(&self) -> &String
}

// PPOPHeaderEvent defines the signature of the PPOP Header event's handler function.
pub trait PPOPHeaderEvent {
  fn on_header(&self, sender : PPOP, e : &mut PPOPHeaderEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_header(&self) -> &'a dyn PPOPHeaderEvent;
  pub fn set_on_header(&mut self, value : &'a dyn PPOPHeaderEvent);
  ...
}

Remarks

The field parameter contains the name of the header (in the 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).

on_key_passphrase event (PPOP Struct)

Fired if the passphrase of current key is incorrect or empty.

Syntax

// PPOPKeyPassphraseEventArgs carries the PPOP KeyPassphrase event's parameters.
pub struct PPOPKeyPassphraseEventArgs {
  fn user_id(&self) -> &String
  fn key_id(&self) -> &String
  fn fingerprint(&self) -> &String
  fn passphrase(&self) -> &String
  fn set_passphrase(&self, value : &str)
  fn set_passphrase_ref(&self, value : &String)
}

// PPOPKeyPassphraseEvent defines the signature of the PPOP KeyPassphrase event's handler function.
pub trait PPOPKeyPassphraseEvent {
  fn on_key_passphrase(&self, sender : PPOP, e : &mut PPOPKeyPassphraseEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_key_passphrase(&self) -> &'a dyn PPOPKeyPassphraseEvent;
  pub fn set_on_key_passphrase(&mut self, value : &'a dyn PPOPKeyPassphraseEvent);
  ...
}

Remarks

This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the key_passphrase property before attempting the operation.

The passphrase is required when using the following methods in KeyMgr:

• add_user_id
• sign_user_id
• change_expiration_date
• change_passphrase

When using the OpenPGP struct, or an email-based struct, the following methods require a passphrase for the key:

• decrypt
• sign
• sign_and_encrypt

UserId holds the user Id of the key the passphrase is required for.

The UserId format is:

FirstName LastName (Comment) <Email>

Note that for OpenPGP v6, a key may be created with or without a UserId, as the field is optional. If a key was created without a UserId, the key's Fingerprint can be used as its identifier instead.

KeyId is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

on_launch_browser event (PPOP Struct)

Fires before launching a browser with the authorization URL.

Syntax

// PPOPLaunchBrowserEventArgs carries the PPOP LaunchBrowser event's parameters.
pub struct PPOPLaunchBrowserEventArgs {
  fn url(&self) -> &String
  fn set_url(&self, value : &str)
  fn set_url_ref(&self, value : &String)
  fn command(&self) -> &String
  fn set_command(&self, value : &str)
  fn set_command_ref(&self, value : &String)
}

// PPOPLaunchBrowserEvent defines the signature of the PPOP LaunchBrowser event's handler function.
pub trait PPOPLaunchBrowserEvent {
  fn on_launch_browser(&self, sender : PPOP, e : &mut PPOPLaunchBrowserEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_launch_browser(&self) -> &'a dyn PPOPLaunchBrowserEvent;
  pub fn set_on_launch_browser(&mut self, value : &'a dyn PPOPLaunchBrowserEvent);
  ...
}

Remarks

When the client_profile property is set to ocpApplication and get_authorization is called, the struct will fire this event with the command, which will be executed by the struct. The url parameter will be the authorization URL that the user will be directed to authenticate.

Within this event, you may override the current value of either command or url and provide your own value. If command is set to an empty string, the struct will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter. If command is not empty, the URL will be appended to the end.

In Windows, ShellExecute is used to execute command, which limits the verbs available for use in command to:

• edit
• explore
• find
• open
• print

on_log event (PPOP Struct)

Fired once for each log message.

Syntax

// PPOPLogEventArgs carries the PPOP Log event's parameters.
pub struct PPOPLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// PPOPLogEvent defines the signature of the PPOP Log event's handler function.
pub trait PPOPLogEvent {
  fn on_log(&self, sender : PPOP, e : &mut PPOPLogEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_log(&self) -> &'a dyn PPOPLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn PPOPLogEvent);
  ...
}

Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel setting.

log_level indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

message is the log entry.

log_type identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_message_list event (PPOP Struct)

This event is fired for every message listed by ListMessageSizes and/or ListMessageUIDs .

Syntax

// PPOPMessageListEventArgs carries the PPOP MessageList event's parameters.
pub struct PPOPMessageListEventArgs {
  fn message_number(&self) -> i32
  fn message_uid(&self) -> &String
  fn message_size(&self) -> i32
}

// PPOPMessageListEvent defines the signature of the PPOP MessageList event's handler function.
pub trait PPOPMessageListEvent {
  fn on_message_list(&self, sender : PPOP, e : &mut PPOPMessageListEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_message_list(&self) -> &'a dyn PPOPMessageListEvent;
  pub fn set_on_message_list(&mut self, value : &'a dyn PPOPMessageListEvent);
  ...
}

Remarks

When list_message_sizes is called, message_size is valid, and message_uid is always an empty string.

When list_message_ui_ds is called, message_uid is valid, and message_size is 0.

on_pi_trail event (PPOP Struct)

This event traces the commands sent to the mail server, and the respective replies.

Syntax

// PPOPPITrailEventArgs carries the PPOP PITrail event's parameters.
pub struct PPOPPITrailEventArgs {
  fn direction(&self) -> i32
  fn message(&self) -> &String
}

// PPOPPITrailEvent defines the signature of the PPOP PITrail event's handler function.
pub trait PPOPPITrailEvent {
  fn on_pi_trail(&self, sender : PPOP, e : &mut PPOPPITrailEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_pi_trail(&self) -> &'a dyn PPOPPITrailEvent;
  pub fn set_on_pi_trail(&mut self, value : &'a dyn PPOPPITrailEvent);
  ...
}

Remarks

The on_pi_trail event is useful for debugging purposes. It shows all of 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:

on_progress event (PPOP Struct)

Fired as progress is made.

Syntax

// PPOPProgressEventArgs carries the PPOP Progress event's parameters.
pub struct PPOPProgressEventArgs {
  fn bytes_processed(&self) -> i64
  fn percent_processed(&self) -> i32
}

// PPOPProgressEvent defines the signature of the PPOP Progress event's handler function.
pub trait PPOPProgressEvent {
  fn on_progress(&self, sender : PPOP, e : &mut PPOPProgressEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_progress(&self) -> &'a dyn PPOPProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn PPOPProgressEvent);
  ...
}

Remarks

This event is fired automatically as data is processed by the struct.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

on_recipient_info event (PPOP Struct)

Fired for each recipient key of the encrypted message.

Syntax

// PPOPRecipientInfoEventArgs carries the PPOP RecipientInfo event's parameters.
pub struct PPOPRecipientInfoEventArgs {
  fn key_id(&self) -> &String
  fn fingerprint(&self) -> &String
  fn public_key_algorithm(&self) -> &String
}

// PPOPRecipientInfoEvent defines the signature of the PPOP RecipientInfo event's handler function.
pub trait PPOPRecipientInfoEvent {
  fn on_recipient_info(&self, sender : PPOP, e : &mut PPOPRecipientInfoEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_recipient_info(&self) -> &'a dyn PPOPRecipientInfoEvent;
  pub fn set_on_recipient_info(&mut self, value : &'a dyn PPOPRecipientInfoEvent);
  ...
}

Remarks

This event fires when the decrypt or decrypt_and_verify_signature method is called.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyId and Fingerprint parameters can be used to identify the correct key to specify in the Key* properties. The Key* properties can be set from within this event as this event fires directly before the decryption process begins.

It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.

PublicKeyAlgorithm is the algorithm of the public key used to encrypt the message. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy
• ECDH (Subkeys only)
• X25519 (Subkeys only)
• X448 (Subkeys only)
• ML-KEM (Subkeys only; LibrePGP/GnuPG)
• ML-KEM-768+X25519 (Subkeys only)
• ML-KEM-1024+X448 (Subkeys only)

on_signature_info event (PPOP Struct)

Fired during verification of the signed message.

Syntax

// PPOPSignatureInfoEventArgs carries the PPOP SignatureInfo event's parameters.
pub struct PPOPSignatureInfoEventArgs {
  fn key_id(&self) -> &String
  fn fingerprint(&self) -> &String
  fn signing_algorithm(&self) -> &String
  fn public_key_algorithm(&self) -> &String
}

// PPOPSignatureInfoEvent defines the signature of the PPOP SignatureInfo event's handler function.
pub trait PPOPSignatureInfoEvent {
  fn on_signature_info(&self, sender : PPOP, e : &mut PPOPSignatureInfoEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_signature_info(&self) -> &'a dyn PPOPSignatureInfoEvent;
  pub fn set_on_signature_info(&mut self, value : &'a dyn PPOPSignatureInfoEvent);
  ...
}

Remarks

This event fires when the verify_signature or decrypt_and_verify_signature method is called. It provides information about the signature of the message.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. If a subkey was used to sign the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

The KeyId and Fingerprint parameters can be used to identify the correct key to specify in the SignerKey* properties. The SignerKey* properties can be set from within this event as this event fires directly before the verification process begins.

It is recommended to use the Fingerprint to identify the correct key, as it is possible for different keys to have the same KeyId.

SigningAlgorithm describes the hash algorithm used when the message was originally signed. This value is applicable only to the message signature, not the key used to sign the message. Possible values are:

• SHA1
• MD5
• SHA256
• SHA384
• SHA512
• SHA224
• RIPEMD160
• SHA3-256
• SHA3-512

PublicKeyAlgorithm is the algorithm of the public key used to sign the message. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA
• Ed25519
• Ed448
• RSA-Legacy
• ML-DSA-65+Ed25519
• ML-DSA-87+Ed448
• ECDH (Subkeys only)
• X25519 (Subkeys only)
• X448 (Subkeys only)

on_ssl_server_authentication event (PPOP Struct)

Fired after the server presents its certificate to the client.

Syntax

// PPOPSSLServerAuthenticationEventArgs carries the PPOP SSLServerAuthentication event's parameters.
pub struct PPOPSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// PPOPSSLServerAuthenticationEvent defines the signature of the PPOP SSLServerAuthentication event's handler function.
pub trait PPOPSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : PPOP, e : &mut PPOPSSLServerAuthenticationEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn PPOPSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn PPOPSSLServerAuthenticationEvent);
  ...
}

Remarks

During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.

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.

on_ssl_status event (PPOP Struct)

Fired when secure connection progress messages are available.

Syntax

// PPOPSSLStatusEventArgs carries the PPOP SSLStatus event's parameters.
pub struct PPOPSSLStatusEventArgs {
  fn message(&self) -> &String
}

// PPOPSSLStatusEvent defines the signature of the PPOP SSLStatus event's handler function.
pub trait PPOPSSLStatusEvent {
  fn on_ssl_status(&self, sender : PPOP, e : &mut PPOPSSLStatusEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn PPOPSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn PPOPSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer event (PPOP Struct)

This event is fired when the message starts transferring.

Syntax

// PPOPStartTransferEventArgs carries the PPOP StartTransfer event's parameters.
pub struct PPOPStartTransferEventArgs {
  fn direction(&self) -> i32
}

// PPOPStartTransferEvent defines the signature of the PPOP StartTransfer event's handler function.
pub trait PPOPStartTransferEvent {
  fn on_start_transfer(&self, sender : PPOP, e : &mut PPOPStartTransferEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn PPOPStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn PPOPStartTransferEvent);
  ...
}

Remarks

The on_start_transfer 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.

on_status event (PPOP Struct)

Shows the progress of the operation.

Syntax

// PPOPStatusEventArgs carries the PPOP Status event's parameters.
pub struct PPOPStatusEventArgs {
  fn message(&self) -> &String
}

// PPOPStatusEvent defines the signature of the PPOP Status event's handler function.
pub trait PPOPStatusEvent {
  fn on_status(&self, sender : PPOP, e : &mut PPOPStatusEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_status(&self) -> &'a dyn PPOPStatusEvent;
  pub fn set_on_status(&mut self, value : &'a dyn PPOPStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.

The level of detail is controlled by the LogLevel setting.

on_transfer event (PPOP Struct)

This event is fired when the message is transferred from MailServer .

Syntax

// PPOPTransferEventArgs carries the PPOP Transfer event's parameters.
pub struct PPOPTransferEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
  fn eol(&self) -> bool
}

// PPOPTransferEvent defines the signature of the PPOP Transfer event's handler function.
pub trait PPOPTransferEvent {
  fn on_transfer(&self, sender : PPOP, e : &mut PPOPTransferEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_transfer(&self) -> &'a dyn PPOPTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn PPOPTransferEvent);
  ...
}

Remarks

The text parameter contains the portion of the message data to be retrieved.

The bytes_transferred 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 on_transfer event is fired), bytes_transferred equals the value of the query_message_size method.

The on_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 local_file property and use the on_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: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

NOTE: For the percent_done parameter value to be correct, the GetMessageSize configuration setting must be set to True.

on_verification_status event (PPOP Struct)

Fired after verification of the signed message.

Syntax

// PPOPVerificationStatusEventArgs carries the PPOP VerificationStatus event's parameters.
pub struct PPOPVerificationStatusEventArgs {
  fn key_id(&self) -> &String
  fn fingerprint(&self) -> &String
  fn status(&self) -> i32
}

// PPOPVerificationStatusEvent defines the signature of the PPOP VerificationStatus event's handler function.
pub trait PPOPVerificationStatusEvent {
  fn on_verification_status(&self, sender : PPOP, e : &mut PPOPVerificationStatusEventArgs);
}

impl <'a> PPOP<'a> {
  pub fn on_verification_status(&self) -> &'a dyn PPOPVerificationStatusEvent;
  pub fn set_on_verification_status(&mut self, value : &'a dyn PPOPVerificationStatusEvent);
  ...
}

Remarks

This event fires when verify_signature or decrypt_and_verify_signature is called. It provides information about the result.

KeyId is the hex-encoded 4- or 8-byte Id of the key used to sign the message. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's Fingerprint. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's Fingerprint instead. For instance:

5E70662EA810E768

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

Status holds the result of the operation. Possible values are:

Config Settings (PPOP Struct)

PPOP Config Settings

POP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings