Include/TCPIP%20Stack/SMTP.h

/*********************************************************************
 *
 *                  Simple Mail Transfer Protocol (SMTP) Client
 *                                      Module for Microchip TCP/IP Stack
 *
 *********************************************************************
 * FileName:        SMTP.c
 * Dependencies:    TCP.h
 * Processor:       PIC18, PIC24F, PIC24H, dsPIC30, dsPIC33F
 * Complier:        Microchip C18 v3.02 or higher
 *                                      Microchip C30 v2.01 or higher
 * Company:         Microchip Technology, Inc.
 *
 * Software License Agreement
 *
 * Copyright © 2002-2007 Microchip Technology Inc.  All rights 
 * reserved.
 *
 * Microchip licenses to you the right to use, modify, copy, and 
 * distribute: 
 * (i)  the Software when embedded on a Microchip microcontroller or 
 *      digital signal controller product (“Device”) which is 
 *      integrated into Licensee’s product; or
 * (ii) ONLY the Software driver source files ENC28J60.c and 
 *      ENC28J60.h ported to a non-Microchip device used in 
 *      conjunction with a Microchip ethernet controller for the 
 *      sole purpose of interfacing with the ethernet controller. 
 *
 * You should refer to the license agreement accompanying this 
 * Software for additional information regarding your rights and 
 * obligations.
 *
 * THE SOFTWARE AND DOCUMENTATION ARE PROVIDED “AS IS” WITHOUT 
 * WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT 
 * LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR A 
 * PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL 
 * MICROCHIP BE LIABLE FOR ANY INCIDENTAL, SPECIAL, INDIRECT OR 
 * CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF 
 * PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR SERVICES, ANY CLAIMS 
 * BY THIRD PARTIES (INCLUDING BUT NOT LIMITED TO ANY DEFENSE 
 * THEREOF), ANY CLAIMS FOR INDEMNITY OR CONTRIBUTION, OR OTHER 
 * SIMILAR COSTS, WHETHER ASSERTED ON THE BASIS OF CONTRACT, TORT 
 * (INCLUDING NEGLIGENCE), BREACH OF WARRANTY, OR OTHERWISE.
 *
 *
 * Author               Date    Comment
 *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * Howard Schlunder     3/03/06 Original
 ********************************************************************/
#ifndef __SMTP_H
#define __SMTP_H


#define SMTP_SUCCESS            (0x0000)
#define SMTP_RESOLVE_ERROR      (0x8000)
#define SMTP_CONNECT_ERROR      (0x8001)

typedef struct _SMTP_POINTERS
{
        union
        {
                BYTE *szRAM;
                ROM BYTE *szROM;
        } Server;
        union
        {
                BYTE *szRAM;
                ROM BYTE *szROM;
        } To;
        union
        {
                BYTE *szRAM;
                ROM BYTE *szROM;
        } CC;
        union
        {
                BYTE *szRAM;
                ROM BYTE *szROM;
        } BCC;
        union
        {
                BYTE *szRAM;
                ROM BYTE *szROM;
        } From;
        union
        {
                BYTE *szRAM;
                ROM BYTE *szROM;
        } Subject;
        union
        {
                BYTE *szRAM;
                ROM BYTE *szROM;
        } OtherHeaders;
        union
        {
                BYTE *szRAM;
                ROM BYTE *szROM;
        } Body;

        struct
        {
                unsigned char Server:1;
                unsigned char To:1;
                unsigned char CC:1;
                unsigned char BCC:1;
                unsigned char From:1;
                unsigned char Subject:1;
                unsigned char OtherHeaders:1;
                unsigned char Body:1;
        } ROMPointers;
} SMTP_POINTERS;

extern SMTP_POINTERS SMTPClient;

BOOL SMTPBeginUsage(void);
WORD SMTPEndUsage(void);
void SMTPTask(void);
void SMTPSendMail(void);
BOOL SMTPIsBusy(void);
WORD SMTPIsPutReady(void);
BOOL SMTPPut(BYTE c);
WORD SMTPPutArray(BYTE* Data, WORD Len);
WORD SMTPPutROMArray(ROM BYTE* Data, WORD Len);
WORD SMTPPutString(BYTE* Data);
WORD SMTPPutROMString(ROM BYTE* Data);
void SMTPFlush(void);
void SMTPPutDone(void);


