MailBee Namespace

MailBee namespace contains common classes, base classes, interface and enumerations used by all components in MailBee.NET Objects library.

Notable examples include clases for authentication, including OAuth 2, NTLM, Integrated Windows Authentication, classes for logging all activities into a file or memory, global settings, error-handling and exception related classes, and classes for localizing all messages generated by MailBee to other languages.

Classes
  ClassDescription
Public classCommonEventArgs
Represents an abstract parent of all event data classes in MailBee.
Public classConnectedEventArgs
Contains the event data for Connected events (such as Smtp.Connected, Pop3.Connected or Imap.Connected).
Public classDataTransferEventArgs
Contains the event data for data sending/receiving events (such as Smtp.DataSent, Smtp.DataReceived, Pop3.DataSent, Pop3.DataReceived, Imap.DataSent, Imap.DataReceived).
Public classDisconnectedEventArgs
Contains the event data for Disconnected events (such as Smtp.Disconnected, Pop3.Disconnected or Imap.Disconnected).
Public classErrorCodes
Provides error code values returned by ErrorCode property of MailBee exceptions and LastResult property of MailBee classes implementing this property.
Public classErrorEventArgs
Contains the event data for ErrorOccurred events (such as Smtp.ErrorOccurred, Pop3.ErrorOccurred or Imap.ErrorOccurred).
Public classGlobal
Provides properties specifying default values and parameter settings which apply to instances of all MailBee classes.
Public classHostResolvedEventArgs
Contains the event data for HostResolved events (such as Smtp.HostResolved, Pop3.HostResolved or Imap.HostResolved).
Public classLogEntry
Represents an entry to be added into the log file or memory log buffer.
Public classLoggedInEventArgs
Contains the event data for LoggedIn events (such as Smtp.LoggedIn, Pop3.LoggedIn or Imap.LoggedIn).
Public classCode exampleLogger
Provides logging facilities for MailBee components such as Smtp, Pop3, and Imap.
Public classLogNewEntryEventArgs
Contains the event data for LogNewEntry events (such as Smtp.LogNewEntry, Pop3.LogNewEntry or Imap.LogNewEntry).
Public classMailBeeAbortedByRemoteHostException
The exception that is thrown when the remote host suddenly closes the connection.
Public classMailBeeBatchException
The exception that is thrown when certain job in a batch of scheduled jobs fails and the component is configured to cancel processing in this case.
Public classMailBeeConnectionException
An abstract parent for all connection-level exceptions which indicate the connection cannot be used any longer and must be immediately closed.
Public classMailBeeDataParsingException
The exception that is thrown when an unexpected error occurs during converting a string or byte block into the required format (such as integer).
Public classMailBeeDataSyntaxException
This exception indicates that MailBee determined that the data passed had wrong syntax.
Public classMailBeeDateParsingException
The exception that is thrown when an unexpected error occurs during converting a string into DateTime.
Public classMailBeeEmailProtocolException
An abstract parent for all exceptions which indicate that an e-mail protocol (such as POP3, IMAP4 or SMTP) error has occurred.
Public classMailBeeEmailProtocolNegativeResponseException
An abstract parent for all exceptions which indicate that the mail server returned negative response, and the response data is available in text (i.e. string) form.
Public classMailBeeException
An abstract parent for all exceptions which can be thrown by MailBee library.
Public classMailBeeExternalException
The exception that is thrown when an error occurs in the code outside MailBee.
Public classMailBeeGetHostNameException
An abstract parent for all exceptions that are thrown if an attempt to resolve a host name through the call of a method of Dns class failed.
Public classMailBeeGetLocalHostNameException
The exception that is thrown if an attempt to get the local host name through the call of Dns class methods failed.
Public classMailBeeGetRemoteHostNameException
The exception that is thrown if an attempt to resolve the remote host name through the call of Dns class methods failed.
Public classMailBeeInternalException
The exception that is thrown when an unexpected error occurs in MailBee code.
Public classMailBeeInvalidArgumentException
The exception that is thrown when an invalid argument value is passed to a method or property.
Public classMailBeeInvalidResponseException
An abstract parent for all exceptions which indicate that a response received from the server cannot be parsed.
Public classMailBeeInvalidStateException
The exception that is thrown when the requested operation cannot be performed in the current state.
Public classMailBeeInvalidTextResponseException
The exception that is thrown when the text response received from the server cannot be parsed, and the response data is available.
Public classMailBeeInvalidTextResponseItemException
The exception that is thrown when a particular element of the text response received from the server cannot be parsed, and the response data is available.
Public classMailBeeIOException
The exception that is thrown when the IO operation with file or folder throws one of the following exceptions: IOException, UnauthorizedAccessException, FileNotFoundException, or XmlException.
Public classMailBeeLicenseException
The exception that is thrown during instantiation of a MailBee component or calling a static (Shared in Visual Basic) method of a component in the case when no valid license has been assigned to the component.
Public classMailBeeLocalException
The exception that is thrown when an error occurs due to user actions or problems with accessing local (not network) resources.
Public classMailBeeLoginNoCredentialsException
The exception that is thrown when the authentication process cannot proceed, because no account name and/or password was provided by the application.
Public classMailBeeLoginNoSupportedMethodsException
The exception that is thrown when the authentication process cannot proceed, because no authentication methods allowed by the application for authentication are supported by the server.
Public classMailBeeLoginNotPossibleException
An abstract parent for all exceptions which indicate that the authentication process cannot proceed under current conditions.
Public classMailBeeLoginWin32Exception
The exception that is thrown when underlying Win32 Schannel implementation of Integrated Windows Authentication returns an error.
Public classMailBeeNetworkException
An abstract parent for all exceptions that are thrown when network errors occur.
Public classMailBeeNoIP4HostFoundException
The exception that is thrown if no IPv4-compatible IP address was found for the given IPHostEntry during the connecting to the remote host.
Public classMailBeeProtocolException
An abstract parent for all exceptions which indicate that an application-level protocol error has occurred.
Public classMailBeeProtocolExtensionNotSupportedException
The exception that is thrown when the mail server does not support certain extension (capability) which is required for the current operation to complete successfully.
Public classMailBeeRemoteHostException
An abstract parent for all exceptions which occur when MailBee attempts to establish connection or send/receive data to/from the server at the given IP address and port number.
Public classMailBeeRemoteHostResponseTimeoutException
The exception that is thrown when the remote host returns the response so slowly that it cannot be tolerated by the client.
Public classMailBeeSocketAbortedException
The exception that is thrown when underlying socket operation receives abort request from the software on the local machine and throws SocketException.
Public classMailBeeSocketException
The exception that is thrown when underlying socket operation throws SocketException or IOException.
Public classMailBeeSocketHostDownException
The exception that is thrown when underlying socket operation detects a dead host and throws SocketException.
Public classMailBeeSocketHostNotFoundException
The exception that is thrown when underlying socket operation detects an unknown host and throws SocketException.
Public classMailBeeSocketHostUnreachableException
The exception that is thrown when underlying socket operation detects there is no known route to the host and throws SocketException.
Public classMailBeeSocketObjectDisposedException
The exception that is thrown when underlying socket operation unexpectedly throws ObjectDisposedException.
Public classMailBeeSocketRefusedException
The exception that is thrown when underlying socket operation detects the remote machine refused the connection (which usually means no server program is running on the remote host) and throws SocketException.
Public classMailBeeSocketResetException
The exception that is thrown when the connection was forcibly closed by the remote host so that underlying socket implementation throws SocketException.
Public classMailBeeSocketTimeoutException
The exception that is thrown when underlying socket operation encounters a timeout and throws SocketException.
Public classMailBeeStreamException
The exception that is thrown when the operation with data stream throws IOException.
Public classMailBeeSystemSettingsException
The exception that is thrown when an attempt to request certain information from the system failed.
Public classMailBeeUserAbortException
The exception that is thrown after Abort method of MailBee component has been called.
Public classMailBeeWebException
The exception that is thrown when underlying network operation throws the WebException.
Public classCode exampleOAuth
This class provides methods for OAuth 1.0 authentication process.
Public classCode exampleOAuth2
This class provides methods for OAuth 2.0 authentication process.
Public classCode exampleOpenID Obsolete.
This class provides methods for OpenID authentication process. It can be used with OAuth class for hybrid OpenID + OAuth authentication.
Public classCode exampleResources
Provides localization and text customization framework for MailBee library.
Public classCode exampleSaslMethod
Provides a framework for developing custom SASL authentication mechanisms.
Public classSocketConnectedEventArgs
Contains the event data for SocketConnected events (such as Smtp.SocketConnected, Pop3.SocketConnected or Imap.SocketConnected).
Public classSocketCreatingEventArgs
Contains the event data for SocketCreating events (such as Smtp.SocketCreating, Pop3.SocketCreating or Imap.SocketCreating).
Public classSortableByPriorityCollection
Represents an abstract parent for all MailBee collections sorted by Priority value of their elements.
Public classTlsStartedEventArgs
Contains the event data for TlsStarted events (such as Smtp.TlsStarted, Pop3.TlsStarted or Imap.TlsStarted).
Interfaces
  InterfaceDescription
