lws-smtp.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2026 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef _LWS_SMTP_H
#define _LWS_SMTP_H

 
/* the limits lws_smtp_email_check() applies */
#define LWS_SMTP_ADDR_MAX       254     /* an address, without the <> */
#define LWS_SMTP_LOCAL_MAX      64      /* the part before the @ */
#define LWS_SMTP_SUBJECT_MAX    512     /* bytes of UTF-8 */
#define LWS_SMTP_MSGID_MAX      128     /* without the <> */
#define LWS_SMTP_LINE_MAX       998     /* a body line as sent, RFC 5322 2.1.1 */
 
/* the smallest buffer lws_smtp_session_tx() can always make progress in */
#define LWS_SMTP_TX_MIN         512
 
typedef struct lws_smtp_email {
        const char      *from;
        const char      *to;
        const char      *subject;
        const char      *body;
        const char      *message_id;
        int64_t         date;
} lws_smtp_email_t;

typedef enum lws_smtp_ev {
        LWS_SMTP_EV_NONE,
        LWS_SMTP_EV_TX,
        LWS_SMTP_EV_STARTTLS,
        LWS_SMTP_EV_READY,
        LWS_SMTP_EV_MAIL_DONE,
        LWS_SMTP_EV_CLOSE,
        LWS_SMTP_EV_FAILED,
} lws_smtp_ev_t;

typedef struct lws_smtp_session {
        const lws_smtp_email_t  *mail;  /* the mail in progress, or NULL */
        const char              *helo;  /* our name for EHLO and HELO */
 
        size_t                  pos;    /* position in the tx item */
        int                     code;   /* the last complete reply's code */
        char                    text[96]; /* its last line's text */
 
        uint16_t                rx_line_len;
        uint16_t                rx_code;
        uint16_t                rx_first_code;
        uint8_t                 rx_state;
        uint8_t                 rx_text_len;
        uint8_t                 rx_kw_len;
        uint8_t                 rx_kw_end;
        char                    rx_kw[16];
 
        uint8_t                 state;
        uint8_t                 item;   /* what of the message tx is at */
        uint8_t                 flags;
} lws_smtp_session_t;

LWS_VISIBLE LWS_EXTERN int
lws_smtp_email_check(const lws_smtp_email_t *e);

LWS_VISIBLE LWS_EXTERN int
lws_smtp_addr_check(const char *addr);

LWS_VISIBLE LWS_EXTERN void
lws_smtp_session_init(lws_smtp_session_t *s, const char *helo, int starttls);

LWS_VISIBLE LWS_EXTERN lws_smtp_ev_t
lws_smtp_session_rx(lws_smtp_session_t *s, const uint8_t *buf, size_t len,
                    size_t *used);

LWS_VISIBLE LWS_EXTERN int
lws_smtp_session_tx(lws_smtp_session_t *s, uint8_t *buf, size_t max,
                    size_t *produced);

LWS_VISIBLE LWS_EXTERN void
lws_smtp_session_tls_up(lws_smtp_session_t *s);

LWS_VISIBLE LWS_EXTERN int
lws_smtp_session_mail(lws_smtp_session_t *s, const lws_smtp_email_t *mail);

 
#endif /* _LWS_SMTP_H */