Network Component  Version 7.11.0
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetSMTP: SMTP Client

Events generated by the Network - SMTP Client functions. More...

Functions

__STATIC_INLINE void EvrNetSMTP_InitClient (void)
 Event on SMTP client initialize (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_GetSocketFailed (void)
 Event on SMTP client failed to allocate TCP socket (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_ConnectIp4 (const void *net_addr)
 Event on SMTP client netSMTPc_Connect to IPv4 server (API) More...
 
__STATIC_INLINE void EvrNetSMTP_ConnectIp6 (const void *net_addr)
 Event on SMTP client netSMTPc_Connect to IPv6 server (API) More...
 
__STATIC_INLINE void EvrNetSMTP_ConnectInvalidParameter (void)
 Event on netSMTPc_Connect invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_ConnectClientBusy (void)
 Event on netSMTPc_Connect failed, client busy (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMail (uint8_t num_rcpt)
 Event on SMTP client netSMTPc_SendMail to mail server (API) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMailInvalidParameter (void)
 Event on netSMTPc_SendMail invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMailTlsNotEnabled (void)
 Event on netSMTPc_SendMail secure TLS not enabled (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMailClientBusy (void)
 Event on netSMTPc_SendMail failed, client busy (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMailNoRecipients (void)
 Event on netSMTPc_SendMail failed, mail recipient not specified (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMailServerNotValid (void)
 Event on netSMTPc_SendMail failed, mail server not valid (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMailDnsError (void)
 Event on netSMTPc_SendMail failed, DNS host resolver error (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMailAttachNotEnabled (void)
 Event on netSMTPc_SendMail failed, support for attachments not enabled (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMailAttachFailed (const char *fname, uint32_t length)
 Event on netSMTPc_SendMail attach file failed, fopen failed (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMailMultipart (uint8_t num_files)
 Event on SMTP client netSMTPc_SendMail multipart with attachments (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMailAttachment (const char *fname, uint32_t length)
 Event on netSMTPc_SendMail attach file (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_InboundConnRejected (int32_t socket)
 Event on SMTP client inbound connection rejected (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SocketAborted (int32_t socket)
 Event on SMTP client socket aborted (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SocketConnected (int32_t socket)
 Event on SMTP client socket connected (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_SocketClosed (int32_t socket)
 Event on SMTP client socket closed (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_ReceiveFrame (int32_t socket, uint32_t length)
 Event on SMTP client received frame (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_UnackedDataError (int32_t socket)
 Event on SMTP client unacked data error (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on SMTP receive frame is too short (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_ServerReady (void)
 Event on SMTP client server ready response (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_EsmtpModeNotSupported (void)
 Event on SMTP client Extended SMTP mode (ESMTP) not supported (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_EhloResponseFragmented (void)
 Event on SMTP client EHLO response divided into multiple frames (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_EsmtpModeActive (void)
 Event on SMTP client Extended SMTP mode (ESMTP) active (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_StartAuthentication (uint8_t auth_mode)
 Event on SMTP client start authentication (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_AuthenticationDenied (void)
 Event on SMTP client authentication denied by the user (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_AuthMethodNotSupported (uint8_t auth_mode)
 Event on SMTP client authentication method not supported (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SmtpModeActive (void)
 Event on SMTP client basic SMTP mode active (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_AuthenticationSuccessful (void)
 Event on SMTP client authentication completed successfully (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_AuthenticationFailed (void)
 Event on SMTP client authentication failed (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_ServerAcknowledge (void)
 Event on SMTP client received server acknowledgment (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_WrongResponse (const uint8_t *response, uint32_t length)
 Event on SMTP client received wrong response from server (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_ClientStopTimeoutExpired (void)
 Event on SMTP client stop operation, timeout expired (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMessageBody (void)
 Event on SMTP client send message body start (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_SendMessageEnd (void)
 Event on SMTP client send end of message sequence (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_SendCommand (const uint8_t *command, uint32_t length)
 Event on SMTP client send command to server (Detail) More...
 
__STATIC_INLINE void EvrNetSMTP_ClientCloseSocket (int32_t socket)
 Event on SMTP client close socket (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_ClientDone (uint8_t cb_event)
 Event on SMTP client completed operation (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_TlsSupportIndicated (void)
 Event on SMTP client TLS support indicated by the server (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_StartTlsAccepted (void)
 Event on SMTP client STARTTLS command accepted by the server (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_TlsGetContextFailed (void)
 Event on SMTP client failed to allocate secure TLS context (Error) More...
 
__STATIC_INLINE void EvrNetSMTP_TlsModeStarted (void)
 Event on SMTP client started secure TLS mode (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_TlsModeEstablished (uint8_t tls_id)
 Event on SMTP client established secure TLS session (Op) More...
 
__STATIC_INLINE void EvrNetSMTP_UninitClient (void)
 Event on SMTP client de-initialize (Op) More...
 

Description

Events generated by the Network - SMTP Client functions.

Function Documentation

__STATIC_INLINE void EvrNetSMTP_AuthenticationDenied ( void  )

Event on SMTP client authentication denied by the user (Op)

__STATIC_INLINE void EvrNetSMTP_AuthenticationFailed ( void  )

Event on SMTP client authentication failed (Error)

__STATIC_INLINE void EvrNetSMTP_AuthenticationSuccessful ( void  )

Event on SMTP client authentication completed successfully (Op)

__STATIC_INLINE void EvrNetSMTP_AuthMethodNotSupported ( uint8_t  auth_mode)

Event on SMTP client authentication method not supported (Error)

Parameters
auth_modeSMTP authentication mode
  • 0: not required
  • 1: PLAIN
  • 2: LOGIN
  • 3: DIGEST-MD5
  • 4: CRAM-MD5
  • 5: NTLM
  • 6: unknown
__STATIC_INLINE void EvrNetSMTP_ClientCloseSocket ( int32_t  socket)

Event on SMTP client close socket (Op)

Parameters
socketassigned TCP socket
__STATIC_INLINE void EvrNetSMTP_ClientDone ( uint8_t  cb_event)

Event on SMTP client completed operation (Op)

Parameters
cb_eventuser callback nofication event
  • 0: Email successfully sent
  • 1: Timeout on sending email
  • 2: Login failed, username/password invalid
  • 3: Generoc SMTP client error
__STATIC_INLINE void EvrNetSMTP_ClientStopTimeoutExpired ( void  )

Event on SMTP client stop operation, timeout expired (Error)

__STATIC_INLINE void EvrNetSMTP_ConnectClientBusy ( void  )

Event on netSMTPc_Connect failed, client busy (Error)

__STATIC_INLINE void EvrNetSMTP_ConnectInvalidParameter ( void  )

Event on netSMTPc_Connect invalid parameter (Error)

__STATIC_INLINE void EvrNetSMTP_ConnectIp4 ( const void *  net_addr)

Event on SMTP client netSMTPc_Connect to IPv4 server (API)

Parameters
net_addrpointer to NET_ADDR4 server address structure (8 bytes)
Remarks
Sends reduced size of net address structure with IPv4 address only.
__STATIC_INLINE void EvrNetSMTP_ConnectIp6 ( const void *  net_addr)

Event on SMTP client netSMTPc_Connect to IPv6 server (API)

Parameters
net_addrpointer to NET_ADDR server address structure (20 bytes)
Remarks
Sends full size of net address structure with IPv6 address only.
__STATIC_INLINE void EvrNetSMTP_EhloResponseFragmented ( void  )

Event on SMTP client EHLO response divided into multiple frames (Op)

__STATIC_INLINE void EvrNetSMTP_EsmtpModeActive ( void  )

Event on SMTP client Extended SMTP mode (ESMTP) active (Op)

__STATIC_INLINE void EvrNetSMTP_EsmtpModeNotSupported ( void  )

Event on SMTP client Extended SMTP mode (ESMTP) not supported (Op)

__STATIC_INLINE void EvrNetSMTP_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on SMTP receive frame is too short (Error)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame
__STATIC_INLINE void EvrNetSMTP_GetSocketFailed ( void  )

Event on SMTP client failed to allocate TCP socket (Error)

__STATIC_INLINE void EvrNetSMTP_InboundConnRejected ( int32_t  socket)

Event on SMTP client inbound connection rejected (Error)

Parameters
socketassigned TCP socket
__STATIC_INLINE void EvrNetSMTP_InitClient ( void  )

Event on SMTP client initialize (Op)

__STATIC_INLINE void EvrNetSMTP_ReceiveFrame ( int32_t  socket,
uint32_t  length 
)

Event on SMTP client received frame (Op)

Parameters
socketassigned TCP socket
lengthframe length in bytes
__STATIC_INLINE void EvrNetSMTP_SendCommand ( const uint8_t *  command,
uint32_t  length 
)

Event on SMTP client send command to server (Detail)

Parameters
commandserver command in text form
lengthlength of the command string
__STATIC_INLINE void EvrNetSMTP_SendMail ( uint8_t  num_rcpt)

Event on SMTP client netSMTPc_SendMail to mail server (API)

Parameters
num_rcptnumber of mail recipients (To, CC, BCC)
__STATIC_INLINE void EvrNetSMTP_SendMailAttachFailed ( const char *  fname,
uint32_t  length 
)

Event on netSMTPc_SendMail attach file failed, fopen failed (Error)

Parameters
fnamename of the requested file
lengthlength of the fname string
__STATIC_INLINE void EvrNetSMTP_SendMailAttachment ( const char *  fname,
uint32_t  length 
)

Event on netSMTPc_SendMail attach file (Op)

Parameters
fnamename of the requested file
lengthlength of the fname string
__STATIC_INLINE void EvrNetSMTP_SendMailAttachNotEnabled ( void  )

Event on netSMTPc_SendMail failed, support for attachments not enabled (Error)

__STATIC_INLINE void EvrNetSMTP_SendMailClientBusy ( void  )

Event on netSMTPc_SendMail failed, client busy (Error)

__STATIC_INLINE void EvrNetSMTP_SendMailDnsError ( void  )

Event on netSMTPc_SendMail failed, DNS host resolver error (Error)

__STATIC_INLINE void EvrNetSMTP_SendMailInvalidParameter ( void  )

Event on netSMTPc_SendMail invalid parameter (Error)

__STATIC_INLINE void EvrNetSMTP_SendMailMultipart ( uint8_t  num_files)

Event on SMTP client netSMTPc_SendMail multipart with attachments (Op)

Parameters
num_filesnumber of files to attach
__STATIC_INLINE void EvrNetSMTP_SendMailNoRecipients ( void  )

Event on netSMTPc_SendMail failed, mail recipient not specified (Error)

__STATIC_INLINE void EvrNetSMTP_SendMailServerNotValid ( void  )

Event on netSMTPc_SendMail failed, mail server not valid (Error)

__STATIC_INLINE void EvrNetSMTP_SendMailTlsNotEnabled ( void  )

Event on netSMTPc_SendMail secure TLS not enabled (Error)

__STATIC_INLINE void EvrNetSMTP_SendMessageBody ( void  )

Event on SMTP client send message body start (Op)

__STATIC_INLINE void EvrNetSMTP_SendMessageEnd ( void  )

Event on SMTP client send end of message sequence (Op)

__STATIC_INLINE void EvrNetSMTP_ServerAcknowledge ( void  )

Event on SMTP client received server acknowledgment (Op)

__STATIC_INLINE void EvrNetSMTP_ServerReady ( void  )

Event on SMTP client server ready response (Op)

__STATIC_INLINE void EvrNetSMTP_SmtpModeActive ( void  )

Event on SMTP client basic SMTP mode active (Op)

__STATIC_INLINE void EvrNetSMTP_SocketAborted ( int32_t  socket)

Event on SMTP client socket aborted (Error)

Parameters
socketassigned TCP socket
__STATIC_INLINE void EvrNetSMTP_SocketClosed ( int32_t  socket)

Event on SMTP client socket closed (Op)

Parameters
socketassigned TCP socket
__STATIC_INLINE void EvrNetSMTP_SocketConnected ( int32_t  socket)

Event on SMTP client socket connected (Op)

Parameters
socketassigned TCP socket
__STATIC_INLINE void EvrNetSMTP_StartAuthentication ( uint8_t  auth_mode)

Event on SMTP client start authentication (Op)

Parameters
auth_modeSMTP authentication mode
  • 0: not required
  • 1: PLAIN
  • 2: LOGIN
  • 3: DIGEST-MD5
  • 4: CRAM-MD5
  • 5: NTLM
  • 6: unknown
__STATIC_INLINE void EvrNetSMTP_StartTlsAccepted ( void  )

Event on SMTP client STARTTLS command accepted by the server (Op)

__STATIC_INLINE void EvrNetSMTP_TlsGetContextFailed ( void  )

Event on SMTP client failed to allocate secure TLS context (Error)

__STATIC_INLINE void EvrNetSMTP_TlsModeEstablished ( uint8_t  tls_id)

Event on SMTP client established secure TLS session (Op)

Parameters
tls_idTLS session identifier
__STATIC_INLINE void EvrNetSMTP_TlsModeStarted ( void  )

Event on SMTP client started secure TLS mode (Op)

__STATIC_INLINE void EvrNetSMTP_TlsSupportIndicated ( void  )

Event on SMTP client TLS support indicated by the server (Op)

__STATIC_INLINE void EvrNetSMTP_UnackedDataError ( int32_t  socket)

Event on SMTP client unacked data error (Error)

Parameters
socketassigned TCP socket
__STATIC_INLINE void EvrNetSMTP_UninitClient ( void  )

Event on SMTP client de-initialize (Op)

__STATIC_INLINE void EvrNetSMTP_WrongResponse ( const uint8_t *  response,
uint32_t  length 
)

Event on SMTP client received wrong response from server (Error)

Parameters
responseserver response in text form
lengthlength of the response string