1.2.1.17.2 Library Interface

NameDescription
Macros
TCPIP_SMTP_MAX_WRITE_SIZEthe max size of data to be written in a discrete string/array email operation: TCPIP_SMTP_StringPut/TCPIP_SMTP_ArrayPut. Excess characters will be discarded. Note that the higher this value, the greater the size of the underlying TCP socket TX buffer Adjust as needed. Normally should not exceed 512 characters.
TCPIP_SMTP_SERVER_REPLY_TIMEOUTHow long to wait before assuming the connection has been dropped (default 8 seconds)
TCPIP_SMTP_TASK_TICK_RATESMTP task rate, milliseconds The default value is 55 milliseconds. The lower the rate (higher the frequency) the higher the module priority and higher module performance can be obtained The value cannot be lower than the TCPIP_STACK_TICK_RATE.
TCPIP_SMTP_WRITE_READY_SPACEthe minimum amount of data to ask from the transport/encryption layer when querying the write space
SMTP_CONNECT_ERRORConnection to SMTP server failed
SMTP_RESOLVE_ERRORDNS lookup for SMTP server failed
SMTP_SUCCESSMessage was successfully sent
Functions
TCPIP_SMTP_ArrayPutWrites a series of bytes to the SMTP client.
TCPIP_SMTP_FlushFlushes the SMTP socket and forces all data to be sent.
TCPIP_SMTP_IsBusyDetermines if the SMTP client is busy.
TCPIP_SMTP_IsPutReadyDetermines how much data can be written to the SMTP client.
TCPIP_SMTP_PutWrites a single byte to the SMTP client.
TCPIP_SMTP_PutIsDoneIndicates that the on-the-fly message is complete.
TCPIP_SMTP_StringPutWrites a string to the SMTP client.
TCPIP_SMTP_UsageBeginRequests control of the SMTP client module.
TCPIP_SMTP_UsageEndReleases control of the SMTP client module.
TCPIP_SMTP_ClientTaskStandard TCP/IP stack module task function.
TCPIP_SMTP_MailSendInitializes the message sending process.
Structures
TCPIP_SMTP_CLIENT_MESSAGEConfigures the SMTP client to send a message.
TCPIP_SMTP_CLIENT_MODULE_CONFIGThis is type TCPIP_SMTP_CLIENT_MODULE_CONFIG.