lws-smtp-client.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_CLIENT_H
#define _LWS_SMTP_CLIENT_H

 
#define LWS_SMTPC_PROTOCOL_NAME         "lws-smtp-client"
 
typedef enum lws_smtpc_tls {
        LWS_SMTPC_TLS_NONE,
        LWS_SMTPC_TLS_IMPLICIT,
        LWS_SMTPC_TLS_STARTTLS,
} lws_smtpc_tls_t;
 
typedef enum lws_smtpc_outcome {
        LWS_SMTPC_DELIVERED,
        LWS_SMTPC_REFUSED,
        LWS_SMTPC_GAVE_UP,
        LWS_SMTPC_ABANDONED,
} lws_smtpc_outcome_t;
 
typedef struct lws_smtpc_result {
        lws_smtpc_outcome_t     outcome;
        int                     code;
        const char              *text;
} lws_smtpc_result_t;

typedef void (*lws_smtpc_done_cb_t)(void *opaque, const lws_smtp_email_t *email,
                                    const lws_smtpc_result_t *res);
 
typedef struct lws_smtpc_info {
        struct lws_vhost        *vhost;
        const char              *address;
        const char              *host;
        uint16_t                port;
        lws_smtpc_tls_t         tls;
        uint32_t                tls_flags;
        const char              *helo;
        const lws_retry_bo_t    *retry;
        uint16_t                max_queue;
        uint16_t                reply_timeout_secs;
        uint8_t                 max_tries;
} lws_smtpc_info_t;
 
struct lws_smtpc;
 
#if defined(LWS_WITH_EMAIL)

LWS_VISIBLE LWS_EXTERN struct lws_smtpc *
lws_smtpc_create(const lws_smtpc_info_t *info);

LWS_VISIBLE LWS_EXTERN void
lws_smtpc_destroy(struct lws_smtpc **psmtpc);

LWS_VISIBLE LWS_EXTERN struct lws_smtpc *
lws_smtpc_vhost(struct lws_vhost *vh);

LWS_VISIBLE LWS_EXTERN int
lws_smtpc_queue(struct lws_smtpc *smtpc, const lws_smtp_email_t *email,
                lws_smtpc_done_cb_t cb, void *opaque);
 
#endif

 
#endif