Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/services/email/smtp/SMTPClient.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ninoderkinderen 0:8d87bc453349 1
ninoderkinderen 0:8d87bc453349 2 /*
ninoderkinderen 0:8d87bc453349 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) y Segundo Equipo
ninoderkinderen 0:8d87bc453349 4
ninoderkinderen 0:8d87bc453349 5 Permission is hereby granted, free of charge, to any person obtaining a copy
ninoderkinderen 0:8d87bc453349 6 of this software and associated documentation files (the "Software"), to deal
ninoderkinderen 0:8d87bc453349 7 in the Software without restriction, including without limitation the rights
ninoderkinderen 0:8d87bc453349 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
ninoderkinderen 0:8d87bc453349 9 copies of the Software, and to permit persons to whom the Software is
ninoderkinderen 0:8d87bc453349 10 furnished to do so, subject to the following conditions:
ninoderkinderen 0:8d87bc453349 11
ninoderkinderen 0:8d87bc453349 12 The above copyright notice and this permission notice shall be included in
ninoderkinderen 0:8d87bc453349 13 all copies or substantial portions of the Software.
ninoderkinderen 0:8d87bc453349 14
ninoderkinderen 0:8d87bc453349 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
ninoderkinderen 0:8d87bc453349 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ninoderkinderen 0:8d87bc453349 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ninoderkinderen 0:8d87bc453349 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ninoderkinderen 0:8d87bc453349 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ninoderkinderen 0:8d87bc453349 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
ninoderkinderen 0:8d87bc453349 21 THE SOFTWARE.
ninoderkinderen 0:8d87bc453349 22 */
ninoderkinderen 0:8d87bc453349 23
ninoderkinderen 0:8d87bc453349 24 /** \file
ninoderkinderen 0:8d87bc453349 25 SMTP Client header file
ninoderkinderen 0:8d87bc453349 26 */
ninoderkinderen 0:8d87bc453349 27
ninoderkinderen 0:8d87bc453349 28 #ifndef SMTP_CLIENT_H
ninoderkinderen 0:8d87bc453349 29 #define SMTP_CLIENT_H
ninoderkinderen 0:8d87bc453349 30
ninoderkinderen 0:8d87bc453349 31 class EmailMessage;
ninoderkinderen 0:8d87bc453349 32
ninoderkinderen 0:8d87bc453349 33 #include "core/net.h"
ninoderkinderen 0:8d87bc453349 34 #include "api/TCPSocket.h"
ninoderkinderen 0:8d87bc453349 35 #include "api/DNSRequest.h"
ninoderkinderen 0:8d87bc453349 36 #include "EmailMessage.h"
ninoderkinderen 0:8d87bc453349 37 #include "mbed.h"
ninoderkinderen 0:8d87bc453349 38
ninoderkinderen 0:8d87bc453349 39 ///SMTP client results
ninoderkinderen 0:8d87bc453349 40 enum SMTPResult {
ninoderkinderen 0:8d87bc453349 41 SMTP_OK, ///<Success
ninoderkinderen 0:8d87bc453349 42 SMTP_PROCESSING, ///<Processing
ninoderkinderen 0:8d87bc453349 43 SMTP_DNS, ///<Could not resolve name
ninoderkinderen 0:8d87bc453349 44 SMTP_PRTCL, ///<Protocol error
ninoderkinderen 0:8d87bc453349 45 SMTP_TIMEOUT, ///<Connection timeout
ninoderkinderen 0:8d87bc453349 46 SMTP_DISC ///<Disconnected
ninoderkinderen 0:8d87bc453349 47 };
ninoderkinderen 0:8d87bc453349 48
ninoderkinderen 0:8d87bc453349 49 ///SMTP authentication
ninoderkinderen 0:8d87bc453349 50 enum SMTPAuth {
ninoderkinderen 0:8d87bc453349 51 SMTP_AUTH_NONE, ///<No authentication
ninoderkinderen 0:8d87bc453349 52 SMTP_AUTH_PLAIN ///<AUTH PLAIN authentication
ninoderkinderen 0:8d87bc453349 53 };
ninoderkinderen 0:8d87bc453349 54 #include "core/netservice.h"
ninoderkinderen 0:8d87bc453349 55
ninoderkinderen 0:8d87bc453349 56 ///A simple SMTP Client
ninoderkinderen 0:8d87bc453349 57 /**
ninoderkinderen 0:8d87bc453349 58 The SMTPClient is composed of:
ninoderkinderen 0:8d87bc453349 59 - The actual client (SMTPClient)
ninoderkinderen 0:8d87bc453349 60 - A class (EmailMessage) to hold the message addresses and content for sending
ninoderkinderen 0:8d87bc453349 61 */
ninoderkinderen 0:8d87bc453349 62 class SMTPClient : protected NetService {
ninoderkinderen 0:8d87bc453349 63 public:
ninoderkinderen 0:8d87bc453349 64 ///Instantiates the SMTP client
ninoderkinderen 0:8d87bc453349 65 SMTPClient();
ninoderkinderen 0:8d87bc453349 66
ninoderkinderen 0:8d87bc453349 67 ///Destructor for the SMTP client
ninoderkinderen 0:8d87bc453349 68 virtual ~SMTPClient();
ninoderkinderen 0:8d87bc453349 69
ninoderkinderen 0:8d87bc453349 70 ///Full constructor for the SMTP client
ninoderkinderen 0:8d87bc453349 71 /**
ninoderkinderen 0:8d87bc453349 72 @param host : SMTP server host
ninoderkinderen 0:8d87bc453349 73 @param heloDomain : domain name of client
ninoderkinderen 0:8d87bc453349 74 @param user : username
ninoderkinderen 0:8d87bc453349 75 @param password : password
ninoderkinderen 0:8d87bc453349 76 @param auth : authentication type
ninoderkinderen 0:8d87bc453349 77 */
ninoderkinderen 0:8d87bc453349 78 SMTPClient(const Host& host, const char* heloDomain, const char* user, const char* password, SMTPAuth auth);
ninoderkinderen 0:8d87bc453349 79
ninoderkinderen 0:8d87bc453349 80 ///Set server host
ninoderkinderen 0:8d87bc453349 81 /**
ninoderkinderen 0:8d87bc453349 82 @param host : SMTP server host
ninoderkinderen 0:8d87bc453349 83 */
ninoderkinderen 0:8d87bc453349 84 void setServer(const Host& host);
ninoderkinderen 0:8d87bc453349 85
ninoderkinderen 0:8d87bc453349 86 ///Provides a plain authentication feature (Base64 encoded username and password)
ninoderkinderen 0:8d87bc453349 87 /**
ninoderkinderen 0:8d87bc453349 88 @param user : username
ninoderkinderen 0:8d87bc453349 89 @param password : password
ninoderkinderen 0:8d87bc453349 90 */
ninoderkinderen 0:8d87bc453349 91 void setAuth(const char* user, const char* password); // Plain authentication
ninoderkinderen 0:8d87bc453349 92
ninoderkinderen 0:8d87bc453349 93 ///Turns off authentication
ninoderkinderen 0:8d87bc453349 94 void clearAuth(); // Clear authentication
ninoderkinderen 0:8d87bc453349 95
ninoderkinderen 0:8d87bc453349 96 ///Set HELO domain (defaults to localhost if not set)
ninoderkinderen 0:8d87bc453349 97 /**
ninoderkinderen 0:8d87bc453349 98 @param heloDomain : domain name of client (strictly should be fully qualified domain name)
ninoderkinderen 0:8d87bc453349 99 */
ninoderkinderen 0:8d87bc453349 100 void setHeloDomain(const char* heloDomain);
ninoderkinderen 0:8d87bc453349 101
ninoderkinderen 0:8d87bc453349 102 //High Level setup functions
ninoderkinderen 0:8d87bc453349 103 ///Sends the message (blocking)
ninoderkinderen 0:8d87bc453349 104 /**
ninoderkinderen 0:8d87bc453349 105 @param pMessage : pointer to a message
ninoderkinderen 0:8d87bc453349 106
ninoderkinderen 0:8d87bc453349 107 Blocks until completion
ninoderkinderen 0:8d87bc453349 108 */
ninoderkinderen 0:8d87bc453349 109 SMTPResult send(EmailMessage* pMessage); //Blocking
ninoderkinderen 0:8d87bc453349 110
ninoderkinderen 0:8d87bc453349 111 ///Sends the message (non blocking)
ninoderkinderen 0:8d87bc453349 112 /**
ninoderkinderen 0:8d87bc453349 113 @param pMessage : pointer to a message
ninoderkinderen 0:8d87bc453349 114 @param pMethod : callback function
ninoderkinderen 0:8d87bc453349 115
ninoderkinderen 0:8d87bc453349 116 The function returns immediately and calls the callback on completion or error
ninoderkinderen 0:8d87bc453349 117 */
ninoderkinderen 0:8d87bc453349 118 SMTPResult send(EmailMessage* pMessage, void (*pMethod)(SMTPResult)); //Non blocking
ninoderkinderen 0:8d87bc453349 119
ninoderkinderen 0:8d87bc453349 120 ///Sends the message (non blocking)
ninoderkinderen 0:8d87bc453349 121 /**
ninoderkinderen 0:8d87bc453349 122 @param pMessage : pointer to a message
ninoderkinderen 0:8d87bc453349 123 @param pItem : instance of class on which to execute the callback method
ninoderkinderen 0:8d87bc453349 124 @param pMethod : callback method
ninoderkinderen 0:8d87bc453349 125
ninoderkinderen 0:8d87bc453349 126 The function returns immediately and calls the callback on completion or error
ninoderkinderen 0:8d87bc453349 127 */
ninoderkinderen 0:8d87bc453349 128 template<class T>
ninoderkinderen 0:8d87bc453349 129 SMTPResult send(EmailMessage* pMessage, T* pItem, void (T::*pMethod)(SMTPResult)) { //Non blocking
ninoderkinderen 0:8d87bc453349 130 setOnResult(pItem, pMethod);
ninoderkinderen 0:8d87bc453349 131 doSend(pMessage);
ninoderkinderen 0:8d87bc453349 132 return SMTP_PROCESSING;
ninoderkinderen 0:8d87bc453349 133 }
ninoderkinderen 0:8d87bc453349 134
ninoderkinderen 0:8d87bc453349 135 ///Sends the message (non blocking)
ninoderkinderen 0:8d87bc453349 136 /**
ninoderkinderen 0:8d87bc453349 137 @param pMessage : pointer to a message
ninoderkinderen 0:8d87bc453349 138
ninoderkinderen 0:8d87bc453349 139 The function returns immediately and calls the previously set callback on completion or error
ninoderkinderen 0:8d87bc453349 140 */
ninoderkinderen 0:8d87bc453349 141 void doSend(EmailMessage* pMessage);
ninoderkinderen 0:8d87bc453349 142
ninoderkinderen 0:8d87bc453349 143 ///Setup the result callback
ninoderkinderen 0:8d87bc453349 144 /**
ninoderkinderen 0:8d87bc453349 145 @param pMethod : callback function
ninoderkinderen 0:8d87bc453349 146 */
ninoderkinderen 0:8d87bc453349 147 void setOnResult( void (*pMethod)(SMTPResult) );
ninoderkinderen 0:8d87bc453349 148
ninoderkinderen 0:8d87bc453349 149 ///Setup the result callback
ninoderkinderen 0:8d87bc453349 150 /**
ninoderkinderen 0:8d87bc453349 151 @param pItem : instance of class on which to execute the callback method
ninoderkinderen 0:8d87bc453349 152 @param pMethod : callback method
ninoderkinderen 0:8d87bc453349 153 */
ninoderkinderen 0:8d87bc453349 154 class CDummy;
ninoderkinderen 0:8d87bc453349 155 template<class T>
ninoderkinderen 0:8d87bc453349 156 void setOnResult( T* pItem, void (T::*pMethod)(SMTPResult) ) {
ninoderkinderen 0:8d87bc453349 157 m_pCb = NULL;
ninoderkinderen 0:8d87bc453349 158 m_pCbItem = (CDummy*) pItem;
ninoderkinderen 0:8d87bc453349 159 m_pCbMeth = (void (CDummy::*)(SMTPResult)) pMethod;
ninoderkinderen 0:8d87bc453349 160 }
ninoderkinderen 0:8d87bc453349 161
ninoderkinderen 0:8d87bc453349 162 ///Setup timeout
ninoderkinderen 0:8d87bc453349 163 /**
ninoderkinderen 0:8d87bc453349 164 @param ms : time of connection inactivity in ms after which the request should timeout
ninoderkinderen 0:8d87bc453349 165 */
ninoderkinderen 0:8d87bc453349 166 void setTimeout(int ms);
ninoderkinderen 0:8d87bc453349 167
ninoderkinderen 0:8d87bc453349 168 ///Gets the last response from the server
ninoderkinderen 0:8d87bc453349 169 string& getLastResponse();
ninoderkinderen 0:8d87bc453349 170
ninoderkinderen 0:8d87bc453349 171 virtual void poll(); //Called by NetServices
ninoderkinderen 0:8d87bc453349 172
ninoderkinderen 0:8d87bc453349 173 protected:
ninoderkinderen 0:8d87bc453349 174 int rc(char* buf); //Return code
ninoderkinderen 0:8d87bc453349 175 void process(bool writeable); //Main state-machine
ninoderkinderen 0:8d87bc453349 176
ninoderkinderen 0:8d87bc453349 177 void resetTimeout();
ninoderkinderen 0:8d87bc453349 178
ninoderkinderen 0:8d87bc453349 179 void init();
ninoderkinderen 0:8d87bc453349 180 void close();
ninoderkinderen 0:8d87bc453349 181
ninoderkinderen 0:8d87bc453349 182 void setup(EmailMessage* pMessage); //Setup request, make DNS Req if necessary
ninoderkinderen 0:8d87bc453349 183 void connect(); //Start Connection
ninoderkinderen 0:8d87bc453349 184
ninoderkinderen 0:8d87bc453349 185 int tryRead(); //Read data and try to feed output
ninoderkinderen 0:8d87bc453349 186 void readData(); //Data has been read
ninoderkinderen 0:8d87bc453349 187 void writeData(); //Data has been written & buf is free
ninoderkinderen 0:8d87bc453349 188
ninoderkinderen 0:8d87bc453349 189 void onTCPSocketEvent(TCPSocketEvent e);
ninoderkinderen 0:8d87bc453349 190 void onDNSReply(DNSReply r);
ninoderkinderen 0:8d87bc453349 191 void onResult(SMTPResult r); //Called when exchange completed or on failure
ninoderkinderen 0:8d87bc453349 192 void onTimeout(); //Connection has timed out
ninoderkinderen 0:8d87bc453349 193
ninoderkinderen 0:8d87bc453349 194 string encodePlainAuth(); // Encode plain authentication (username and password in based 64)
ninoderkinderen 0:8d87bc453349 195 bool okPostAuthentication(int code); // True if server response is ok following authentication
ninoderkinderen 0:8d87bc453349 196
ninoderkinderen 0:8d87bc453349 197 private:
ninoderkinderen 0:8d87bc453349 198 SMTPResult blockingProcess(); //Called in blocking mode, calls Net::poll() until return code is available
ninoderkinderen 0:8d87bc453349 199
ninoderkinderen 0:8d87bc453349 200 CDummy* m_pCbItem;
ninoderkinderen 0:8d87bc453349 201 void (CDummy::*m_pCbMeth)(SMTPResult);
ninoderkinderen 0:8d87bc453349 202 void (*m_pCb)(SMTPResult);
ninoderkinderen 0:8d87bc453349 203
ninoderkinderen 0:8d87bc453349 204 TCPSocket* m_pTCPSocket;
ninoderkinderen 0:8d87bc453349 205
ninoderkinderen 0:8d87bc453349 206 Timer m_watchdog;
ninoderkinderen 0:8d87bc453349 207 int m_timeout;
ninoderkinderen 0:8d87bc453349 208
ninoderkinderen 0:8d87bc453349 209 DNSRequest* m_pDnsReq;
ninoderkinderen 0:8d87bc453349 210 Host m_server;
ninoderkinderen 0:8d87bc453349 211
ninoderkinderen 0:8d87bc453349 212 bool m_closed;
ninoderkinderen 0:8d87bc453349 213
ninoderkinderen 0:8d87bc453349 214 enum SMTPStep {
ninoderkinderen 0:8d87bc453349 215 SMTP_HELLO,
ninoderkinderen 0:8d87bc453349 216 SMTP_AUTH,
ninoderkinderen 0:8d87bc453349 217 SMTP_FROM,
ninoderkinderen 0:8d87bc453349 218 SMTP_TO,
ninoderkinderen 0:8d87bc453349 219 SMTP_DATA,
ninoderkinderen 0:8d87bc453349 220 SMTP_BODY,
ninoderkinderen 0:8d87bc453349 221 SMTP_BODYMORE,
ninoderkinderen 0:8d87bc453349 222 SMTP_EOF,
ninoderkinderen 0:8d87bc453349 223 SMTP_BYE,
ninoderkinderen 0:8d87bc453349 224 SMTP_CLOSED
ninoderkinderen 0:8d87bc453349 225 };
ninoderkinderen 0:8d87bc453349 226
ninoderkinderen 0:8d87bc453349 227 SMTPStep m_state;
ninoderkinderen 0:8d87bc453349 228
ninoderkinderen 0:8d87bc453349 229 EmailMessage* m_pMessage;
ninoderkinderen 0:8d87bc453349 230
ninoderkinderen 0:8d87bc453349 231 int m_posInMsg;
ninoderkinderen 0:8d87bc453349 232 int m_posInCRLF;
ninoderkinderen 0:8d87bc453349 233
ninoderkinderen 0:8d87bc453349 234 SMTPResult m_blockingResult; //Result if blocking mode
ninoderkinderen 0:8d87bc453349 235 string m_response;
ninoderkinderen 0:8d87bc453349 236 int m_responseCode;
ninoderkinderen 0:8d87bc453349 237 string m_username;
ninoderkinderen 0:8d87bc453349 238 string m_password;
ninoderkinderen 0:8d87bc453349 239 SMTPAuth m_auth;
ninoderkinderen 0:8d87bc453349 240 string m_heloDomain;
ninoderkinderen 0:8d87bc453349 241
ninoderkinderen 0:8d87bc453349 242 vector<string>::iterator m_To;
ninoderkinderen 0:8d87bc453349 243 };
ninoderkinderen 0:8d87bc453349 244
ninoderkinderen 0:8d87bc453349 245 #endif // SMTP_CLIENT_H