Public interfaceIMailBeeFatalException
When implemented by an exception class, indicates the exception is fatal and the component is no longer usable in the current state, so that any active tasks must be finished as soon as possible.
Public interfaceIMailBeeLoginBadCredentialsException
When implemented by an exception class, indicates the authentication failed due to use of incorrect account name and/or password.
Public interfaceIMailBeeLoginBadMethodException
When implemented by an exception class, indicates the server returned negative response during the authentication process because the requested authentication method is not available.
Public interfaceIMailBeeLoginException
When implemented by an exception class, indicates the login process failed, and the application should try to authenticate using either another account name and password or another authentication method.
Public interfaceIMailBeeLoginNegativeResponseException
When implemented by an exception class, indicates the server returned negative response during the authentication process, and the response data is available in text (i.e. string) form.
Public interfaceIMailBeeNegativeResponseException
When implemented by an exception class, indicates the server returned negative response, and the response data is available.
Public interfaceIMailBeeNegativeTextResponseException
When implemented by an exception class, indicates the server returned negative response, and the response data is available in text (i.e. string) form.
Public interfaceIMailBeeSocketMustCloseException
When implemented by an exception class, indicates the network exception is connection level (not application protocol level), so that the connection is no longer valid and will be closed.
Public interfaceIMailBeeWin32Exception
When implemented by an exception class, indicates that this exception is thrown when underlying Win32 function returns an error.
Delegates
  DelegateDescription
