CWE-ou-minkata/Sources/Plasma/NucleusLib/pnMail/pnMail.h

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
/*****************************************************************************
*
*   $/Plasma20/Sources/Plasma/NucleusLib/pnMail/pnMail.h
*   
***/

#ifndef PLASMA20_SOURCES_PLASMA_NUCLEUSLIB_PNMAIL_PNMAIL_H
#define PLASMA20_SOURCES_PLASMA_NUCLEUSLIB_PNMAIL_PNMAIL_H


/*****************************************************************************
*
*   Mail API
*
***/

enum EMailEncoding {
    kMailEncodeNone,
    kMailEncodeAscii,
    kMailEncodeUtf8,
};

enum EMailError {
    kMailSuccess,
    kMailErrDnsFailed,
    kMailErrConnectFailed,
    kMailErrDisconnected,
    kMailErrClientCanceled,
    kMailErrServerError,
};


typedef void (* FMailResult)(void * param, EMailError result);


void MailStop ();
bool MailQueued ();

const wchar * MailErrorToString (EMailError error);


//============================================================================
// AUTHENTICATION NOTES
//  username, password
//  NULL        NULL    --> no authentication
//  NULL        string  --> username/password assumed to be pre-encoded with MailEncodePassword
//  string      string  --> username/password contain appropriate values for snmp server
//============================================================================

void Mail (
    const char      smtp[],
    const char      sender[],
    const char      recipients[],   // separate multiple recipients with semicolons
    const char      subject[],
    const char      body[],
    const char      username[],     // optional (see auth notes above)
    const char      password[],     // optional (see auth notes above)
    const char      replyTo[],      // optional
    EMailEncoding   encoding,
    FMailResult     callback,       // optional
    void *          param           // optional
);

void MailEncodePassword (
    const char      username[],
    const char      password[],
    ARRAY(char) *   emailAuth
);


#endif // PLASMA20_SOURCES_PLASMA_NUCLEUSLIB_PNMAIL_PNMAIL_H