TCPIP_SMTP_StringPut Function

C

uint16_t TCPIP_SMTP_StringPut(
    char* Data
);

Description

This function writes a string to the SMTP client.

Preconditions

TCPIP_SMTP_UsageBegin() returned true on a previous call.

Parameters

ParametersDescription
DataThe data to be written.

Returns

The number of bytes written. If less than the length of Data, then the TX FIFO became full before all bytes could be written.

Remarks

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