Public delegateConnectedEventHandler
Represents the method that will handle Connected events (such as Smtp.Connected, Pop3.Connected or Imap.Connected).
Public delegateDataTransferEventHandler
Represents the method that will handle events which occur on sending or receiving data to/from the server (such as Smtp.DataSent, Smtp.DataReceived, Pop3.DataSent, Pop3.DataReceived, Imap.DataSent, Imap.DataReceived).
Public delegateDisconnectedEventHandler
Represents the method that will handle Disconnected events (such as Smtp.Disconnected, Pop3.Disconnected or Imap.Disconnected).
Public delegateErrorEventHandler
Represents the method that will handle ErrorOccurred events (such as Smtp.ErrorOccurred, Pop3.ErrorOccurred or Imap.ErrorOccurred).
Public delegateHostResolvedEventHandler
Represents the method that will handle HostResolved events (such as Smtp.HostResolved, Pop3.HostResolved or Imap.HostResolved).
Public delegateLoggedInEventHandler
Represents the method that will handle LoggedIn events (such as Smtp.LoggedIn, Pop3.LoggedIn or Imap.LoggedIn).
Public delegateLogNewEntryEventHandler
Represents the method that will handle LogNewEntry events (such as Smtp.LogNewEntry, Pop3.LogNewEntry or Imap.LogNewEntry).
Public delegateSocketConnectedEventHandler
Represents the method that will handle SocketConnected events (such as Smtp.SocketConnected, Pop3.SocketConnected or Imap.SocketConnected).
Public delegateSocketCreatingEventHandler
Represents the method that will handle SocketCreating events (such as Smtp.SocketCreating, Pop3.SocketCreating or Imap.SocketCreating).
Public delegateTlsStartedEventHandler
Represents the method that will handle TlsStarted events (such as Smtp.TlsStarted, Pop3.TlsStarted or Imap.TlsStarted).
Enumerations
  EnumerationDescription
Public enumerationAuthenticationMethods
Provides authentication methods to be used for logging in the user account on the server.
Public enumerationAuthenticationOptions
Provides flags for tuning the authentication process.
Public enumerationCode exampleLogFormatOptions
Provides flags which can be used to change formatting of log messages produced by MailBee.
Public enumerationLogMessageType
Specifies the type of the log entry.
Public enumerationTopLevelProtocolType
Defines types of MailBee main protocols.