Brandon Fictorie / Mbed 2 deprecated BF_Websocket

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@0:8cdad1c73e8e, 2012-03-25 (annotated)

Committer:
bfictorie
Date:
Sun Mar 25 17:26:30 2012 +0000
Revision:
0:8cdad1c73e8e

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


bfictorie

0:8cdad1c73e8e


     1







bfictorie

0:8cdad1c73e8e


     2

/*





bfictorie

0:8cdad1c73e8e


     3

Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) y Segundo Equipo





bfictorie

0:8cdad1c73e8e


     4







bfictorie

0:8cdad1c73e8e


     5

Permission is hereby granted, free of charge, to any person obtaining a copy





bfictorie

0:8cdad1c73e8e


     6

of this software and associated documentation files (the "Software"), to deal





bfictorie

0:8cdad1c73e8e


     7

in the Software without restriction, including without limitation the rights





bfictorie

0:8cdad1c73e8e


     8

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell





bfictorie

0:8cdad1c73e8e


     9

copies of the Software, and to permit persons to whom the Software is





bfictorie

0:8cdad1c73e8e


    10

furnished to do so, subject to the following conditions:





bfictorie

0:8cdad1c73e8e


    11







bfictorie

0:8cdad1c73e8e


    12

The above copyright notice and this permission notice shall be included in





bfictorie

0:8cdad1c73e8e


    13

all copies or substantial portions of the Software.





bfictorie

0:8cdad1c73e8e


    14







bfictorie

0:8cdad1c73e8e


    15

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR





bfictorie

0:8cdad1c73e8e


    16

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,





bfictorie

0:8cdad1c73e8e


    17

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE





bfictorie

0:8cdad1c73e8e


    18

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER





bfictorie

0:8cdad1c73e8e


    19

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,





bfictorie

0:8cdad1c73e8e


    20

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN





bfictorie

0:8cdad1c73e8e


    21

THE SOFTWARE.





bfictorie

0:8cdad1c73e8e


    22

*/





bfictorie

0:8cdad1c73e8e


    23







bfictorie

0:8cdad1c73e8e


    24

/** \file





bfictorie

0:8cdad1c73e8e


    25

SMTP Client header file





bfictorie

0:8cdad1c73e8e


    26

*/





bfictorie

0:8cdad1c73e8e


    27







bfictorie

0:8cdad1c73e8e


    28

#ifndef SMTP_CLIENT_H





bfictorie

0:8cdad1c73e8e


    29

#define SMTP_CLIENT_H





bfictorie

0:8cdad1c73e8e


    30







bfictorie

0:8cdad1c73e8e


    31

class EmailMessage;





bfictorie

0:8cdad1c73e8e


    32







bfictorie

0:8cdad1c73e8e


    33

#include "core/net.h"





bfictorie

0:8cdad1c73e8e


    34

#include "api/TCPSocket.h"





bfictorie

0:8cdad1c73e8e


    35

#include "api/DNSRequest.h"





bfictorie

0:8cdad1c73e8e


    36

#include "EmailMessage.h"





bfictorie

0:8cdad1c73e8e


    37

#include "mbed.h"





bfictorie

0:8cdad1c73e8e


    38







bfictorie

0:8cdad1c73e8e


    39

///SMTP client results





bfictorie

0:8cdad1c73e8e


    40

enum SMTPResult {





bfictorie

0:8cdad1c73e8e


    41

    SMTP_OK, ///<Success





bfictorie

0:8cdad1c73e8e


    42

    SMTP_PROCESSING, ///<Processing





bfictorie

0:8cdad1c73e8e


    43

    SMTP_DNS, ///<Could not resolve name





bfictorie

0:8cdad1c73e8e


    44

    SMTP_PRTCL, ///<Protocol error





bfictorie

0:8cdad1c73e8e


    45

    SMTP_TIMEOUT, ///<Connection timeout





bfictorie

0:8cdad1c73e8e


    46

    SMTP_DISC ///<Disconnected





bfictorie

0:8cdad1c73e8e


    47

};





bfictorie

0:8cdad1c73e8e


    48







