Pop 3Protocol Exception Class
A POP3 protocol exception.
Definition
Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public class Pop3ProtocolException : ProtocolException- Inheritance
- Object Exception ProtocolException Pop3ProtocolException
Remarks
The exception that is thrown when there is an error communicating with a POP3 server. A
Pop3ProtocolException is typically fatal and requires the Pop3Client
to be reconnected.
Example
C#
public static void DownloadNewMessages (HashSet<string> previouslyDownloadedUids)
{
using (var client = new Pop3Client ()) {
IList<string> uids = null;
try {
client.Connect ("pop.gmail.com", 995, SecureSocketOptions.SslOnConnect);
} catch (Pop3CommandException ex) {
Console.WriteLine ("Error trying to connect: {0}", ex.Message);
Console.WriteLine ("\tStatusText: {0}", ex.StatusText);
return;
} catch (Pop3ProtocolException ex) {
Console.WriteLine ("Protocol error while trying to connect: {0}", ex.Message);
return;
}
try {
client.Authenticate ("username", "password");
} catch (AuthenticationException ex) {
Console.WriteLine ("Invalid user name or password.");
return;
} catch (Pop3CommandException ex) {
Console.WriteLine ("Error trying to authenticate: {0}", ex.Message);
Console.WriteLine ("\tStatusText: {0}", ex.StatusText);
return;
} catch (Pop3ProtocolException ex) {
Console.WriteLine ("Protocol error while trying to authenticate: {0}", ex.Message);
return;
}
// for the sake of this example, let's assume GMail supports the UIDL extension
if (client.Capabilities.Contains (Pop3Capability.UIDL)) {
try {
uids = client.GetMessageUids ();
} catch (Pop3CommandException ex) {
Console.WriteLine ("Error trying to get the list of uids: {0}", ex.Message);
Console.WriteLine ("\tStatusText: {0}", ex.StatusText);
// we'll continue on leaving uids set to null...
} catch (Pop3ProtocolException ex) {
Console.WriteLine ("Protocol error while trying to authenticate: {0}", ex.Message);
// Pop3ProtocolExceptions often cause the connection to drop
if (!client.IsConnected)
return;
}
}
for (int i = 0; i < client.Count; i++) {
if (uids != null && previouslyDownloadedUids.Contains (uids[i])) {
// we must have downloaded this message in a previous session
continue;
}
try {
// download the message at the specified index
var message = client.GetMessage (i);
// write the message to a file
if (uids != null) {
message.WriteTo (string.Format ("{0}.eml", uids[i]));
// keep track of our downloaded message uids so we can skip downloading them next time
previouslyDownloadedUids.Add (uids[i]);
} else {
message.WriteTo (string.Format ("{0}.eml", i));
}
} catch (Pop3CommandException ex) {
Console.WriteLine ("Error downloading message {0}: {1}", i, ex.Message);
Console.WriteLine ("\tStatusText: {0}", ex.StatusText);
continue;
} catch (Pop3ProtocolException ex) {
Console.WriteLine ("Protocol error while sending message {0}: {1}", i, ex.Message);
// most likely the connection has been dropped
if (!client.IsConnected)
break;
}
}
if (client.IsConnected) {
// if we do not disconnect cleanly, then the messages won't actually get deleted
client.Disconnect (true);
}
}
}
Constructors
| Pop3ProtocolException | Initializes a new instance of the Pop3ProtocolException class. |
| Pop3ProtocolException(String) | Initializes a new instance of the Pop3ProtocolException class. |
| Pop3ProtocolException(String, ProtocolErrorType) | Initializes a new instance of the Pop3ProtocolException class. |
| Pop3ProtocolException(String, Exception) | Initializes a new instance of the Pop3ProtocolException class. |
| Pop3ProtocolException(String, ProtocolErrorType, Exception) | Initializes a new instance of the Pop3ProtocolException class. |
Properties
| Data | Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception) |
| ErrorType |
Get the type of protocol error.
(Inherited from ProtocolException) |
| HelpLink | Gets or sets a link to the help file associated with this exception. (Inherited from Exception) |
| HResult | Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception) |
| InnerException | Gets the Exception instance that caused the current exception. (Inherited from Exception) |
| Message | Gets a message that describes the current exception. (Inherited from Exception) |
| Source | Gets or sets the name of the application or the object that causes the error. (Inherited from Exception) |
| StackTrace | Gets a string representation of the immediate frames on the call stack. (Inherited from Exception) |
| TargetSite | Gets the method that throws the current exception. (Inherited from Exception) |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetBaseException | When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the runtime type of the current instance. (Inherited from Exception) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Creates and returns a string representation of the current exception. (Inherited from Exception) |
Events
| SerializeObjectState | Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception) |