Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
Pop3Client Class Reference

Pop3Client handles and manipulates POP3 clients. More...

Inheritance diagram for Pop3Client:
Process

Public Member Functions

void mailReceived (string, string, QString, QString)
 This event is emitted when the POP3 client receives an email. More...
 
void errorReceivingMail (Pop3ResponseType)
 This event is emitted when the POP3 client had an error retrieving email. More...
 
bool getMailIpc ()
 Gets mail. More...
 
void cancelReceive ()
 Cancels receive. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

Pop3Client handles and manipulates POP3 clients.

Member Function Documentation

◆ cancelReceive()

void Pop3Client::cancelReceive ( )

Cancels receive.

◆ errorReceivingMail()

void Pop3Client::errorReceivingMail ( Pop3ResponseType  )

This event is emitted when the POP3 client had an error retrieving email.

  • responseType, the response type. Response types: ePop3Request = 1, ePop3ResponseSuccess = 2, ePop3ResponseError = 3, ePop3Timeout = 4, ePop3PeerReset = 5, ePop3DnsServerNotFound = 6, ePop3DnsUnResolvedHostName = 7, ePop3ProtocolError = 8, ePop3UserNotFound = 9

IPC event.

◆ getMailIpc()

bool Pop3Client::getMailIpc ( )

Gets mail.

Returns
bool, always returns true.

◆ mailReceived()

void Pop3Client::mailReceived ( string  ,
string  ,
QString  ,
QString   
)

This event is emitted when the POP3 client receives an email.

  • sender, the sender of the email.
  • subject, the subject of the email.
  • dateTime, the date time.
  • body, the body of the email.

IPC event.


The documentation for this class was generated from the following file: