View source for POP3SecureSocket

{{ClassBox
| super=[[SSLSocket]]
| platform=all
| scope=global
}}
{{Description
|text = Used to retrieve messages on a POP3 mail server using SSL or TLS encryption. }}

<dynamicTable id="Events" super="SSLSocket" exclude="Connected,DataAvailable,Error" class="eventTable" title="Events" columns="3">
{{Event | name=ConnectionEstablished | description=ConnectionEstablished()&#x0A;Occurs when a connection has been established. }}
{{Event | name=Disconnected | description=Disconnected()&#x0A;Occurs when the connection has been terminated. }}
{{Event | name=ListReceived | params=List as [[String]] | description=ListReceived(List as String)&#x0A;Executes when the ListMessages method is called. }}
{{Event | name=LoginSuccessful | description= LoginSuccessful()&#x0A;Executes when the login process initiated by calling the Connect method is complete. }}
{{Event | name=MessagesCounted | params=Count as [[Integer]] | description=MessagesCounted(Count as Integer)&#x0A;Executes when the mail server replies to a CountMessages call and contains the number of messages in the mailbox }}
{{Event | name=MessageDeleted | params=Index as [[Integer]] | description=MessageDeleted(Index as Integer)&#x0A;Executes when the mail server replies to a DeleteMessage call and contains the index number of the deleted message }}
{{Event | name=MessageReceived | params=Index as [[Integer]],Message as [[EmailMessage|emailMessage]] | description=MessageReceived(Index as Integer,Message as EmailMessage)&#x0A;Executes when a message has been received from the mail server, in response to a call to RetrieveMessage }}
{{Event | name=RollbackSuccessful | description= RollbackSuccessful()&#x0A;Executes in response to a call to RollbackServer and indicates that the state of the mailbox has been reset }}
{{Event | name=ServerAvailable | description=ServerAvailable()&#x0A;Executes when the mail server has replied to a call to CheckServerConnection and indicates that the mail server has replied to the call }}
{{Event | name=ServerCommandReply | params=command as [[String]], data as [[String]] | description= ServerCommandReply(Command as String, Data as String)&#x0A;Executes in response to a call to SendServerCommand and contains the mail server's response to the command passed }}
{{Event | name=ServerError | params=ErrorCode as [[Integer]],ErrorMessage as [[String]],   MessageID as [[Integer]] | description=ServerError(ErrorCode as Integer, ErrorMessage as String, MessageID as Integer)&#x0A;Executes when a protocol-related error occurs.  }}
{{Event | name=TopLinesReceived | params=Index as [[Integer]],Data as [[EmailMessage]] | description=TopLinesReceived(Index as Integer,Data as EmailMessage)&#x0A;Executes in response to a call to RetrieveLines.  }}
</dynamicTable>

<dynamicTable id="Properties" super="SSLSocket" class="propertyTable" title="Properties" columns="3">
{{Property | name=EncryptPassword | type=Boolean | platform=all | description=(Boolean)&nbsp;&nbsp;If True, the password is encrypted when being sent to the mail server. }}
{{Property | name=Password | type=String | platform=all | description=(String)&nbsp;&nbsp;The password to use for security when connecting to the mail server. }}
{{Property | name=Username | type=String | platform=all | description=(String)&nbsp;&nbsp;The username to use for authentication when connecting to the mail server. }}
</dynamicTable>


<dynamicTable id="Methods" super="SSLSocket" class="methodTable" title="Methods" columns="3">
{{Method | name=CheckServerConnection | description=CheckServerConnection()&#x0A;Sends a "NOOP" command to the mail server.  }}
{{Method | name=RemoveMessageAt | params=Index as [[Integer]] | description=RemoveMessageAt(Index as Integer)&#x0A;Tells the mail server to remove the specified message. }}
{{Method | name=DisconnectFromServer | description=DisconnectFromServer()&#x0A;Disconnects from the mail server.  }}
{{Method | name=MessagesCounted | description=MessagesCounted()&#x0A;Asks the server for the number of messages in the mailbox.  }}
{{Method | name=RequestMessages | params=[Index as [[Integer]]] | description=RequestMessages([Index as Integer])&#x0A;Requests a message listing.  }}
{{Method | name=RetrieveLinesAt | params=Index as [[Integer]], LineCount as [[Integer]] | description=RetrieveLinesAt(Index as Integer, LineCount as Integer)&#x0A;Returns the specified number of lines of a message.  }}
{{Method | name=RetrieveMessageAt | params=Index as [[Integer]] | description=RetrieveMessageAt(Index as Integer)&#x0A;Reads the entire message specified by Index. }}
{{Method | name=RollbackServer | description=RollbackServer()&#x0A;Resets the mail server to the state that it was when you logged in.  }}
{{Method | name=SendCommand | params=Command as [[String]] | description=SendCommand(Command as String)&#x0A;Sends the command specified by Command to the mail server.  }}
</dynamicTable>

==Notes==
The '''POP3SecureSocket''' class is identical to the [[POP3Socket]] class, except that it is derived from the [[SSLSocket]] class instead of the [[TCPSocket]] class. This enables you to send secure email by setting the Secure property of the [[SSLSocket]] class.

If you use a constructor of a subclass of '''POP3SecureSocket''', you must call the Super class's constructor in your subclass's constructor. The subclass will not work unless this is done.

== Sample Code ==
The following code in the MessageReceived event handler places the body of an email message in a [[DesktopTextArea|TextArea]].

<rbcode>
Sub MessageReceived(ID As Integer, email As EmailMessage)
  Var s As String
  s = email.BodyHTML
  If s = "" Then
    s = email.BodyPlainText
  End If
  TextArea1.Text = s
End Sub
</rbcode>

==See Also==
[[EmailMessage]], [[HTTPSocket]], [[POP3Socket]], [[SMTPSecureSocket]], [[SMTPSocket]], [[SSLSocket]], [[SocketCore]], [[TCPSocket]] classes.


[[Category:Internet/Networking_Networking]]
[[Category:Internet/Networking_Internet]]]
[[Category:Internet/Networking_Email]]
[[Category:Language_Classes]]