TCPIP_SMTP_Put Function

C

bool TCPIP_SMTP_Put(
    char c
);

Description

This function writes a single byte to the SMTP client.

Preconditions

TCPIP_SMTP_UsageBegin() returned true on a previous call.

Parameters

ParametersDescription
cThe byte to be written.

Returns

None.

Remarks

This function is obsolete and will be eventually removed. TCPIP_SMTP_ArrayPut() and TCPIP_SMTP_StringPut() should be used.

This function cannot be used on an encrypted connection. It is difficult to estimate the amount of TX buffer space needed when transmitting byte by byte, which could cause intermediary write operations to the underlying TCP socket.

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).