#endif
1	/*********************************************************************
2	*
3	* Simple Mail Transfer Protocol (SMTP) Client
4	* Module for Microchip TCP/IP Stack
5	*
6	*********************************************************************
7	* FileName: SMTP.c
8	* Dependencies: TCP.h
9	* Processor: PIC18, PIC24F, PIC24H, dsPIC30, dsPIC33F
10	* Complier: Microchip C18 v3.02 or higher
11	* Microchip C30 v2.01 or higher
12	* Company: Microchip Technology, Inc.
13	*
14	* Software License Agreement
15	*
16	* Copyright © 2002-2007 Microchip Technology Inc. All rights
17	* reserved.
18	*
19	* Microchip licenses to you the right to use, modify, copy, and
20	* distribute:
21	* (i) the Software when embedded on a Microchip microcontroller or
22	* digital signal controller product (“Device”) which is
23	* integrated into Licensee’s product; or
24	* (ii) ONLY the Software driver source files ENC28J60.c and
25	* ENC28J60.h ported to a non-Microchip device used in
26	* conjunction with a Microchip ethernet controller for the
27	* sole purpose of interfacing with the ethernet controller.
28	*
29	* You should refer to the license agreement accompanying this
30	* Software for additional information regarding your rights and
31	* obligations.
32	*
33	* THE SOFTWARE AND DOCUMENTATION ARE PROVIDED “AS IS” WITHOUT
34	* WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT
35	* LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR A
36	* PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL
37	* MICROCHIP BE LIABLE FOR ANY INCIDENTAL, SPECIAL, INDIRECT OR
38	* CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF
39	* PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR SERVICES, ANY CLAIMS
40	* BY THIRD PARTIES (INCLUDING BUT NOT LIMITED TO ANY DEFENSE
41	* THEREOF), ANY CLAIMS FOR INDEMNITY OR CONTRIBUTION, OR OTHER
42	* SIMILAR COSTS, WHETHER ASSERTED ON THE BASIS OF CONTRACT, TORT
43	* (INCLUDING NEGLIGENCE), BREACH OF WARRANTY, OR OTHERWISE.
44	*
45	*
46	* Author Date Comment
47	*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48	* Howard Schlunder 3/03/06 Original
49	********************************************************************/
50	#ifndef __SMTP_H
51	#define __SMTP_H
52
53
54	#define SMTP_SUCCESS (0x0000)
55	#define SMTP_RESOLVE_ERROR (0x8000)
56	#define SMTP_CONNECT_ERROR (0x8001)
57
58	typedef struct _SMTP_POINTERS
59	{
60	union
61	{
62	BYTE *szRAM;
63	ROM BYTE *szROM;
64	} Server;
65	union
66	{
67	BYTE *szRAM;
68	ROM BYTE *szROM;
69	} To;
70	union
71	{
72	BYTE *szRAM;
73	ROM BYTE *szROM;
74	} CC;
75	union
76	{
77	BYTE *szRAM;
78	ROM BYTE *szROM;
79	} BCC;
80	union
81	{
82	BYTE *szRAM;
83	ROM BYTE *szROM;
84	} From;
85	union
86	{
87	BYTE *szRAM;
88	ROM BYTE *szROM;
89	} Subject;
90	union
91	{
92	BYTE *szRAM;
93	ROM BYTE *szROM;
94	} OtherHeaders;
95	union
96	{
97	BYTE *szRAM;
98	ROM BYTE *szROM;
99	} Body;
100
101	struct
102	{
103	unsigned char Server:1;
104	unsigned char To:1;
105	unsigned char CC:1;
106	unsigned char BCC:1;
107	unsigned char From:1;
108	unsigned char Subject:1;
109	unsigned char OtherHeaders:1;
110	unsigned char Body:1;
111	} ROMPointers;
112	} SMTP_POINTERS;
113
114	extern SMTP_POINTERS SMTPClient;
115
116	BOOL SMTPBeginUsage(void);
117	WORD SMTPEndUsage(void);
118	void SMTPTask(void);
119	void SMTPSendMail(void);
120	BOOL SMTPIsBusy(void);
121	WORD SMTPIsPutReady(void);
122	BOOL SMTPPut(BYTE c);
123	WORD SMTPPutArray(BYTE* Data, WORD Len);
124	WORD SMTPPutROMArray(ROM BYTE* Data, WORD Len);
125	WORD SMTPPutString(BYTE* Data);
126	WORD SMTPPutROMString(ROM BYTE* Data);
127	void SMTPFlush(void);
128	void SMTPPutDone(void);
129
130
131	#endif