bfictorie

0:8cdad1c73e8e


    49

///SMTP authentication





bfictorie

0:8cdad1c73e8e


    50

enum SMTPAuth {





bfictorie

0:8cdad1c73e8e


    51

    SMTP_AUTH_NONE, ///<No authentication





bfictorie

0:8cdad1c73e8e


    52

    SMTP_AUTH_PLAIN ///<AUTH PLAIN authentication





bfictorie

0:8cdad1c73e8e


    53

};





bfictorie

0:8cdad1c73e8e


    54

#include "core/netservice.h"





bfictorie

0:8cdad1c73e8e


    55







bfictorie

0:8cdad1c73e8e


    56

///A simple SMTP Client





bfictorie

0:8cdad1c73e8e


    57

/**





bfictorie

0:8cdad1c73e8e


    58

The SMTPClient is composed of:





bfictorie

0:8cdad1c73e8e


    59

- The actual client (SMTPClient)





bfictorie

0:8cdad1c73e8e


    60

- A class (EmailMessage) to hold the message addresses and content for sending





bfictorie

0:8cdad1c73e8e


    61

*/





bfictorie

0:8cdad1c73e8e


    62

class SMTPClient : protected NetService {





bfictorie

0:8cdad1c73e8e


    63

public:





bfictorie

0:8cdad1c73e8e


    64

    ///Instantiates the SMTP client





bfictorie

0:8cdad1c73e8e


    65

    SMTPClient();





bfictorie

0:8cdad1c73e8e


    66







bfictorie

0:8cdad1c73e8e


    67

    ///Destructor for the SMTP client





bfictorie

0:8cdad1c73e8e


    68

    virtual ~SMTPClient();





bfictorie

0:8cdad1c73e8e


    69







bfictorie

0:8cdad1c73e8e


    70

    ///Full constructor for the SMTP client





bfictorie

0:8cdad1c73e8e


    71

    /**





bfictorie

0:8cdad1c73e8e


    72

    @param host : SMTP server host





bfictorie

0:8cdad1c73e8e


    73

    @param heloDomain : domain name of client





bfictorie

0:8cdad1c73e8e


    74

    @param user : username





bfictorie

0:8cdad1c73e8e


    75

    @param password : password





bfictorie

0:8cdad1c73e8e


    76

    @param auth : authentication type





bfictorie

0:8cdad1c73e8e


    77

    */





bfictorie

0:8cdad1c73e8e


    78

    SMTPClient(const Host& host, const char* heloDomain, const char* user, const char* password, SMTPAuth auth);





bfictorie

0:8cdad1c73e8e


    79







bfictorie

0:8cdad1c73e8e


    80

    ///Set server host





bfictorie

0:8cdad1c73e8e


    81

    /**





bfictorie

0:8cdad1c73e8e


    82

    @param host : SMTP server host





bfictorie

0:8cdad1c73e8e


    83

    */





bfictorie

0:8cdad1c73e8e


    84

    void setServer(const Host& host);





bfictorie

0:8cdad1c73e8e


    85







bfictorie

0:8cdad1c73e8e


    86

    ///Provides a plain authentication feature (Base64 encoded username and password)





bfictorie

0:8cdad1c73e8e


    87

    /**





bfictorie

0:8cdad1c73e8e


    88

    @param user : username





bfictorie

0:8cdad1c73e8e


    89

    @param password : password





bfictorie

0:8cdad1c73e8e


    90

    */





bfictorie

0:8cdad1c73e8e


    91

    void setAuth(const char* user, const char* password); // Plain authentication





bfictorie

0:8cdad1c73e8e


    92







bfictorie

0:8cdad1c73e8e


    93

    ///Turns off authentication





bfictorie

0:8cdad1c73e8e


    94

    void clearAuth(); // Clear authentication





bfictorie

0:8cdad1c73e8e


    95







bfictorie

0:8cdad1c73e8e


    96

    ///Set HELO domain (defaults to localhost if not set)





bfictorie

0:8cdad1c73e8e


    97

