Sming Framework API
Sming - Open Source framework for high efficiency WiFi SoC ESP8266 native development with C++ language.
SmtpClient Class Reference
Inheritance diagram for SmtpClient:
TcpClient TcpConnection

Public Member Functions

 SmtpClient (bool autoDestroy=false)
 
bool connect (const Url &url)
 Connects to remote URL. More...
 
bool send (const String &from, const String &to, const String &subject, const String &body)
 Queues a single message before it is sent later to the SMTP server. More...
 
bool send (MailMessage *message)
 Powerful method to queues a single message before it is sent later to the SMTP server. More...
 
MailMessagegetCurrentMessage ()
 Gets the current message. More...
 
size_t countPending ()
 
void quit ()
 Sends a quit command to the server and closes the TCP conneciton. More...
 
SmtpState getState ()
 Returns the current state of the SmtpClient. More...
 
void onMessageSent (SmtpClientCallback callback)
 Callback that will be called every time a message is sent successfully. More...
 
void onServerError (SmtpClientCallback callback)
 Callback that will be called every an error occurs. More...
 

Protected Member Functions

err_t onReceive (pbuf *buf) override
 
void onReadyToSendData (TcpConnectionEvent sourceEvent) override
 
void sendMailHeaders (MailMessage *mail)
 
bool sendMailBody (MailMessage *mail)
 
bool connect (const String &server, int port, bool useSsl=false, uint32_t sslOptions=0) override
 
bool connect (IPAddress addr, uint16_t port, bool useSsl=false, uint32_t sslOptions=0) override
 
void close () override
 
void setReceiveDelegate (TcpClientDataDelegate receiveCb=nullptr)
 Set or clear the callback for received data. More...
 
void setCompleteDelegate (TcpClientCompleteDelegate completeCb=nullptr)
 Set or clear the callback for connection close. More...
 
bool send (const char *data, uint16_t len, bool forceCloseAfterSent=false)
 
bool sendString (const String &data, bool forceCloseAfterSent=false)
 
bool isProcessing ()
 
TcpClientState getConnectionState ()
 
bool addSslValidator (SslValidatorCallback callback, void *data=nullptr)
 Allows setting of multiple SSL validators after a successful handshake. More...
 
bool pinCertificate (const uint8_t *fingerprint, SslFingerprintType type)
 Requires (pins) the remote SSL certificate to match certain fingerprints. More...
 
bool pinCertificate (SslFingerprints &fingerprints)
 Requires (pins) the remote SSL certificate to match certain fingerprints. More...
 
err_t onConnected (err_t err) override
 
err_t onSent (uint16_t len) override
 
void onError (err_t err) override
 
virtual void onFinished (TcpClientState finishState)
 
err_t onSslConnected (SSL *ssl) override
 
void pushAsyncPart ()
 
void freeStreams ()
 
void setBuffer (ReadWriteStream *stream)
 
