SMTP client context. More...
#include <smtp_client.h>
Data Fields | |
| SmtpClientState | state |
| SMTP client state. More... | |
| NetInterface * | interface |
| Underlying network interface. More... | |
| systime_t | timeout |
| Timeout value. More... | |
| systime_t | timestamp |
| Timestamp to manage timeout. More... | |
| Socket * | socket |
| Underlying socket. More... | |
| TlsContext * | tlsContext |
| TLS context. More... | |
| TlsSessionState | tlsSession |
| TLS session state. More... | |
| SmtpClientTlsInitCallback | tlsInitCallback |
| TLS initialization callback function. More... | |
| char_t | contentType [SMTP_CLIENT_CONTENT_TYPE_MAX_LEN+1] |
| Content type. More... | |
| char_t | boundary [SMTP_CLIENT_BOUNDARY_MAX_LEN+1] |
| Boundary string. More... | |
| bool_t | base64Encoding |
| Base64 encoding. More... | |
| bool_t | startTlsSupported |
| STARTTLS command supported. More... | |
| bool_t | authLoginSupported |
| LOGIN authentication mechanism supported. More... | |
| bool_t | authPlainSupported |
| PLAIN authentication mechanism supported. More... | |
| bool_t | authCramMd5Supported |
| CRAM-MD5 authentication mechanism supported. More... | |
| char_t | buffer [SMTP_CLIENT_BUFFER_SIZE+1] |
| Memory buffer for input/output operations. More... | |
| size_t | bufferLen |
| Length of the buffer, in bytes. More... | |
| size_t | bufferPos |
| Current position in the buffer. More... | |
| size_t | commandLen |
| Length of the SMTP command, in bytes. More... | |
| size_t | replyLen |
| Length of the SMTP reply, in bytes. More... | |
| uint_t | replyCode |
| SMTP reply code. More... | |
| uint_t | recipientIndex |
| Index of the current recipient. More... | |
Detailed Description
SMTP client context.
Definition at line 252 of file smtp_client.h.
Field Documentation
◆ authCramMd5Supported
| bool_t authCramMd5Supported |
CRAM-MD5 authentication mechanism supported.
Definition at line 272 of file smtp_client.h.
◆ authLoginSupported
| bool_t authLoginSupported |
LOGIN authentication mechanism supported.
Definition at line 270 of file smtp_client.h.
◆ authPlainSupported
| bool_t authPlainSupported |
PLAIN authentication mechanism supported.
Definition at line 271 of file smtp_client.h.
◆ base64Encoding
| bool_t base64Encoding |
Base64 encoding.
Definition at line 267 of file smtp_client.h.
◆ boundary
| char_t boundary[SMTP_CLIENT_BOUNDARY_MAX_LEN+1] |
Boundary string.
Definition at line 266 of file smtp_client.h.
◆ buffer
| char_t buffer[SMTP_CLIENT_BUFFER_SIZE+1] |
Memory buffer for input/output operations.
Definition at line 273 of file smtp_client.h.
◆ bufferLen
| size_t bufferLen |
Length of the buffer, in bytes.
Definition at line 274 of file smtp_client.h.
◆ bufferPos
| size_t bufferPos |
Current position in the buffer.
Definition at line 275 of file smtp_client.h.
◆ commandLen
| size_t commandLen |
Length of the SMTP command, in bytes.
Definition at line 276 of file smtp_client.h.
◆ contentType
| char_t contentType[SMTP_CLIENT_CONTENT_TYPE_MAX_LEN+1] |
Content type.
Definition at line 265 of file smtp_client.h.
◆ interface
| NetInterface* interface |
Underlying network interface.
Definition at line 255 of file smtp_client.h.
◆ recipientIndex
| uint_t recipientIndex |
Index of the current recipient.
Definition at line 279 of file smtp_client.h.
◆ replyCode
| uint_t replyCode |
SMTP reply code.
Definition at line 278 of file smtp_client.h.
◆ replyLen
| size_t replyLen |
Length of the SMTP reply, in bytes.
Definition at line 277 of file smtp_client.h.
◆ socket
| Socket* socket |
Underlying socket.
Definition at line 258 of file smtp_client.h.
◆ startTlsSupported
| bool_t startTlsSupported |
STARTTLS command supported.
Definition at line 269 of file smtp_client.h.
◆ state
| SmtpClientState state |
SMTP client state.
Definition at line 254 of file smtp_client.h.
◆ timeout
| systime_t timeout |
Timeout value.
Definition at line 256 of file smtp_client.h.
◆ timestamp
| systime_t timestamp |
Timestamp to manage timeout.
Definition at line 257 of file smtp_client.h.
◆ tlsContext
| TlsContext* tlsContext |
TLS context.
Definition at line 260 of file smtp_client.h.
◆ tlsInitCallback
| SmtpClientTlsInitCallback tlsInitCallback |
TLS initialization callback function.
Definition at line 262 of file smtp_client.h.
◆ tlsSession
| TlsSessionState tlsSession |
TLS session state.
Definition at line 261 of file smtp_client.h.
The documentation for this struct was generated from the following file:
- cyclone_tcp/smtp/smtp_client.h