    /**





bfictorie

0:8cdad1c73e8e


    98

    @param heloDomain : domain name of client (strictly should be fully qualified domain name)





bfictorie

0:8cdad1c73e8e


    99

    */





bfictorie

0:8cdad1c73e8e


   100

    void setHeloDomain(const char* heloDomain);





bfictorie

0:8cdad1c73e8e


   101







bfictorie

0:8cdad1c73e8e


   102

    //High Level setup functions





bfictorie

0:8cdad1c73e8e


   103

    ///Sends the message (blocking)





bfictorie

0:8cdad1c73e8e


   104

    /**





bfictorie

0:8cdad1c73e8e


   105

    @param pMessage : pointer to a message





bfictorie

0:8cdad1c73e8e


   106







bfictorie

0:8cdad1c73e8e


   107

    Blocks until completion





bfictorie

0:8cdad1c73e8e


   108

    */





bfictorie

0:8cdad1c73e8e


   109

    SMTPResult send(EmailMessage* pMessage); //Blocking





bfictorie

0:8cdad1c73e8e


   110







bfictorie

0:8cdad1c73e8e


   111

    ///Sends the message (non blocking)





bfictorie

0:8cdad1c73e8e


   112

    /**





bfictorie

0:8cdad1c73e8e


   113

    @param pMessage : pointer to a message





bfictorie

0:8cdad1c73e8e


   114

    @param pMethod : callback function





bfictorie

0:8cdad1c73e8e


   115







bfictorie

0:8cdad1c73e8e


   116

    The function returns immediately and calls the callback on completion or error





bfictorie

0:8cdad1c73e8e


   117

    */





bfictorie

0:8cdad1c73e8e


   118

    SMTPResult send(EmailMessage* pMessage, void (*pMethod)(SMTPResult)); //Non blocking





bfictorie

0:8cdad1c73e8e


   119







bfictorie

0:8cdad1c73e8e


   120

    ///Sends the message (non blocking)





bfictorie

0:8cdad1c73e8e


   121

    /**





bfictorie

0:8cdad1c73e8e


   122

    @param pMessage : pointer to a message





bfictorie

0:8cdad1c73e8e


   123

    @param pItem : instance of class on which to execute the callback method





bfictorie

0:8cdad1c73e8e


   124

    @param pMethod : callback method





bfictorie

0:8cdad1c73e8e


   125







bfictorie

0:8cdad1c73e8e


   126

    The function returns immediately and calls the callback on completion or error





bfictorie

0:8cdad1c73e8e


   127

    */





bfictorie

0:8cdad1c73e8e


   128

    template<class T>





bfictorie

0:8cdad1c73e8e


   129

    SMTPResult send(EmailMessage* pMessage, T* pItem, void (T::*pMethod)(SMTPResult)) { //Non blocking





bfictorie

0:8cdad1c73e8e


   130

        setOnResult(pItem, pMethod);





bfictorie

0:8cdad1c73e8e


   131

        doSend(pMessage);





bfictorie

0:8cdad1c73e8e


   132

        return SMTP_PROCESSING;





bfictorie

0:8cdad1c73e8e


   133

    }





bfictorie

0:8cdad1c73e8e


   134







bfictorie

0:8cdad1c73e8e


   135

    ///Sends the message (non blocking)





bfictorie

0:8cdad1c73e8e


   136

    /**





bfictorie

0:8cdad1c73e8e


   137

    @param pMessage : pointer to a message





bfictorie

0:8cdad1c73e8e


   138







bfictorie

0:8cdad1c73e8e


   139

    The function returns immediately and calls the previously set callback on completion or error





bfictorie

0:8cdad1c73e8e


   140

    */





bfictorie

0:8cdad1c73e8e


   141

    void doSend(EmailMessage* pMessage);





bfictorie

0:8cdad1c73e8e


   142







bfictorie

0:8cdad1c73e8e


   143

    ///Setup the result callback





bfictorie

0:8cdad1c73e8e


   144

    /**





bfictorie

0:8cdad1c73e8e


   145

    @param pMethod : callback function





bfictorie

0:8cdad1c73e8e


   146

    */





bfictorie

0:8cdad1c73e8e


