src/libfast/smtp.h

   1 /*
   2  * Copyright (C) 2010 Martin Willi
   3  * Copyright (C) 2010 revosec AG
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; either version 2 of the License, or (at your
   8  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  */
  15
  16 /**
  17  * @defgroup smtp smtp
  18  * @{ @ingroup libfast
  19  */
  20
  21 #ifndef SMTP_H_
  22 #define SMTP_H_
  23
  24 typedef struct smtp_t smtp_t;
  25
  26 #include <library.h>
  27
  28 /**
  29  * Ultra-minimalistic SMTP client. Works at most with Exim on localhost.
  30  */
  31 struct smtp_t {
  32
  33         /**
  34          * Send an e-mail message.
  35          *
  36          * @param from          sender address
  37          * @param to            receipient address
  38          * @param subject       mail subject
  39          * @param fmt           mail body format string
  40          * @param ...           arguments for body format string
  41          */
  42         bool (*send_mail)(smtp_t *this, char *from, char *to,
  43                                           char *subject, char *fmt, ...);
  44
  45         /**
  46          * Destroy a smtp_t.
  47          */
  48         void (*destroy)(smtp_t *this);
  49 };
  50
  51 /**
  52  * Create a smtp instance.
  53  */
  54 smtp_t *smtp_create();
  55
  56 #endif /** SMTP_H_ @}*/