diff options
Diffstat (limited to '3rdParty/libquickmail/quickmail.h')
| -rw-r--r-- | 3rdParty/libquickmail/quickmail.h | 34 |
1 files changed, 26 insertions, 8 deletions
diff --git a/3rdParty/libquickmail/quickmail.h b/3rdParty/libquickmail/quickmail.h index a61a913..d241a23 100644 --- a/3rdParty/libquickmail/quickmail.h +++ b/3rdParty/libquickmail/quickmail.h @@ -1,9 +1,3 @@ -/*! \file quickmail.h - * \brief header file for libquickmail - * \author Brecht Sanders - * \date 2012-2013 - * \copyright GPL - */ /* This file is part of libquickmail. @@ -21,12 +15,19 @@ along with libquickmail. If not, see <http://www.gnu.org/licenses/>. */ +/*! \file quickmail.h + * \brief header file for libquickmail + * \author Brecht Sanders + * \date 2012-2016 + * \copyright GPL + */ + #ifndef __INCLUDED_QUICKMAIL_H #define __INCLUDED_QUICKMAIL_H #include <stdio.h> -/*! \brief define for exporting/importing functions in/from shared library */ +/*! \cond PRIVATE */ #ifdef _WIN32 #if defined(BUILD_QUICKMAIL_DLL) #define DLL_EXPORT_LIBQUICKMAIL __declspec(dllexport) @@ -38,6 +39,7 @@ #else #define DLL_EXPORT_LIBQUICKMAIL #endif +/*! \endcond */ #ifdef __cplusplus extern "C" { @@ -100,11 +102,16 @@ typedef void (*quickmail_list_attachment_callback_fn)(quickmail mailobj, const c */ DLL_EXPORT_LIBQUICKMAIL const char* quickmail_get_version (); -/*! \brief initialize quickmail library +/*! \brief initialize quickmail library, call once at the beginning of the main thread of the application * \return zero on success */ DLL_EXPORT_LIBQUICKMAIL int quickmail_initialize (); +/*! \brief clean up quickmail library, call once at the end of the main thread of the application + * \return zero on success + */ +DLL_EXPORT_LIBQUICKMAIL int quickmail_cleanup (); + /*! \brief create a new quickmail object * \param from sender e-mail address * \param subject e-mail subject @@ -295,6 +302,17 @@ DLL_EXPORT_LIBQUICKMAIL size_t quickmail_get_data (void* buffer, size_t size, si */ DLL_EXPORT_LIBQUICKMAIL const char* quickmail_send (quickmail mailobj, const char* smtpserver, unsigned int smtpport, const char* username, const char* password); +/*! \brief send the e-mail via SMTPS + * \param mailobj quickmail object + * \param smtpserver IP address or hostname of SMTPS server + * \param smtpport SMTPS port number (normally this is 465) + * \param username username to use for authentication (or NULL if not needed) + * \param password password to use for authentication (or NULL if not needed) + * \return NULL on success or error message on error + */ +DLL_EXPORT_LIBQUICKMAIL const char* quickmail_send_secure (quickmail mailobj, const char* smtpserver, unsigned int smtpport, const char* username, const char* password); + + #ifdef __cplusplus } #endif |