   147

    void setOnResult( void (*pMethod)(SMTPResult) );





bfictorie

0:8cdad1c73e8e


   148







bfictorie

0:8cdad1c73e8e


   149

    ///Setup the result callback





bfictorie

0:8cdad1c73e8e


   150

    /**





bfictorie

0:8cdad1c73e8e


   151

    @param pItem : instance of class on which to execute the callback method





bfictorie

0:8cdad1c73e8e


   152

    @param pMethod : callback method





bfictorie

0:8cdad1c73e8e


   153

    */





bfictorie

0:8cdad1c73e8e


   154

    class CDummy;





bfictorie

0:8cdad1c73e8e


   155

    template<class T>





bfictorie

0:8cdad1c73e8e


   156

    void setOnResult( T* pItem, void (T::*pMethod)(SMTPResult) ) {





bfictorie

0:8cdad1c73e8e


   157

        m_pCb = NULL;





bfictorie

0:8cdad1c73e8e


   158

        m_pCbItem = (CDummy*) pItem;





bfictorie

0:8cdad1c73e8e


   159

        m_pCbMeth = (void (CDummy::*)(SMTPResult)) pMethod;





bfictorie

0:8cdad1c73e8e


   160

    }





bfictorie

0:8cdad1c73e8e


   161







bfictorie

0:8cdad1c73e8e


   162

    ///Setup timeout





bfictorie

0:8cdad1c73e8e


   163

    /**





bfictorie

0:8cdad1c73e8e


   164

    @param ms : time of connection inactivity in ms after which the request should timeout





bfictorie

0:8cdad1c73e8e


   165

    */





bfictorie

0:8cdad1c73e8e


   166

    void setTimeout(int ms);





bfictorie

0:8cdad1c73e8e


   167







bfictorie

0:8cdad1c73e8e


   168

    ///Gets the last response from the server





bfictorie

0:8cdad1c73e8e


   169

    string& getLastResponse();





bfictorie

0:8cdad1c73e8e


   170







bfictorie

0:8cdad1c73e8e


   171

    virtual void poll(); //Called by NetServices





bfictorie

0:8cdad1c73e8e


   172







bfictorie

0:8cdad1c73e8e


   173

protected:





bfictorie

0:8cdad1c73e8e


   174

    int rc(char* buf); //Return code





bfictorie

0:8cdad1c73e8e


   175

    void process(bool writeable); //Main state-machine





bfictorie

0:8cdad1c73e8e


   176







bfictorie

0:8cdad1c73e8e


   177

    void resetTimeout();





bfictorie

0:8cdad1c73e8e


   178







bfictorie

0:8cdad1c73e8e


   179

    void init();





bfictorie

0:8cdad1c73e8e


   180

    void close();





bfictorie

0:8cdad1c73e8e


   181







bfictorie

0:8cdad1c73e8e


   182

    void setup(EmailMessage* pMessage); //Setup request, make DNS Req if necessary





bfictorie

0:8cdad1c73e8e


   183

    void connect(); //Start Connection





bfictorie

0:8cdad1c73e8e


   184







bfictorie

0:8cdad1c73e8e


   185

    int  tryRead(); //Read data and try to feed output





bfictorie

0:8cdad1c73e8e


   186

    void readData(); //Data has been read





bfictorie

0:8cdad1c73e8e


   187

    void writeData(); //Data has been written & buf is free





bfictorie

0:8cdad1c73e8e


   188







bfictorie

0:8cdad1c73e8e


   189

    void onTCPSocketEvent(TCPSocketEvent e);





bfictorie

0:8cdad1c73e8e


   190

    void onDNSReply(DNSReply r);





bfictorie

0:8cdad1c73e8e


   191

    void onResult(SMTPResult r); //Called when exchange completed or on failure





bfictorie

0:8cdad1c73e8e


   192

    void onTimeout(); //Connection has timed out





bfictorie

0:8cdad1c73e8e


   193







bfictorie

0:8cdad1c73e8e


   194

    string encodePlainAuth(); // Encode plain authentication (username and password in based 64)





bfictorie

0:8cdad1c73e8e


