| Visual Basic (Declaration) | |
|---|---|
Public Overloads Sub Login( _ ByVal server As String, _ ByVal username As String, _ ByVal password As String _ ) | |
| Visual Basic (Usage) | Copy Code |
|---|---|
Dim instance As Pop Dim server As String Dim username As String Dim password As String instance.Login(server, username, password) | |
Parameters
- server
- The POP server to log in to.
- username
- Username used to log in to the POP server.
- password
- Password used to log in to the POP server.
| Exception | Description |
|---|---|
| Dart.PowerTCP.Mail.ProtocolException | Bad POP protocol response received from server. |
| System.Net.Sockets.SocketException | The requested address is not valid in its context. |
| System.IO.IOException | The filename, directory name, or volume label syntax is incorrect. |
| System.ArgumentException | A required argument contains invalid characters, is empty, or contains only white spaces. |
The following example demonstrates logging into a POP server and retrieving all messages.
| Visual Basic | Copy Code |
|---|---|
' Be sure to import the namespace by putting "Imports Dart.PowerTCP.Mail" ' at the top of your class. ' Automatically remove files after getting them from the server Pop1.AutoDelete = True ' Login. The default settings will cause the Pop component to ' automatically retrieve all messages, delete them from the ' server, and logout. Pop1.Login("mail.test.com", "testuser", "testpass") ' All message retrieved. Iterate through the collection ' and display data. Dim msg As PopMessage For Each msg In Pop1.Messages Debug.WriteLine("Message ID: " + msg.Id) Debug.WriteLine("Message UID: " + msg.Uid) Debug.WriteLine("Messge Size: " + msg.Size) Debug.WriteLine("From: " + msg.Message.From.Address) Debug.WriteLine("Subject: " + msg.Message.Subject) Next | |
| C# | Copy Code |
|---|---|
// Be sure to import the namespace by putting "using Dart.PowerTCP.Mail;" // at the top of your class. // Automatically remove files after getting them from the server pop1.AutoDelete = true; // Login. The default settings will cause the Pop component to // automatically retrieve all messages, delete them from the // server, and logout. pop1.Login("mail.test.com", "testuser", "testpass"); // All message retrieved. Iterate through the collection // and display data. foreach(PopMessage msg in pop1.Messages) { Debug.WriteLine("Message ID: " + msg.Id); Debug.WriteLine("Message UID: " + msg.Uid); Debug.WriteLine("Messge Size: " + msg.Size); Debug.WriteLine("From: " + msg.Message.From.Address); Debug.WriteLine("Subject: " + msg.Message.Subject); } | |
This method represents the quickest and easiest means of logging in to a POP server. Upon logging in, the Pop.Message property will be populated with the new messages available on the POP server. The Pop component can be configured to populate the Pop.Message property with message data in one of three ways upon login:
- If Pop.AutoGet = MessageSection.None the Pop.Messages collection will be populated with MessageStream objects containing the minimal data returned from the server about the message (id, unique id, and size of the message).
- If Pop.AutoGet = MessageSection.Complete then the Pop.Messages collection will be populated with MessageStream objects containing the full message.
- If Pop.AutoGet = MessageSection.Header then the Pop.Messages collection will be populated with MessageStream objects containing only the header.
To log in to the POP server asynchronously, use Pop.BeginLogin.
Target Platforms: Microsoft .NET Framework 2.0