SocketTools .NET Edition

PopClient Members

PopClient overview

Public Static (Shared) Fields

popPortDefaultA constant value which specifies the default port number.
popPortSecureA constant value which specifies the default port number for a secure connection.
popTimeoutA constant value which specifies the default timeout period.

Public Instance Constructors

PopClient Constructor Initializes a new instance of the PopClient class.

Public Instance Properties

AuthenticationGets and sets the method used to authenticate the user.
AutoResolve Gets and sets a value that determines if host names and addresses are automatically resolved.
BearerToken Gets and sets the bearer token used with OAuth 2.0 authentication.
BlockingGets and sets a value which indicates if the client is in blocking mode.
CertificateExpiresGet a value that specifies the date that the security certificate expires.
CertificateIssued Get a value that specifies the date that the security certificate was issued.
CertificateIssuer Get a value that provides information about the organization that issued the certificate.
CertificateNameGets and sets a value that specifies the name of the client certificate.
CertificatePasswordGets and sets the password associated with the client certificate.
CertificateStatus Gets a value which indicates the status of the security certificate returned by the remote host.
CertificateStore Gets and sets a value that specifies the name of the local certificate store.
CertificateSubject Gets a value that provides information about the organization that the server certificate was issued to.
CertificateUserGets and sets the user that owns the client certificate.
CipherStrength Gets a value that indicates the length of the key used by the encryption algorithm for a secure connection.
Handle Gets a value that specifies the client handle allocated for the current session.
HashStrength Gets a value which specifies the length of the message digest that was selected for a secure connection.
HeaderFieldGets and sets the current header field name.
HeaderValueGets the value of the current header field.
HostAddress Gets and sets a value which specifies the Internet address used to establish a connection.
HostName Gets and sets a value which specifies the host name used to establish a connection.
IsBlocked Gets a value which indicates if the current thread is performing a blocking client operation.
IsConnected Gets a value which indicates if a connection to the remote host has been established.
IsInitialized Gets a value which indicates if the current instance of the class has been initialized successfully.
IsReadable Gets a value which indicates if there is data available to be read from the socket connection to the server.
IsWritable Gets a value which indicates if data can be written to the client without blocking.
LastErrorGets and sets a value which specifies the last error that has occurred.
LastErrorStringGets a value which describes the last error that has occurred.
LastMessageGets the number of the last message available in the current mailbox.
LocalAddressGets the local Internet address that the client is bound to.
LocalNameGets a value which specifies the host name for the local system.
LocalPort Gets the local port number the client is bound to.
MailboxSizeGets the size of the current mailbox.
MessageGets and sets the current message number.
MessageCountGets the number of messages available in the mailbox.
MessageFromGets the address of the user who sent the message.
MessageSizeGets the size of the current message in bytes.
MessageUIDGets the UID for the current message.
OptionsGets and sets a value which specifies one or more client options.
PasswordGets and sets the password used to authenticate the client.
RemotePortGets and sets a value which specifies the remote port number.
RemoteServiceGets and sets a value which specifies the remote service.
ResultCode Gets a value which specifies the result of the last command executed by the server.
ResultStringGets a string value which describes the result of the previous command.
Secure Gets and sets a value which specifies if a secure connection is established.
SecureCipher Gets a value that specifies the encryption algorithm used for a secure connection.
SecureHash Gets a value that specifies the message digest algorithm used for a secure connection.
SecureKeyExchange Gets a value that specifies the key exchange algorithm used for a secure connection.
SecureProtocol Gets and sets a value which specifies the protocol used for a secure connection.
StatusGets a value which specifies the current status of the client.
ThreadModel Gets and sets a value which specifies the threading model for the class instance.
ThrowError Gets and sets a value which specifies if method calls should throw exceptions when an error occurs.
TimeoutGets and sets a value which specifies a timeout period in seconds.
Trace Gets and sets a value which indicates if network function logging is enabled.
TraceFile Gets and sets a value which specifies the name of the logfile.
TraceFlagsGets and sets a value which specifies the client function tracing flags.
UserNameGets and sets the username used to authenticate the client session.
Version Gets a value which returns the current version of the PopClient class library.

Public Instance Methods

AttachThreadAttach an instance of the class to the current thread
CancelCancel the current blocking client operation.
ChangePasswordChange the mailbox password for the current user.
CloseMessageCloses the current message.
CommandOverloaded. Send a custom command to the server.
ConnectOverloaded. Establish a connection with a remote host.
DeleteMessageOverloaded. Flags a message for deletion from the current mailbox.
DisconnectTerminate the connection with a remote host.
DisposeOverloaded. Releases all resources used by PopClient.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetHeaderOverloaded. Returns the value of a header field from the specified message.
GetHeadersOverloaded. Retrieves the headers for the specified message from the server.
GetMessageOverloaded. Retrieve a message from the server and return the contents in a byte array.
GetType (inherited from Object) Gets the Type of the current instance.
InitializeOverloaded. Initialize an instance of the PopClient class.
OpenMessageOverloaded. Open the specified message for reading.
ReadOverloaded. Read data from the server and store it in a byte array.
Reset Reset the internal state of the object, resetting all properties to their default values.
SendMessageOverloaded. Submits a message to the mail server for delivery.
StoreMessageOverloaded. Retrieve a message from the current mailbox and store it in a file on the local system.
ToString (inherited from Object) Returns a String that represents the current Object.
Uninitialize Uninitialize the class library and release any resources allocated for the current thread.
WriteOverloaded. Write one or more bytes of data to the server.

Public Instance Events

OnCancelOccurs when a blocking client operation is canceled.
OnConnectOccurs when a connection is established with the remote host.
OnDisconnectOccurs when the remote host disconnects from the local system.
OnErrorOccurs when an client operation fails.
OnProgressOccurs as a data stream is being read or written to the client.
OnReadOccurs when data is available to be read from the client.
OnTimeout Occurs when a blocking operation fails to complete before the timeout period elapses.
OnWriteOccurs when data can be written to the client.

Protected Instance Methods

DisposeOverloaded. Releases the unmanaged resources allocated by the PopClient class and optionally releases the managed resources.
Finalize Destroys an instance of the class, releasing the resources allocated for the session and unloading the networking library.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

PopClient Class | SocketTools Namespace