   195

    bool okPostAuthentication(int code); // True if server response is ok following authentication





bfictorie

0:8cdad1c73e8e


   196







bfictorie

0:8cdad1c73e8e


   197

private:





bfictorie

0:8cdad1c73e8e


   198

    SMTPResult blockingProcess(); //Called in blocking mode, calls Net::poll() until return code is available





bfictorie

0:8cdad1c73e8e


   199







bfictorie

0:8cdad1c73e8e


   200

    CDummy* m_pCbItem;





bfictorie

0:8cdad1c73e8e


   201

    void (CDummy::*m_pCbMeth)(SMTPResult);





bfictorie

0:8cdad1c73e8e


   202

    void (*m_pCb)(SMTPResult);





bfictorie

0:8cdad1c73e8e


   203







bfictorie

0:8cdad1c73e8e


   204

    TCPSocket* m_pTCPSocket;





bfictorie

0:8cdad1c73e8e


   205







bfictorie

0:8cdad1c73e8e


   206

    Timer m_watchdog;





bfictorie

0:8cdad1c73e8e


   207

    int m_timeout;





bfictorie

0:8cdad1c73e8e


   208







bfictorie

0:8cdad1c73e8e


   209

    DNSRequest* m_pDnsReq;





bfictorie

0:8cdad1c73e8e


   210

    Host m_server;





bfictorie

0:8cdad1c73e8e


   211







bfictorie

0:8cdad1c73e8e


   212

    bool m_closed;





bfictorie

0:8cdad1c73e8e


   213







bfictorie

0:8cdad1c73e8e


   214

    enum SMTPStep {





bfictorie

0:8cdad1c73e8e


   215

        SMTP_HELLO,





bfictorie

0:8cdad1c73e8e


   216

        SMTP_AUTH,





bfictorie

0:8cdad1c73e8e


   217

        SMTP_FROM,





bfictorie

0:8cdad1c73e8e


   218

        SMTP_TO,





bfictorie

0:8cdad1c73e8e


   219

        SMTP_DATA,





bfictorie

0:8cdad1c73e8e


   220

        SMTP_BODY,





bfictorie

0:8cdad1c73e8e


   221

        SMTP_BODYMORE,





bfictorie

0:8cdad1c73e8e


   222

        SMTP_EOF,





bfictorie

0:8cdad1c73e8e


   223

        SMTP_BYE,





bfictorie

0:8cdad1c73e8e


   224

        SMTP_CLOSED





bfictorie

0:8cdad1c73e8e


   225

    };





bfictorie

0:8cdad1c73e8e


   226







bfictorie

0:8cdad1c73e8e


   227

    SMTPStep m_state;





bfictorie

0:8cdad1c73e8e


   228







bfictorie

0:8cdad1c73e8e


   229

    EmailMessage* m_pMessage;





bfictorie

0:8cdad1c73e8e


   230







bfictorie

0:8cdad1c73e8e


   231

    int m_posInMsg;





bfictorie

0:8cdad1c73e8e


   232

    int m_posInCRLF;





bfictorie

0:8cdad1c73e8e


   233







bfictorie

0:8cdad1c73e8e


   234

    SMTPResult m_blockingResult; //Result if blocking mode





bfictorie

0:8cdad1c73e8e


   235

    string m_response;





bfictorie

0:8cdad1c73e8e


   236

    int m_responseCode;





bfictorie

0:8cdad1c73e8e


   237

    string m_username;





bfictorie

0:8cdad1c73e8e


   238

    string m_password;





bfictorie

0:8cdad1c73e8e


   239

    SMTPAuth m_auth;





bfictorie

0:8cdad1c73e8e


   240

    string m_heloDomain;





bfictorie

0:8cdad1c73e8e


   241







bfictorie

0:8cdad1c73e8e


   242

    vector<string>::iterator m_To;





bfictorie

0:8cdad1c73e8e


   243

};





bfictorie

0:8cdad1c73e8e


   244







bfictorie

0:8cdad1c73e8e


   245

#endif // SMTP_CLIENT_H