1.2.1.18.3 Library Interface

NameDescription
Macros
SMTPC_CONFIG_HThis is macro SMTPC_CONFIG_H.
TCPIP_SMTPC_CLIENT_ADDR_BUFFER_SIZEsize of a buffer that can hold an email address: user@domain.smth
TCPIP_SMTPC_CLIENT_AUTH_BUFFER_SIZEsize of a buffer that can hold the 2* username and password
TCPIP_SMTPC_CLIENT_MESSAGE_DATEdefault string that identifies the SMTPC client mail date Currently there is no date/time service available The mail server will update with the current date Keep the current data/time format that's accepted by the SMTP servers
TCPIP_SMTPC_INTERNAL_RETRY_TIMEOUTThe retry interval because of a SMTPC temporary error, in seconds. These include temporary errors related to: DNS, socket connection, TLS.
TCPIP_SMTPC_MAIL_CONNECTIONSnumber of mail connections (sockets) to be created each mail message requires a mail connection adjust based on the number of simultaneous mail messages in transit
TCPIP_SMTPC_MAIL_RETRIESHow many times to retry sending a mail message Retries occur only for server reported transient errors or for internal temporary errors (DNS, socket errors, etc.)
TCPIP_SMTPC_PLAIN_LINE_BUFF_SIZEsize of an email line when sending the email body as plain text SMTP lines are recommended to be 78 chars long and MUST not exceed 998 characters! This implementation limits the line size to TCPIP_SMTPC_PLAIN_LINE_BUFF_SIZE (usually 256 or 512). So any mail line longer that this size will have inserted an artificial end of line sequence (CRLF) after this many characters.
TCPIP_SMTPC_SERVER_DATA_TIMEOUTserver acknowledgment of the mail data: body, attachments et all; seconds Should be adjusted according to the server responsivity RFC specifies it as 10 min Default is 1 minute, which should normally be enough
TCPIP_SMTPC_SERVER_REPLY_BUFFER_SIZEsize of the RX buffer for processing the server replies Usually the server replies are not very long so a 512 bytes buffer will normally do
TCPIP_SMTPC_SERVER_REPLY_TIMEOUTgeneral server response timeout, seconds Should be adjusted according to the server responsivity RFC specifies it as 5 min Default is 1 minute, which should normally be enough
TCPIP_SMTPC_SERVER_TRANSIENT_RETRY_TIMEOUTThe retry interval because of a server transient error, in seconds. RFC specifies it should be at least 30 min!
TCPIP_SMTPC_SKT_RX_BUFF_SIZEDefine the size of the RX buffer for the SMTPC socket Use 0 for default TCP socket value The SMTPC RX does not need high throughput so the default value is usually fine.
TCPIP_SMTPC_SKT_TX_BUFF_SIZEDefine the size of the TX buffer for the SMTPC socket Use 0 for default TCP socket value The SMTPC TX does not need high throughput so the default value is usually fine. For transferring large files increase this value as needed.
TCPIP_SMTPC_TASK_TICK_RATESMTPC 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_SMTPC_TLS_HANDSHAKE_TIMEOUTthe timeout for the TLS handshake to complete, seconds when a secure connection is established to the mail server Adjust based on the processing speed, key size, etc.
TCPIP_SMTPC_USE_MAIL_COMMANDUse the sample tcpip console "mail" command for sending email from the console
Functions
TCPIP_SMTPC_MailMessageSMTPC mail message function.
TCPIP_SMTPC_MessageQuerySMTPC mail message query function.
TCPIP_SMTPC_TaskStandard TCP/IP stack module task function.
Data Types and Functions
TCPIP_SMTPC_ATTACH_BUFFERBuffer attachment to the mail.
TCPIP_SMTPC_ATTACH_FILEFile attachment to the mail.
TCPIP_SMTPC_ATTACH_TYPESMTPC attachment type
TCPIP_SMTPC_ENCODE_TYPESMTPC encoding type
TCPIP_SMTPC_MAIL_FLAGSMail message flags
TCPIP_SMTPC_MAIL_MESSAGEMail message descriptor.
TCPIP_SMTPC_MESSAGE_CALLBACKDefines a mail message callback
TCPIP_SMTPC_MESSAGE_HANDLEDefines a handle to a mail message
TCPIP_SMTPC_MESSAGE_QUERYStructure defining a run time query for a mail message
TCPIP_SMTPC_MESSAGE_REPORTStructure defining a mail message report
TCPIP_SMTPC_MESSAGE_RESULTSMTPC result code
TCPIP_SMTPC_MESSAGE_STATUSSMTPC message status
TCPIP_SMTPC_MESSAGE_WARNINGSMTPC warning type
TCPIP_SMTPC_MODULE_CONFIGSMTPC configuration data.
TCPIP_SMTPC_SERVER_REPLY_CALLBACKDefines a mail server reply callback
__SMTPC_HThis is macro __SMTPC_H.