Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/services/email/smtp/SMTPClient.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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