int writeString (const char *data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 
int writeString (const String &data, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 
virtual int write (const char *data, int len, uint8_t apiflags=TCP_WRITE_FLAG_COPY)
 Base write operation. More...
 
int write (IDataSourceStream *stream)
 
uint16_t getAvailableWriteSize ()
 
void flush ()
 
void setTimeOut (uint16_t waitTimeOut)
 
IPAddress getRemoteIp () const
 
uint16_t getRemotePort () const
 
void setDestroyedDelegate (TcpConnectionDestroyedDelegate destroyedDelegate)
 Sets a callback to be called when the object instance is destroyed. More...
 
void addSslOptions (uint32_t sslOptions)
 
bool setSslClientKeyCert (const uint8_t *key, int keyLength, const uint8_t *certificate, int certificateLength, const char *keyPassword=nullptr, bool freeAfterHandshake=false) SMING_DEPRECATED
 Sets client private key, certificate and password from memory. More...
 
bool setSslClientKeyCert (const SslKeyCertPair &clientKeyCert, bool freeAfterHandshake=false) SMING_DEPRECATED
 Sets client private key, certificate and password from memory. More...
 
void freeSslClientKeyCert () SMING_DEPRECATED
 Frees the memory used for the key and certificate pair. More...
 
bool setSslKeyCert (const uint8_t *key, int keyLength, const uint8_t *certificate, int certificateLength, const char *keyPassword=nullptr, bool freeAfterHandshake=false)
 Sets private key, certificate and password from memory for the SSL connection If this methods is called from a client then it sets the client key and certificate If it is called from a server then it sets the server certificate and key. Server and Client certificates differ. Client certificate is used for identification. Server certificate is used for encrypt/decrypt the data. Make sure to use the correct certificate for the desired goal. More...
 
bool setSslKeyCert (const SslKeyCertPair &keyCert, bool freeAfterHandshake=false)
 Sets private key, certificate and password from memory for the SSL connection If this methods is called from a client then it sets the client key and certificate If it is called from a server then it sets the server certificate and key. Server and Client certificates differ. Client certificate is used for identification. Server certificate is used for encrypt/decrypt the data. Make sure to use the correct certificate for the desired goal. More...
 
void freeSslKeyCert ()
 Frees the memory used for the key and certificate pair. More...
 
void setSsl (SSL *ssl)
 
SSL * getSsl ()
 
void initialize (tcp_pcb *pcb)
 
bool internalConnect (IPAddress addr, uint16_t port)
 
virtual err_t onPoll ()
 
err_t internalOnConnected (err_t err)
 
err_t internalOnReceive (pbuf *p, err_t err)
 
err_t internalOnSent (uint16_t len)
 
err_t internalOnPoll ()
 
void internalOnError (err_t err)
 
void internalOnDnsResponse (const char *name, LWIP_IP_ADDR_T *ipaddr, int port)
 

Protected Attributes

ReadWriteStreambuffer = nullptr
 Used internally to buffer arbitrary data via send() methods. More...
 
IDataSourceStreamstream = nullptr
 The currently active stream being sent. More...
 
tcp_pcb * tcp = nullptr
 
uint16_t sleep = 0
 
uint16_t timeOut = USHRT_MAX
 By default a TCP connection does not have a time out. More...
 
bool canSend = true
 
bool autoSelfDestruct = true
 
SSL * ssl = nullptr
 
SSLCTX * sslContext = nullptr
 
SSL_EXTENSIONS * sslExtension = nullptr
 
bool sslConnected = false
 
uint32_t sslOptions = 0
 
SslKeyCertPair sslKeyCert
 
bool freeKeyCertAfterHandshake = false
 
SslSessionIdsslSessionId = nullptr
 
bool useSsl = false
 

Member Function Documentation

bool TcpClient::addSslValidator ( SslValidatorCallback  callback,
void *  data = nullptr 
)
inlineinherited

Allows setting of multiple SSL validators after a successful handshake.

Parameters
callbackThe callback function to be invoked on validation
dataThe data to pass to the callback
Note
The callback is responsible for releasing the data if appropriate. See SslValidatorCallback for further details.
Return values
booltrue on success, false on failure
void TcpConnection::freeSslClientKeyCert ( )
inlineinherited

Frees the memory used for the key and certificate pair.

Deprecated:
Use freeSslKeyCert() instead
void TcpConnection::freeSslKeyCert ( )
inlineinherited

Frees the memory used for the key and certificate pair.

bool TcpClient::pinCertificate ( const uint8_t *  fingerprint,
SslFingerprintType  type 
)
inlineinherited

Requires (pins) the remote SSL certificate to match certain fingerprints.

Parameters
fingerprintThe fingerprint data against which the match should be performed. Must be allocated on the heap and will be deleted after use. Do not re-use outside of this method.
typeThe fingerprint type - see SslFingerprintType for details.
Return values
booltrue on success, false on failure
bool TcpClient::pinCertificate ( SslFingerprints fingerprints)
inlineinherited

Requires (pins) the remote SSL certificate to match certain fingerprints.

Note
The data inside the fingerprints parameter is passed by reference
Parameters
fingerprints- passes the certificate fingerprints by reference.
Return values
booltrue on success, false on failure
void TcpClient::setCompleteDelegate ( TcpClientCompleteDelegate  completeCb = nullptr)
inlineinherited

Set or clear the callback for connection close.

Parameters
completeCbcallback delegate or nullptr
void TcpConnection::setDestroyedDelegate ( TcpConnectionDestroyedDelegate  destroyedDelegate)
inlineinherited

Sets a callback to be called when the object instance is destroyed.

Parameters
TcpServerConnectionDestroyedDelegatedestroyedDelegate - callback
void TcpClient::setReceiveDelegate ( TcpClientDataDelegate  receiveCb = nullptr)
inlineinherited

Set or clear the callback for received data.

Parameters
receiveCbcallback delegate or nullptr
bool TcpConnection::setSslClientKeyCert ( const uint8_t *  key,
int  keyLength,
const uint8_t *  certificate,
int  certificateLength,
const char *  keyPassword = nullptr,
bool  freeAfterHandshake = false 
)
inlineinherited

Sets client private key, certificate and password from memory.

Deprecated:
Use setSslKeyCert(const uint8_t*, int, const uint8_t*, int, const char*, bool) instead
Note
This method makes copy of the data.
Parameters
constuint8_t *keyData
intkeyLength
constuint8_t *certificateData
intcertificateLength
constchar *keyPassword
boolfreeAfterHandshake
Returns
bool true of success, false or failure
bool TcpConnection::setSslClientKeyCert ( const SslKeyCertPair clientKeyCert,
bool  freeAfterHandshake = false 
)
inlineinherited

Sets client private key, certificate and password from memory.

Deprecated:
Use setSslKeyCert(const SslKeyCertPair&, bool) instead
Note
This method passes the certificate key chain by reference
Parameters
SSLKeyCertPair
boolfreeAfterHandshake
Returns
bool true of success, false or failure
bool TcpConnection::setSslKeyCert ( const uint8_t *  key,
int  keyLength,
const uint8_t *  certificate,
int  certificateLength,
const char *  keyPassword = nullptr,
bool  freeAfterHandshake = false 
)
inlineinherited

Sets private key, certificate and password from memory for the SSL connection If this methods is called from a client then it sets the client key and certificate If it is called from a server then it sets the server certificate and key. Server and Client certificates differ. Client certificate is used for identification. Server certificate is used for encrypt/decrypt the data. Make sure to use the correct certificate for the desired goal.

Note
This method makes copy of the data.
Parameters
constuint8_t *keyData
intkeyLength
constuint8_t *certificateData
intcertificateLength
constchar *keyPassword
boolfreeAfterHandshake
Returns
bool true of success, false or failure
bool TcpConnection::setSslKeyCert ( const SslKeyCertPair keyCert,
bool  freeAfterHandshake = false 
)
inlineinherited

Sets private key, certificate and password from memory for the SSL connection If this methods is called from a client then it sets the client key and certificate If it is called from a server then it sets the server certificate and key. Server and Client certificates differ. Client certificate is used for identification. Server certificate is used for encrypt/decrypt the data. Make sure to use the correct certificate for the desired goal.

Note
This method passes the certificate key chain by reference
Parameters
SSLKeyCertPair
boolfreeAfterHandshake
Returns
bool true of success, false or failure
virtual int TcpConnection::write ( const char *  data,
int  len,
uint8_t  apiflags = TCP_WRITE_FLAG_COPY 
)
virtualinherited

Base write operation.

Parameters
data
len
apiflagsTCP_WRITE_FLAG_COPY, TCP_WRITE_FLAG_MORE
Return values
int-1 on error

Reimplemented in FtpDataStream.

Member Data Documentation

ReadWriteStream* TcpClient::buffer = nullptr
protectedinherited

Used internally to buffer arbitrary data via send() methods.

IDataSourceStream* TcpClient::stream = nullptr
protectedinherited

The currently active stream being sent.

uint16_t TcpConnection::timeOut = USHRT_MAX
protectedinherited

By default a TCP connection does not have a time out.