Struct secureblackbox::IMAPClient

Properties   Methods   Events   Config Settings   Errors  

The IMAPClient struct provides client-side functionality for IMAP4 (Internet Message Access Protocol).

Syntax

secureblackbox::IMAPClient

Remarks

Use this struct to manage e-mail and retrieve e-mail messages from the remote IMAP servers. Please see the OAuthClient topic for more details about using the OAuth2 authentication type.

Downloading only the recent messages to local files IMAPClient client = new IMAPClient(); client.Username= "user"; client.Password= "password"; client.Connect("mail.domain.com", 993); client.OpenMailbox("INBOX", true); client.ListMessages(Constants.imapMessageRecent, 0); foreach (IMAPMessageInfo info in client.Messages) client.ReceiveFile(info.UID, $"path\\{info.UID}.eml"); client.Disconnect();

Use on_command and on_command_reply events to get a session log. IMAPClient client = new IMAPClient(); client.OnCommand += (s, e) => { Console.WriteLine($"C: {e.Cmd}"); }; client.OnCommandReply += (s, e) => { Console.WriteLine($"S: {e.Reply}"); };

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the IMAPClient struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of IMAPClient 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.

access_token property (IMAPClient Struct)

An OAuth 2.0 access token to authenticate to the server.

Syntax

fn access_token(&self ) -> Result<String, SecureBlackboxError> 
fn set_access_token(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_access_token_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to provide the access token to be used to authenticate to the destination server.

Data Type

String

blocked_cert_count property (IMAPClient Struct)

The number of records in the BlockedCert arrays.

Syntax

fn blocked_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_blocked_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• blocked_cert_bytes
• blocked_cert_handle

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

Data Type

i32

blocked_cert_bytes property (IMAPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn blocked_cert_bytes(&self , BlockedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

Vec

blocked_cert_handle property (IMAPClient Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn blocked_cert_handle(&self , BlockedCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_blocked_cert_handle(&self, BlockedCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

Data Type

i64

conn_info_aead_cipher property (IMAPClient Struct)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

fn conn_info_aead_cipher(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

bool

conn_info_chain_validation_details property (IMAPClient Struct)

The details of a certificate chain validation outcome.

Syntax

fn conn_info_chain_validation_details(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

This property is read-only.

Data Type

i32

conn_info_chain_validation_result property (IMAPClient Struct)

The outcome of a certificate chain validation routine.

Syntax

fn conn_info_chain_validation_result(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

Data Type

i32

conn_info_ciphersuite property (IMAPClient Struct)

The cipher suite employed by this connection.

Syntax

fn conn_info_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only.

Data Type

String

conn_info_client_authenticated property (IMAPClient Struct)

Specifies whether client authentication was performed during this connection.

Syntax

fn conn_info_client_authenticated(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

bool

conn_info_client_auth_requested property (IMAPClient Struct)

Specifies whether client authentication was requested during this connection.

Syntax

fn conn_info_client_auth_requested(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

bool

conn_info_connection_established property (IMAPClient Struct)

Indicates whether the connection has been established fully.

Syntax

fn conn_info_connection_established(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

bool

conn_info_connection_id property (IMAPClient Struct)

The unique identifier assigned to this connection.

Syntax

fn conn_info_connection_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

Vec

conn_info_digest_algorithm property (IMAPClient Struct)

The digest algorithm used in a TLS-enabled connection.

Syntax

fn conn_info_digest_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

conn_info_encryption_algorithm property (IMAPClient Struct)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

fn conn_info_encryption_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

conn_info_exportable property (IMAPClient Struct)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

fn conn_info_exportable(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only.

Data Type

bool

conn_info_group property (IMAPClient Struct)

The elliptic curve used in this connection.

Syntax

fn conn_info_group(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The elliptic curve used in this connection.

This property was named NamedECCurve in SecureBlackbox 2024 and earlier versions.

This property is read-only.

Data Type

String

conn_info_id property (IMAPClient Struct)

The client connection's unique identifier.

Syntax

fn conn_info_id(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

This property is read-only.

Data Type

i64

conn_info_key_exchange_algorithm property (IMAPClient Struct)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

fn conn_info_key_exchange_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

conn_info_key_exchange_key_bits property (IMAPClient Struct)

The length of the key exchange key of a TLS-enabled connection.

Syntax

fn conn_info_key_exchange_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only.

Data Type

i32

conn_info_pfs_cipher property (IMAPClient Struct)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

fn conn_info_pfs_cipher(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only.

Data Type

bool

conn_info_pre_shared_identity property (IMAPClient Struct)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

fn conn_info_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is read-only.

Data Type

String

conn_info_pre_shared_identity_hint property (IMAPClient Struct)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

fn conn_info_pre_shared_identity_hint(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only.

Data Type

String

conn_info_public_key_bits property (IMAPClient Struct)

The length of the public key.

Syntax

fn conn_info_public_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The length of the public key.

This property is read-only.

Data Type

i32

conn_info_remote_address property (IMAPClient Struct)

The client's IP address.

Syntax

fn conn_info_remote_address(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

conn_info_remote_port property (IMAPClient Struct)

The remote port of the client connection.

Syntax

fn conn_info_remote_port(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

i32

conn_info_resumed_session property (IMAPClient Struct)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

fn conn_info_resumed_session(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only.

Data Type

bool

conn_info_secure_connection property (IMAPClient Struct)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

fn conn_info_secure_connection(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

bool

conn_info_server_authenticated property (IMAPClient Struct)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

fn conn_info_server_authenticated(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only.

Data Type

bool

conn_info_signature_algorithm property (IMAPClient Struct)

The signature algorithm used in a TLS handshake.

Syntax

fn conn_info_signature_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

conn_info_symmetric_block_size property (IMAPClient Struct)

The block size of the symmetric algorithm used.

Syntax

fn conn_info_symmetric_block_size(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

i32

conn_info_symmetric_key_bits property (IMAPClient Struct)

The key length of the symmetric algorithm used.

Syntax

fn conn_info_symmetric_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

i32

conn_info_total_bytes_received property (IMAPClient Struct)

The total number of bytes received over this connection.

Syntax

fn conn_info_total_bytes_received(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

i64

conn_info_total_bytes_sent property (IMAPClient Struct)

The total number of bytes sent over this connection.

Syntax

fn conn_info_total_bytes_sent(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

i64

conn_info_validation_log property (IMAPClient Struct)

Contains the server certificate's chain validation log.

Syntax

fn conn_info_validation_log(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only.

Data Type

String

conn_info_version property (IMAPClient Struct)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

fn conn_info_version(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only.

Data Type

String

fips_mode property (IMAPClient Struct)

Reserved.

Syntax

fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

known_cert_count property (IMAPClient Struct)

The number of records in the KnownCert arrays.

Syntax

fn known_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_cert_bytes
• known_cert_handle

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

Data Type

i32

known_cert_bytes property (IMAPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn known_cert_bytes(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

Vec

known_cert_handle property (IMAPClient Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn known_cert_handle(&self , KnownCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_cert_handle(&self, KnownCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

Data Type

i64

known_crl_count property (IMAPClient Struct)

The number of records in the KnownCRL arrays.

Syntax

fn known_crl_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_crl_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_crl_bytes
• known_crl_handle

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

Data Type

i32

known_crl_bytes property (IMAPClient Struct)

Returns the raw CRL data in DER format.

Syntax

fn known_crl_bytes(&self , KnownCRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is read-only.

Data Type

Vec

known_crl_handle property (IMAPClient Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn known_crl_handle(&self , KnownCRLIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_crl_handle(&self, KnownCRLIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

Data Type

i64

known_ocsp_count property (IMAPClient Struct)

The number of records in the KnownOCSP arrays.

Syntax

fn known_ocsp_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_ocsp_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_ocsp_bytes
• known_ocsp_handle

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

Data Type

i32

known_ocsp_bytes property (IMAPClient Struct)

A buffer containing the raw OCSP response data.

Syntax

fn known_ocsp_bytes(&self , KnownOCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

A buffer containing the raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is read-only.

Data Type

Vec

known_ocsp_handle property (IMAPClient Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn known_ocsp_handle(&self , KnownOCSPIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_ocsp_handle(&self, KnownOCSPIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

Data Type

i64

mailbox_message_flags property (IMAPClient Struct)

Contains message flags defined in the mailbox.

Syntax

fn mailbox_message_flags(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Contains message flags defined in the mailbox.

This property is read-only.

Data Type

i32

mailbox_name property (IMAPClient Struct)

Specifies mailbox name.

Syntax

fn mailbox_name(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies mailbox name.

This property is read-only.

Data Type

String

mailbox_next_uid property (IMAPClient Struct)

Returns the next unique identifier value.

Syntax

fn mailbox_next_uid(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the next unique identifier value.

Use this property to get or set the next unique identifier (corresponds to UIDNEXT status code).

This property is read-only.

Data Type

i32

mailbox_permanent_flags property (IMAPClient Struct)

Contains a list of message flags that can be changed permanently.

Syntax

fn mailbox_permanent_flags(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Contains a list of message flags that can be changed permanently.

This property is read-only.

Data Type

i32

mailbox_read_only property (IMAPClient Struct)

Specifies whether the mailbox is write-protected.

Syntax

fn mailbox_read_only(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether the mailbox is write-protected.

This property is read-only.

Data Type

bool

mailbox_recent_messages property (IMAPClient Struct)

The number of recent messages in the mailbox.

Syntax

fn mailbox_recent_messages(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The number of recent messages in the mailbox.

This property is read-only.

Data Type

i32

mailbox_total_messages property (IMAPClient Struct)

Total number of messages in the mailbox.

Syntax

fn mailbox_total_messages(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Total number of messages in the mailbox.

This property is read-only.

Data Type

i32

mailbox_uid_validity property (IMAPClient Struct)

Specifies UID validity value.

Syntax

fn mailbox_uid_validity(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies UID validity value.

This property is read-only.

Data Type

i32

mailbox_unseen_messages property (IMAPClient Struct)

The number of unseen messages in the mailbox.

Syntax

fn mailbox_unseen_messages(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The number of unseen messages in the mailbox.

This property is read-only.

Data Type

i32

msg_attachment_count property (IMAPClient Struct)

Returns the number of attachments in this message.

Syntax

fn msg_attachment_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the number of attachments in this message.

This property is read-only.

Data Type

i32

msg_bcc property (IMAPClient Struct)

The contents of the BCC header property.

Syntax

fn msg_bcc(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_bcc(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_bcc_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The contents of the BCC header field.

The BCC header field contains the addresses of secondary recipients of the message whose addresses are not to be revealed to other recipients of the message. Mail servers remove the BCC header when processing the message and use its value for dispatching the message only.

Data Type

String

msg_cc property (IMAPClient Struct)

The value of the CC header property.

Syntax

fn msg_cc(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_cc(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_cc_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the CC header field.

The CC field contains the addresses of secondary recipients of the message.

Data Type

String

msg_comments property (IMAPClient Struct)

Contains additional information about the message body.

Syntax

fn msg_comments(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_comments(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_comments_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains additional information about the message body.

Data Type

String

msg_date property (IMAPClient Struct)

The date and time when the message entered the mail delivery system.

Syntax

fn msg_date(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_date(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_date_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The date and time when the message entered the mail delivery system.

This field contains the date and time at which the creator of the message posted the message to the mail delivery system.

The date is returned and accepted in UTC time zone.

Data Type

String

msg_delivery_receipt property (IMAPClient Struct)

Enables delivery notification.

Syntax

fn msg_delivery_receipt(&self ) -> Result<bool, SecureBlackboxError> 
fn set_msg_delivery_receipt(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables delivery notification.

Data Type

bool

msg_from property (IMAPClient Struct)

Contains the value of the From header property.

Syntax

fn msg_from(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_from(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_from_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the From header field.

This field contains the address(es) of the message author(s). If the actual sender is not the author of the message, use msg_sender to specify the sender separately.

Data Type

String

msg_handle property (IMAPClient Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn msg_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_msg_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

msg_html_text property (IMAPClient Struct)

The HTML version of the message.

Syntax

fn msg_html_text(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_html_text(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_html_text_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The HTML version of the message.

Data Type

String

msg_id property (IMAPClient Struct)

The contents of the Message-ID header property.

Syntax

fn msg_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The contents of the Message-ID header field.

This field contains a unique identifier that refers to a particular version of this message.

Data Type

String

msg_in_reply_to property (IMAPClient Struct)

The value of the In-Reply-To header property.

Syntax

fn msg_in_reply_to(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_in_reply_to(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_in_reply_to_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the In-Reply-To header field.

A reply message should have the "In-Reply-To:" header field which may be used to identify the message (or messages) to which the new message is a reply.

Data Type

String

msg_keywords property (IMAPClient Struct)

The value of the Keywords header property.

Syntax

fn msg_keywords(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_keywords(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_keywords_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the Keywords header field.

This field can be used to add some important words and phrases that might be useful for the recipient.

Data Type

String

msg_mailer property (IMAPClient Struct)

The name of the software that was used to send the message.

Syntax

fn msg_mailer(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The name of the software that was used to send the message.

This property is read-only.

Data Type

String

msg_plain_text property (IMAPClient Struct)

The plain text version of the message.

Syntax

fn msg_plain_text(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_plain_text(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_plain_text_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The plain text version of the message.

Data Type

String

msg_priority property (IMAPClient Struct)

Specifies the message priority.

Syntax

fn msg_priority(&self ) -> Result<i32, SecureBlackboxError> 
fn set_msg_priority(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Lowest
1   // Low
2   // Normal
3   // High
4   // Highest

Default Value

2

Remarks

Specifies the message priority.

Available options:

Data Type

i32

msg_read_receipt property (IMAPClient Struct)

Enables a read notification.

Syntax

fn msg_read_receipt(&self ) -> Result<bool, SecureBlackboxError> 
fn set_msg_read_receipt(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables a read notification.

Data Type

bool

msg_references property (IMAPClient Struct)

The value of the References header property.

Syntax

fn msg_references(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_references(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_references_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the References header field.

A reply message should include a "References:" header field which may be used to identify the "conversation thread". If the initial message is a reply itself, the References of the reply contain combined content of its "References:", "InReplyTo:" and "MessageID:" fields, subject to their presence in the original message.

Data Type

String

msg_reply_to property (IMAPClient Struct)

The value of the Reply-To header property.

Syntax

fn msg_reply_to(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_reply_to(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_reply_to_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the Reply-To header field.

This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the msg_from field.

Data Type

String

msg_return_path property (IMAPClient Struct)

The value of the Return-Path header property.

Syntax

fn msg_return_path(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_return_path(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_return_path_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the Return-Path header field.

This field contains the address to which this message shall be returned in case of unsuccessful delivery.

Data Type

String

msg_sender property (IMAPClient Struct)

The value of the Sender header property.

Syntax

fn msg_sender(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_sender(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_sender_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the Sender header field.

This field specifies the mailbox of the agent responsible for the actual transmission of this message. If the originator of the message can be indicated by a single mailbox and both the author and the transmitter are identical, the "Sender:" field is deemed excessive and should not be used.

Data Type

String

msg_send_to property (IMAPClient Struct)

The value of the To header property.

Syntax

fn msg_send_to(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_send_to(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_send_to_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the To header field.

This field specifies the address(es) of the primary recipient(s) of the message.

Data Type

String

msg_subject property (IMAPClient Struct)

Contains the subject property of this message.

Syntax

fn msg_subject(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_subject(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_subject_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the subject field of this message.

Data Type

String

msg_info_count property (IMAPClient Struct)

The number of records in the MsgInfo arrays.

Syntax

fn msg_info_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• msg_info_date
• msg_info_flags
• msg_info_from
• msg_info_internal_date
• msg_info_priority
• msg_info_sent_to
• msg_info_size
• msg_info_subject
• msg_info_uid

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

This property is read-only.

Data Type

i32

msg_info_date property (IMAPClient Struct)

Contains the value of the Date header property.

Syntax

fn msg_info_date(&self , MsgInfoIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the Date header field.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

This property is read-only.

Data Type

String

msg_info_flags property (IMAPClient Struct)

Returns the flags currently set to the mail message.

Syntax

fn msg_info_flags(&self , MsgInfoIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the flags currently set to the mail message.

Supported flags are:

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

This property is read-only.

Data Type

i32

msg_info_from property (IMAPClient Struct)

Contains the value of the From header property.

Syntax

fn msg_info_from(&self , MsgInfoIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the From header field.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

This property is read-only.

Data Type

String

msg_info_internal_date property (IMAPClient Struct)

Returns the internal date of the mail message.

Syntax

fn msg_info_internal_date(&self , MsgInfoIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Returns the internal date of the mail message.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

This property is read-only.

Data Type

String

msg_info_priority property (IMAPClient Struct)

Specifies the message priority.

Syntax

fn msg_info_priority(&self , MsgInfoIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Lowest
1   // Low
2   // Normal
3   // High
4   // Highest

Default Value

2

Remarks

Specifies the message priority.

Available options:

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

This property is read-only.

Data Type

i32

msg_info_sent_to property (IMAPClient Struct)

Contains the value of the To header property.

Syntax

fn msg_info_sent_to(&self , MsgInfoIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the To header field.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

This property is read-only.

Data Type

String

msg_info_size property (IMAPClient Struct)

Returns the size of the message in bytes.

Syntax

fn msg_info_size(&self , MsgInfoIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Returns the size of the message in bytes.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

This property is read-only.

Data Type

i64

msg_info_subject property (IMAPClient Struct)

Contains the value of the Subject header property.

Syntax

fn msg_info_subject(&self , MsgInfoIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the value of the Subject header field.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

This property is read-only.

Data Type

String

msg_info_uid property (IMAPClient Struct)

Returns the unique ID of the mail message.

Syntax

fn msg_info_uid(&self , MsgInfoIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the unique ID of the mail message.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

This property is read-only.

Data Type

i32

password property (IMAPClient Struct)

The authentication password.

Syntax

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

Default Value

""

Remarks

Use this property to provide the password for authenticating to the IMAP server.

In order to use OAuth 2.0 authentication to access the IMAP server, use the access_token property instead.

Data Type

String

proxy_address property (IMAPClient Struct)

The IP address of the proxy server.

Syntax

fn proxy_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

proxy_authentication property (IMAPClient Struct)

The authentication type used by the proxy server.

Syntax

fn proxy_authentication(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_authentication(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuthentication
1   // Basic
2   // Digest
3   // NTLM

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

i32

proxy_password property (IMAPClient Struct)

The password to authenticate to the proxy server.

Syntax

fn proxy_password(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

proxy_port property (IMAPClient Struct)

The port on the proxy server to connect to.

Syntax

fn proxy_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

i32

proxy_type property (IMAPClient Struct)

The type of the proxy server.

Syntax

fn proxy_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Socks4
2   // Socks5
3   // WebTunnel
4   // HTTP

Default Value

0

Remarks

The type of the proxy server.

Data Type

i32

proxy_request_headers property (IMAPClient Struct)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

fn proxy_request_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_request_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_request_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

proxy_response_body property (IMAPClient Struct)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

fn proxy_response_body(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_body(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_body_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

proxy_response_headers property (IMAPClient Struct)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

fn proxy_response_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

proxy_use_ipv6 property (IMAPClient Struct)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

fn proxy_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_proxy_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

bool

proxy_username property (IMAPClient Struct)

Specifies the username credential for proxy authentication.

Syntax

fn proxy_username(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_username(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_username_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

server_info_capabilities property (IMAPClient Struct)

Returns the list of server capabilities.

Syntax

fn server_info_capabilities(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Returns the list of server capabilities.

Use this property to get the list of IMAP capabilities (i.e., optional functionality of the server as defined in [RFC 3501]) obtained from the server.

This property is read-only.

Data Type

String

server_info_features property (IMAPClient Struct)

Returns the list of capabilities supported by the server.

Syntax

fn server_info_features(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Returns the list of capabilities supported by the server.

This value is bit mask of the following values:

This property is read-only.

Data Type

i64

server_info_supported_auths property (IMAPClient Struct)

Contains a comma-separated list of the authentication methods supported by the server.

Syntax

fn server_info_supported_auths(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains a comma-separated list of the authentication methods supported by the server.

Use this value to setup the Authentications config property if needed.

This property is read-only.

Data Type

String

session_log property (IMAPClient Struct)

Contains the complete log of the last session.

Syntax

fn session_log(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Use this property to access the session log produced by the struct. The log can be very useful when investigating connection issues.

See the SessionLogDetails config property for the log details settings.

This property is read-only.

Data Type

String

socket_dns_mode property (IMAPClient Struct)

Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system.

Syntax

fn socket_dns_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Auto
1   // Platform
2   // Own
3   // OwnSecure

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

i32

socket_dns_port property (IMAPClient Struct)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

fn socket_dns_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

i32

socket_dns_query_timeout property (IMAPClient Struct)

The timeout (in milliseconds) for each DNS query.

Syntax

fn socket_dns_query_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_query_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

i32

socket_dns_servers property (IMAPClient Struct)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

fn socket_dns_servers(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_dns_servers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_dns_servers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

socket_dns_total_timeout property (IMAPClient Struct)

The timeout (in milliseconds) for the whole resolution process.

Syntax

fn socket_dns_total_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_total_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

i32

socket_incoming_speed_limit property (IMAPClient Struct)

The maximum number of bytes to read from the socket, per second.

Syntax

fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_incoming_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

i32

socket_local_address property (IMAPClient Struct)

The local network interface to bind the socket to.

Syntax

fn socket_local_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_local_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_local_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

socket_local_port property (IMAPClient Struct)

The local port number to bind the socket to.

Syntax

fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_local_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

i32

socket_outgoing_speed_limit property (IMAPClient Struct)

The maximum number of bytes to write to the socket, per second.

Syntax

fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_outgoing_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

i32

socket_timeout property (IMAPClient Struct)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

i32

socket_use_ipv6 property (IMAPClient Struct)

Enables or disables IP protocol version 6.

Syntax

fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_socket_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

tls_client_cert_count property (IMAPClient Struct)

The number of records in the TLSClientCert arrays.

Syntax

fn tls_client_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_client_cert_bytes
• tls_client_cert_handle

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

Data Type

i32

tls_client_cert_bytes property (IMAPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_client_cert_bytes(&self , TLSClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

This property is read-only.

Data Type

Vec

tls_client_cert_handle property (IMAPClient Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn tls_client_cert_handle(&self , TLSClientCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_tls_client_cert_handle(&self, TLSClientCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

Data Type

i64

tls_server_cert_count property (IMAPClient Struct)

The number of records in the TLSServerCert arrays.

Syntax

fn tls_server_cert_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_server_cert_bytes
• tls_server_cert_fingerprint
• tls_server_cert_handle
• tls_server_cert_issuer
• tls_server_cert_issuer_rdn
• tls_server_cert_key_algorithm
• tls_server_cert_key_bits
• tls_server_cert_key_usage
• tls_server_cert_self_signed
• tls_server_cert_serial_number
• tls_server_cert_sig_algorithm
• tls_server_cert_subject
• tls_server_cert_subject_rdn
• tls_server_cert_valid_from
• tls_server_cert_valid_to

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

This property is read-only.

Data Type

i32

tls_server_cert_bytes property (IMAPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

Vec

tls_server_cert_fingerprint property (IMAPClient Struct)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

fn tls_server_cert_fingerprint(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_handle property (IMAPClient Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

i64

tls_server_cert_issuer property (IMAPClient Struct)

The common name of the certificate issuer (CA), typically a company name.

Syntax

fn tls_server_cert_issuer(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via tls_issuer_rdn.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_issuer_rdn property (IMAPClient Struct)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

fn tls_server_cert_issuer_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_key_algorithm property (IMAPClient Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn tls_server_cert_key_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the tls_key_bits, tls_curve, and tls_public_key_bytes properties to get more details about the key the certificate contains.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_key_bits property (IMAPClient Struct)

Returns the length of the public key in bits.

Syntax

fn tls_server_cert_key_bits(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the tls_public_key_bytes or tls_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

i32

tls_server_cert_key_usage property (IMAPClient Struct)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

fn tls_server_cert_key_usage(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

i32

tls_server_cert_self_signed property (IMAPClient Struct)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

fn tls_server_cert_self_signed(&self , TLSServerCertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

bool

tls_server_cert_serial_number property (IMAPClient Struct)

Returns the certificate's serial number.

Syntax

fn tls_server_cert_serial_number(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

Vec

tls_server_cert_sig_algorithm property (IMAPClient Struct)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

fn tls_server_cert_sig_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_subject property (IMAPClient Struct)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

fn tls_server_cert_subject(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via tls_subject_rdn.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_subject_rdn property (IMAPClient Struct)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

fn tls_server_cert_subject_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_valid_from property (IMAPClient Struct)

The time point at which the certificate becomes valid, in UTC.

Syntax

fn tls_server_cert_valid_from(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_valid_to property (IMAPClient Struct)

The time point at which the certificate expires, in UTC.

Syntax

fn tls_server_cert_valid_to(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_auto_validate_certificates property (IMAPClient Struct)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_auto_validate_certificates(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

bool

tls_base_configuration property (IMAPClient Struct)

Selects the base configuration for the TLS settings.

Syntax

fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_base_configuration(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // HighlySecure

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

Data Type

i32

tls_ciphersuites property (IMAPClient Struct)

A list of ciphersuites separated with commas or semicolons.

Syntax

fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_ciphersuites(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_ciphersuites_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by tls_base_configuration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

tls_client_auth property (IMAPClient Struct)

Enables or disables certificate-based client authentication.

Syntax

fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_auth(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

i32

tls_extensions property (IMAPClient Struct)

Provides access to TLS extensions.

Syntax

fn tls_extensions(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_extensions(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_extensions_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

tls_force_resume_if_destination_changes property (IMAPClient Struct)

Whether to force TLS session resumption when the destination address changes.

Syntax

fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_force_resume_if_destination_changes(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

bool

tls_groups property (IMAPClient Struct)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

fn tls_groups(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_groups(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_groups_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:

// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768";

The list of groups supported by the component is provided below. All the names are case-insensitive:

Elliptic curve-based groups:

• SECT163K1
• SECT163R1
• SECT163R2
• SECT193R1
• SECT193R2
• SECT233K1
• SECT233R1
• SECT239K1
• SECT283K1
• SECT283R1
• SECT409K1
• SECT409R1
• SECT571K1
• SECT571R1
• SECP160K1
• SECP160R1
• SECP160R2
• SECP192K1
• SECP192R1
• SECP224K1
• SECP224R1
• SECP256K1
• SECP256R1
• SECP384R1
• SECP521R1
• BRAINPOOLP256R1
• BRAINPOOLP384R1
• BRAINPOOLP512R1
• X25519
• X448

Finite field-based groups:

• FFDHE2048
• FFDHE3072
• FFDHE4096
• FFDHE6144
• FFDHE8192

Post-Quantum and Hybrid groups:

• MLKEM512
• MLKEM768
• MLKEM1024
• SECP256R1MLKEM768
• X25519MLKEM768
• SECP384R1MLKEM1024

Note: this property was called ECCurves in SecureBlackbox 2024 and older.

Data Type

String

tls_pre_shared_identity property (IMAPClient Struct)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_identity(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_identity_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Data Type

String

tls_pre_shared_key property (IMAPClient Struct)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Data Type

String

tls_pre_shared_key_ciphersuite property (IMAPClient Struct)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

tls_renegotiation_attack_prevention_mode property (IMAPClient Struct)

Selects the renegotiation attack prevention mechanism.

Syntax

fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

i32

tls_revocation_check property (IMAPClient Struct)

Specifies the kind(s) of revocation check to perform.

Syntax

fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Data Type

i32

tls_ssl_options property (IMAPClient Struct)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_ssl_options(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

i32

tls_mode property (IMAPClient Struct)

Specifies the TLS mode to use.

Syntax

fn tls_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

i32

tls_use_extended_master_secret property (IMAPClient Struct)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_extended_master_secret(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

bool

tls_use_session_resumption property (IMAPClient Struct)

Enables or disables the TLS session resumption capability.

Syntax

fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_session_resumption(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

tls_versions property (IMAPClient Struct)

The SSL/TLS versions to enable by default.

Syntax

fn tls_versions(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_versions(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

48

Remarks

The SSL/TLS versions to enable by default.

Data Type

i32

trusted_cert_count property (IMAPClient Struct)

The number of records in the TrustedCert arrays.

Syntax

fn trusted_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_trusted_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• trusted_cert_bytes
• trusted_cert_handle

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

Data Type

i32

trusted_cert_bytes property (IMAPClient Struct)

Returns the raw certificate data in DER format.

Syntax

fn trusted_cert_bytes(&self , TrustedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

Vec

trusted_cert_handle property (IMAPClient Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn trusted_cert_handle(&self , TrustedCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_trusted_cert_handle(&self, TrustedCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

Data Type

i64

username property (IMAPClient Struct)

The authentication username.

Syntax

fn username(&self ) -> Result<String, SecureBlackboxError> 
fn set_username(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_username_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to provide the username for authenticating to the IMAP server.

Data Type

String

close_mailbox method (IMAPClient Struct)

Closes the current mailbox.

Syntax

fn close_mailbox(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to close (i.e. deselect) the currently selected mailbox.

config method (IMAPClient Struct)

Sets or retrieves a configuration setting.

Syntax

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

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 (IMAPClient Struct)

Establishes a connection to the IMAP server.

Syntax

fn connect(&self, address : &str, port : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to establish a connection to the IMAP server at Address and Port.

copy_message method (IMAPClient Struct)

Copies a message to another mailbox.

Syntax

fn copy_message(&self, uid : i32, mailbox_name : &str) -> Result<(), SecureBlackboxError>

Remarks

Copies a message specified by its UID to another mailbox.

create_mailbox method (IMAPClient Struct)

Creates a new mailbox.

Syntax

fn create_mailbox(&self, name : &str) -> Result<(), SecureBlackboxError>

Remarks

Call this method to create a new mailbox, providing the name via the Name parameter.

delete_mailbox method (IMAPClient Struct)

Deletes an existing mailbox.

Syntax

fn delete_mailbox(&self, name : &str) -> Result<(), SecureBlackboxError>

Remarks

Call this method to delete a mailbox.

disconnect method (IMAPClient Struct)

Closes connection to the IMAP server.

Syntax

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

Remarks

Call this method to gracefully terminate the connection.

do_action method (IMAPClient Struct)

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

do_action is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

get_mailbox_info method (IMAPClient Struct)

Requests mailbox status.

Syntax

fn get_mailbox_info(&self, name : &str) -> Result<(), SecureBlackboxError>

Remarks

Requests status information of the specified mailbox and returns it using on_mailbox_info event.

list_mailboxes method (IMAPClient Struct)

Queries a list of mailboxes available on the server.

Syntax

fn list_mailboxes(&self) ->  Result<String, SecureBlackboxError>

Remarks

Use this method to request a list of mailboxes currently available on the server. The mailbox names are separated from each other with a CRLF sequence.

Another way to handle mailboxes is to subscribe to the on_mailbox_found event. Using the event, it's possible to get not only mailbox names but mailbox attributes as well.

list_messages method (IMAPClient Struct)

Queries a list of messages available in the currently selected on the server.

Syntax

fn list_messages(&self, flags_set : i32, flags_not_set : i32) -> Result<(), SecureBlackboxError>

Remarks

Call this method to request a list of messages with the set or not set flags available in the current mailbox.

FlagsSet and FlagsNotSet are bit masks of the following values:

If listed messages should have a flag set, pass it to FlagsSet. If listed messages should not have a flag, pass it to FlagsNotSet.

For example:

• if you need messages with the "draft" flag set, add imapMessageDraft to FlagsSet;
• if you need messages with no "seen" flag set, add imapMessageSeen to FlagsNotSet.

The flags in the parameters can be combined. For example, if you need messages with "answered" flag set but with no "flagged" flag set, pass imapMessageAnswered to FlagsSet and imapMessageFlagged to FlagsNotSet.

To list all the messages available in the selected mailbox, pass 0 to both parameters.

open_mailbox method (IMAPClient Struct)

Opens the specified mailbox.

Syntax

fn open_mailbox(&self, name : &str, read_only : bool) -> Result<(), SecureBlackboxError>

Remarks

Use this method to open (select) the specified mailbox on the server. Only one mailbox can be selected at a time. You can check the name of the currently selected mailbox using the mailbox property.

ping method (IMAPClient Struct)

Sends a NOOP command to the IMAP server.

Syntax

fn ping(&self) -> Result<(), SecureBlackboxError>

Remarks

This method sends a NOOP command to the server, effectively pinging the server and keeping the connection alive.

post_bytes method (IMAPClient Struct)

Uploads an e-mail message stored in a byte array.

Syntax

fn post_bytes(&self, bytes : &[u8], flags : i32, internal_date : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to upload a message stored in a byte array specified by Bytes to mailbox.

Supported flags are:

post_file method (IMAPClient Struct)

Uploads a message stored in a file to the current mailbox on the IMAP server.

Syntax

fn post_file(&self, file_name : &str, flags : i32, internal_date : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to upload an e-mail message stored in a file to mailbox.

Supported flags are:

post_message method (IMAPClient Struct)

Uploads a pre-built message to the current mailbox on the IMAP server.

Syntax

fn post_message(&self, flags : i32, internal_date : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this message to upload message to mailbox.

Supported flags are:

purge_messages method (IMAPClient Struct)

Permanently removes all deleted messages from the current mailbox.

Syntax

fn purge_messages(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to permanently remove all messages in mailbox marked with the Deleted flag.

receive_bytes method (IMAPClient Struct)

Downloads a message to a byte array.

Syntax

fn receive_bytes(&self, uid : i32) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to download a server-side message to a byte array.

receive_file method (IMAPClient Struct)

Downloads a message to a file.

Syntax

fn receive_file(&self, uid : i32, file_name : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to download a server-side message to a local file.

receive_message method (IMAPClient Struct)

Downloads a message.

Syntax

fn receive_message(&self, uid : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to download a server-side message to the message object.

refresh_mailbox method (IMAPClient Struct)

Refreshes info about the currently selected mailbox.

Syntax

fn refresh_mailbox(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to refresh the mailbox info.

To request information about other mailbox, call get_mailbox_info.

rename_mailbox method (IMAPClient Struct)

Renames an existing mailbox.

Syntax

fn rename_mailbox(&self, name : &str, new_name : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to rename an existing mailbox from Name to NewName.

reset method (IMAPClient Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

update_message method (IMAPClient Struct)

Alters flags associated with a message in the current mailbox on the IMAP server.

Syntax

fn update_message(&self, uid : i32, set_flags : i32, clear_flags : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to alter flags associated with a UID message in the currently selected mailbox.

Supported flags are:

If a flag is to be set, pass it to the SetFlags parameter. If a flag is to be cleared for a message, pass it to the ClearFlags parameter.

Notice: flags are cleared first, then set. So if you pass the same flag to both parameter, the flag will be set for the message.

on_auth_failed event (IMAPClient Struct)

Fires when an authentication attempt has failed.

Syntax

// IMAPClientAuthFailedEventArgs carries the IMAPClient AuthFailed event's parameters.
pub struct IMAPClientAuthFailedEventArgs {
  fn auth(&self) -> &String
  fn error_code(&self) -> i32
  fn error_message(&self) -> &String
  fn server_reply(&self) -> &String
  fn try_again(&self) -> bool
  fn set_try_again(&self, value : bool)
}

// IMAPClientAuthFailedEvent defines the signature of the IMAPClient AuthFailed event's handler function.
pub trait IMAPClientAuthFailedEvent {
  fn on_auth_failed(&self, sender : IMAPClient, e : &mut IMAPClientAuthFailedEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_auth_failed(&self) -> &'a dyn IMAPClientAuthFailedEvent;
  pub fn set_on_auth_failed(&mut self, value : &'a dyn IMAPClientAuthFailedEvent);
  ...
}

Remarks

The struct fires this event when an authentication attempt has failed for some reason.

Auth reports the authentication method that has failed. You can adjust the Authentications config property to try another method.

ErrorCode contains an error code, and ErrorMessage contains an error message.

ServerReply provides the error info reported by the server. This info depends on the transport protocol and on the authentication method.

Set the TryAgain parameter to true if the struct should try to authenticate again. If the parameter remains false, the authentication will fail with an exception.

on_auth_start event (IMAPClient Struct)

Fires when the authentication is about to be started.

Syntax

// IMAPClientAuthStartEventArgs carries the IMAPClient AuthStart event's parameters.
pub struct IMAPClientAuthStartEventArgs {
  fn usable_auths(&self) -> &String
}

// IMAPClientAuthStartEvent defines the signature of the IMAPClient AuthStart event's handler function.
pub trait IMAPClientAuthStartEvent {
  fn on_auth_start(&self, sender : IMAPClient, e : &mut IMAPClientAuthStartEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_auth_start(&self) -> &'a dyn IMAPClientAuthStartEvent;
  pub fn set_on_auth_start(&mut self, value : &'a dyn IMAPClientAuthStartEvent);
  ...
}

Remarks

The struct fires this event when it has established the TCP connection and is ready to proceed to the user authentication step.

The UsableAuths parameter contains a comma-separated list of the authentication methods supported by both, the client and the server.

In this event handler it's possible to update the method list in the Authentications config property according to the provided list of usable methods. The full list of the authentication methods supported by the server is available in ServerInfo.SupportedAuths.

on_auth_succeeded event (IMAPClient Struct)

Fires when the authentication has succeeded.

Syntax

// IMAPClientAuthSucceededEventArgs carries the IMAPClient AuthSucceeded event's parameters.
pub struct IMAPClientAuthSucceededEventArgs {
  fn auth(&self) -> &String
}

// IMAPClientAuthSucceededEvent defines the signature of the IMAPClient AuthSucceeded event's handler function.
pub trait IMAPClientAuthSucceededEvent {
  fn on_auth_succeeded(&self, sender : IMAPClient, e : &mut IMAPClientAuthSucceededEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_auth_succeeded(&self) -> &'a dyn IMAPClientAuthSucceededEvent;
  pub fn set_on_auth_succeeded(&mut self, value : &'a dyn IMAPClientAuthSucceededEvent);
  ...
}

Remarks

The struct fires this event when it has succeeded to authenticate to the server. Auth reports the authentication method that has succeeded.

on_command event (IMAPClient Struct)

Reports a command sent to the server.

Syntax

// IMAPClientCommandEventArgs carries the IMAPClient Command event's parameters.
pub struct IMAPClientCommandEventArgs {
  fn cmd(&self) -> &String
}

// IMAPClientCommandEvent defines the signature of the IMAPClient Command event's handler function.
pub trait IMAPClientCommandEvent {
  fn on_command(&self, sender : IMAPClient, e : &mut IMAPClientCommandEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_command(&self) -> &'a dyn IMAPClientCommandEvent;
  pub fn set_on_command(&mut self, value : &'a dyn IMAPClientCommandEvent);
  ...
}

Remarks

The struct fires this event whenever it sends an IMAP command to the server. Use on_command_reply and on_command_reply_data to track the server's responses.

on_command_data event (IMAPClient Struct)

Returns the data that accompanies the command.

Syntax

// IMAPClientCommandDataEventArgs carries the IMAPClient CommandData event's parameters.
pub struct IMAPClientCommandDataEventArgs {
  fn cmd(&self) -> &String
  fn data(&self) -> &String
}

// IMAPClientCommandDataEvent defines the signature of the IMAPClient CommandData event's handler function.
pub trait IMAPClientCommandDataEvent {
  fn on_command_data(&self, sender : IMAPClient, e : &mut IMAPClientCommandDataEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_command_data(&self) -> &'a dyn IMAPClientCommandDataEvent;
  pub fn set_on_command_data(&mut self, value : &'a dyn IMAPClientCommandDataEvent);
  ...
}

Remarks

Subscribe to this event to access data accompanying the outgoing commands.

on_command_reply event (IMAPClient Struct)

Reports the receipt of a reply to a command.

Syntax

// IMAPClientCommandReplyEventArgs carries the IMAPClient CommandReply event's parameters.
pub struct IMAPClientCommandReplyEventArgs {
  fn cmd(&self) -> &String
  fn reply(&self) -> &String
}

// IMAPClientCommandReplyEvent defines the signature of the IMAPClient CommandReply event's handler function.
pub trait IMAPClientCommandReplyEvent {
  fn on_command_reply(&self, sender : IMAPClient, e : &mut IMAPClientCommandReplyEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_command_reply(&self) -> &'a dyn IMAPClientCommandReplyEvent;
  pub fn set_on_command_reply(&mut self, value : &'a dyn IMAPClientCommandReplyEvent);
  ...
}

Remarks

Use this event to track command replies sent in by the server. Use on_command to track the commands sent out by the client, and on_command_reply_data to access the reply data for commands that assume it.

on_command_reply_data event (IMAPClient Struct)

Returns the data that accompanies a reply to a command.

Syntax

// IMAPClientCommandReplyDataEventArgs carries the IMAPClient CommandReplyData event's parameters.
pub struct IMAPClientCommandReplyDataEventArgs {
  fn cmd(&self) -> &String
  fn data(&self) -> &String
}

// IMAPClientCommandReplyDataEvent defines the signature of the IMAPClient CommandReplyData event's handler function.
pub trait IMAPClientCommandReplyDataEvent {
  fn on_command_reply_data(&self, sender : IMAPClient, e : &mut IMAPClientCommandReplyDataEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_command_reply_data(&self) -> &'a dyn IMAPClientCommandReplyDataEvent;
  pub fn set_on_command_reply_data(&mut self, value : &'a dyn IMAPClientCommandReplyDataEvent);
  ...
}

Remarks

Subscribe to this event to access data accompanying incoming command replies.

on_error event (IMAPClient Struct)

Provides information about errors during SMTP operations.

Syntax

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

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

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

Remarks

This event is fired in case of exceptional conditions occurred during SMTP operations.

ErrorCode contains an error code and Description contains a textual description of the error.

on_mailbox_found event (IMAPClient Struct)

Provides mailbox details.

Syntax

// IMAPClientMailboxFoundEventArgs carries the IMAPClient MailboxFound event's parameters.
pub struct IMAPClientMailboxFoundEventArgs {
  fn name(&self) -> &String
  fn delimiter(&self) -> &String
  fn attributes(&self) -> i32
}

// IMAPClientMailboxFoundEvent defines the signature of the IMAPClient MailboxFound event's handler function.
pub trait IMAPClientMailboxFoundEvent {
  fn on_mailbox_found(&self, sender : IMAPClient, e : &mut IMAPClientMailboxFoundEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_mailbox_found(&self) -> &'a dyn IMAPClientMailboxFoundEvent;
  pub fn set_on_mailbox_found(&mut self, value : &'a dyn IMAPClientMailboxFoundEvent);
  ...
}

Remarks

Subscribe to this event to get mailbox details published by list_mailboxes.

Delimiter is a mailbox hierarchy delimiter.

Attributes value is bit mask of the following values:

on_mailbox_info event (IMAPClient Struct)

Reports mailbox information returned from the server.

Syntax

// IMAPClientMailboxInfoEventArgs carries the IMAPClient MailboxInfo event's parameters.
pub struct IMAPClientMailboxInfoEventArgs {
  fn name(&self) -> &String
  fn total_messages(&self) -> i32
  fn recent_messages(&self) -> i32
  fn unseen_messages(&self) -> i32
  fn next_uid(&self) -> i32
  fn uid_validity(&self) -> i32
}

// IMAPClientMailboxInfoEvent defines the signature of the IMAPClient MailboxInfo event's handler function.
pub trait IMAPClientMailboxInfoEvent {
  fn on_mailbox_info(&self, sender : IMAPClient, e : &mut IMAPClientMailboxInfoEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_mailbox_info(&self) -> &'a dyn IMAPClientMailboxInfoEvent;
  pub fn set_on_mailbox_info(&mut self, value : &'a dyn IMAPClientMailboxInfoEvent);
  ...
}

Remarks

Subscribe to this event to be notified of mailbox info as returned by the IMAP server on get_mailbox_info call.

on_notification event (IMAPClient Struct)

This event notifies the application about an underlying control flow event.

Syntax

// IMAPClientNotificationEventArgs carries the IMAPClient Notification event's parameters.
pub struct IMAPClientNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// IMAPClientNotificationEvent defines the signature of the IMAPClient Notification event's handler function.
pub trait IMAPClientNotificationEvent {
  fn on_notification(&self, sender : IMAPClient, e : &mut IMAPClientNotificationEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_notification(&self) -> &'a dyn IMAPClientNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn IMAPClientNotificationEvent);
  ...
}

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the struct, the exact action it is performing, or the document being processed, one or both may be omitted.

on_progress event (IMAPClient Struct)

Reports the progress of the data transfer operation.

Syntax

// IMAPClientProgressEventArgs carries the IMAPClient Progress event's parameters.
pub struct IMAPClientProgressEventArgs {
  fn total(&self) -> i64
  fn current(&self) -> i64
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

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

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

Remarks

The struct fires this event repeatedly to report the progress of the data transfer operation.

on_tls_cert_needed event (IMAPClient Struct)

Fires when a remote TLS party requests a client certificate.

Syntax

// IMAPClientTLSCertNeededEventArgs carries the IMAPClient TLSCertNeeded event's parameters.
pub struct IMAPClientTLSCertNeededEventArgs {
  fn host(&self) -> &String
  fn ca_names(&self) -> &String
}

// IMAPClientTLSCertNeededEvent defines the signature of the IMAPClient TLSCertNeeded event's handler function.
pub trait IMAPClientTLSCertNeededEvent {
  fn on_tls_cert_needed(&self, sender : IMAPClient, e : &mut IMAPClientTLSCertNeededEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_tls_cert_needed(&self) -> &'a dyn IMAPClientTLSCertNeededEvent;
  pub fn set_on_tls_cert_needed(&mut self, value : &'a dyn IMAPClientTLSCertNeededEvent);
  ...
}

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the tls_client_chain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the on_tls_handshake event for the given host and, if the certificate was accepted, succeeded by the on_tls_established event.

on_tls_cert_validate event (IMAPClient Struct)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

// IMAPClientTLSCertValidateEventArgs carries the IMAPClient TLSCertValidate event's parameters.
pub struct IMAPClientTLSCertValidateEventArgs {
  fn server_host(&self) -> &String
  fn server_ip(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// IMAPClientTLSCertValidateEvent defines the signature of the IMAPClient TLSCertValidate event's handler function.
pub trait IMAPClientTLSCertValidateEvent {
  fn on_tls_cert_validate(&self, sender : IMAPClient, e : &mut IMAPClientTLSCertValidateEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_tls_cert_validate(&self) -> &'a dyn IMAPClientTLSCertValidateEvent;
  pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn IMAPClientTLSCertValidateEvent);
  ...
}

Remarks

This event is fired during a TLS handshake. Use the tls_server_chain property to access the certificate chain. In general, structs may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the struct, and can be adjusted if needed.

on_tls_established event (IMAPClient Struct)

Fires when a TLS handshake with Host successfully completes.

Syntax

// IMAPClientTLSEstablishedEventArgs carries the IMAPClient TLSEstablished event's parameters.
pub struct IMAPClientTLSEstablishedEventArgs {
  fn host(&self) -> &String
  fn version(&self) -> &String
  fn ciphersuite(&self) -> &String
  fn connection_id(&self) -> &[u8]
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// IMAPClientTLSEstablishedEvent defines the signature of the IMAPClient TLSEstablished event's handler function.
pub trait IMAPClientTLSEstablishedEvent {
  fn on_tls_established(&self, sender : IMAPClient, e : &mut IMAPClientTLSEstablishedEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_tls_established(&self) -> &'a dyn IMAPClientTLSEstablishedEvent;
  pub fn set_on_tls_established(&mut self, value : &'a dyn IMAPClientTLSEstablishedEvent);
  ...
}

Remarks

The struct uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

on_tls_handshake event (IMAPClient Struct)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

// IMAPClientTLSHandshakeEventArgs carries the IMAPClient TLSHandshake event's parameters.
pub struct IMAPClientTLSHandshakeEventArgs {
  fn host(&self) -> &String
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// IMAPClientTLSHandshakeEvent defines the signature of the IMAPClient TLSHandshake event's handler function.
pub trait IMAPClientTLSHandshakeEvent {
  fn on_tls_handshake(&self, sender : IMAPClient, e : &mut IMAPClientTLSHandshakeEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_tls_handshake(&self) -> &'a dyn IMAPClientTLSHandshakeEvent;
  pub fn set_on_tls_handshake(&mut self, value : &'a dyn IMAPClientTLSHandshakeEvent);
  ...
}

Remarks

The struct uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the on_tls_established event. If the server chooses to request a client certificate, the on_tls_cert_needed event will also be fired.

on_tls_psk event (IMAPClient Struct)

Notifies the application about the PSK key exchange.

Syntax

// IMAPClientTLSPSKEventArgs carries the IMAPClient TLSPSK event's parameters.
pub struct IMAPClientTLSPSKEventArgs {
  fn host(&self) -> &String
  fn hint(&self) -> &String
}

// IMAPClientTLSPSKEvent defines the signature of the IMAPClient TLSPSK event's handler function.
pub trait IMAPClientTLSPSKEvent {
  fn on_tls_psk(&self, sender : IMAPClient, e : &mut IMAPClientTLSPSKEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_tls_psk(&self) -> &'a dyn IMAPClientTLSPSKEvent;
  pub fn set_on_tls_psk(&mut self, value : &'a dyn IMAPClientTLSPSKEvent);
  ...
}

Remarks

The struct fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of tls_settings to provide the pre-shared key to the component.

on_tls_shutdown event (IMAPClient Struct)

Reports the graceful closure of a TLS connection.

Syntax

// IMAPClientTLSShutdownEventArgs carries the IMAPClient TLSShutdown event's parameters.
pub struct IMAPClientTLSShutdownEventArgs {
  fn host(&self) -> &String
}

// IMAPClientTLSShutdownEvent defines the signature of the IMAPClient TLSShutdown event's handler function.
pub trait IMAPClientTLSShutdownEvent {
  fn on_tls_shutdown(&self, sender : IMAPClient, e : &mut IMAPClientTLSShutdownEventArgs);
}

impl <'a> IMAPClient<'a> {
  pub fn on_tls_shutdown(&self) -> &'a dyn IMAPClientTLSShutdownEvent;
  pub fn set_on_tls_shutdown(&mut self, value : &'a dyn IMAPClientTLSShutdownEvent);
  ...
}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Config Settings (IMAPClient Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

IMAPClient Config Settings

Base Config Settings

Trappable Errors (IMAPClient Struct)

IMAPClient Errors