xref: /nrf52832-nimble/rt-thread/components/net/uip/apps/smtp/smtp.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero 
2*10465441SEvalZero /**
3*10465441SEvalZero  * \addtogroup smtp
4*10465441SEvalZero  * @{
5*10465441SEvalZero  */
6*10465441SEvalZero 
7*10465441SEvalZero 
8*10465441SEvalZero /**
9*10465441SEvalZero  * \file
10*10465441SEvalZero  * SMTP header file
11*10465441SEvalZero  * \author Adam Dunkels <[email protected]>
12*10465441SEvalZero  */
13*10465441SEvalZero 
14*10465441SEvalZero /*
15*10465441SEvalZero  * Copyright (c) 2002, Adam Dunkels.
16*10465441SEvalZero  * All rights reserved.
17*10465441SEvalZero  *
18*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without
19*10465441SEvalZero  * modification, are permitted provided that the following conditions
20*10465441SEvalZero  * are met:
21*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright
22*10465441SEvalZero  *    notice, this list of conditions and the following disclaimer.
23*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright
24*10465441SEvalZero  *    notice, this list of conditions and the following disclaimer in the
25*10465441SEvalZero  *    documentation and/or other materials provided with the distribution.
26*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote
27*10465441SEvalZero  *    products derived from this software without specific prior
28*10465441SEvalZero  *    written permission.
29*10465441SEvalZero  *
30*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
31*10465441SEvalZero  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
32*10465441SEvalZero  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33*10465441SEvalZero  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
34*10465441SEvalZero  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35*10465441SEvalZero  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
36*10465441SEvalZero  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
37*10465441SEvalZero  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
38*10465441SEvalZero  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
39*10465441SEvalZero  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
40*10465441SEvalZero  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41*10465441SEvalZero  *
42*10465441SEvalZero  * This file is part of the uIP TCP/IP stack.
43*10465441SEvalZero  *
44*10465441SEvalZero  * $Id: smtp.h,v 1.4 2006/06/11 21:46:37 adam Exp $
45*10465441SEvalZero  *
46*10465441SEvalZero  */
47*10465441SEvalZero #ifndef __SMTP_H__
48*10465441SEvalZero #define __SMTP_H__
49*10465441SEvalZero 
50*10465441SEvalZero #include "uipopt.h"
51*10465441SEvalZero 
52*10465441SEvalZero /**
53*10465441SEvalZero  * Error number that signifies a non-error condition.
54*10465441SEvalZero  */
55*10465441SEvalZero #define SMTP_ERR_OK 0
56*10465441SEvalZero 
57*10465441SEvalZero /**
58*10465441SEvalZero  * Callback function that is called when an e-mail transmission is
59*10465441SEvalZero  * done.
60*10465441SEvalZero  *
61*10465441SEvalZero  * This function must be implemented by the module that uses the SMTP
62*10465441SEvalZero  * module.
63*10465441SEvalZero  *
64*10465441SEvalZero  * \param error The number of the error if an error occured, or
65*10465441SEvalZero  * SMTP_ERR_OK.
66*10465441SEvalZero  */
67*10465441SEvalZero void smtp_done(unsigned char error);
68*10465441SEvalZero 
69*10465441SEvalZero void smtp_init(void);
70*10465441SEvalZero 
71*10465441SEvalZero /* Functions. */
72*10465441SEvalZero void smtp_configure(char *localhostname, u16_t *smtpserver);
73*10465441SEvalZero unsigned char smtp_send(char *to, char *from,
74*10465441SEvalZero 			char *subject, char *msg,
75*10465441SEvalZero 			u16_t msglen);
76*10465441SEvalZero #define SMTP_SEND(to, cc, from, subject, msg) \
77*10465441SEvalZero         smtp_send(to, cc, from, subject, msg, strlen(msg))
78*10465441SEvalZero 
79*10465441SEvalZero void smtp_appcall(void);
80*10465441SEvalZero 
81*10465441SEvalZero struct smtp_state {
82*10465441SEvalZero   u8_t state;
83*10465441SEvalZero   char *to;
84*10465441SEvalZero   char *from;
85*10465441SEvalZero   char *subject;
86*10465441SEvalZero   char *msg;
87*10465441SEvalZero   u16_t msglen;
88*10465441SEvalZero 
89*10465441SEvalZero   u16_t sentlen, textlen;
90*10465441SEvalZero   u16_t sendptr;
91*10465441SEvalZero 
92*10465441SEvalZero };
93*10465441SEvalZero 
94*10465441SEvalZero 
95*10465441SEvalZero #ifndef UIP_APPCALL
96*10465441SEvalZero #define UIP_APPCALL     smtp_appcall
97*10465441SEvalZero #endif
98*10465441SEvalZero typedef struct smtp_state uip_tcp_appstate_t;
99*10465441SEvalZero 
100*10465441SEvalZero 
101*10465441SEvalZero #endif /* __SMTP_H__ */
102*10465441SEvalZero 
103*10465441SEvalZero /** @} */
104