1.2.1.17.5 TCPIP_SMTP_IsPutReady Function

C

uint16_t TCPIP_SMTP_IsPutReady();

Description

Use this function to determine how much data can be written to the SMTP client when generating an on-the-fly message.

Preconditions

TCPIP_SMTP_UsageBegin() returned true on a previous call, and an on-the-fly message is being generated. This requires that TCPIP_SMTP_MailSend() was called with SMTPClient.Body set to NULL.

Returns

  • The number of free bytes the SMTP TX FIFO.

Remarks

This function should only be called externally when the SMTP client is generating an on-the-fly message (i.e., TCPIP_SMTP_MailSend was called with SMTPClient.Body set to NULL).