mirror of https://github.com/djcb/mu.git
133 lines
4.4 KiB
C++
133 lines
4.4 KiB
C++
/*
|
|
** Copyright (C) 2008-2020 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
|
|
**
|
|
** 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, write to the Free Software Foundation,
|
|
** Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
**
|
|
*/
|
|
|
|
#ifndef MU_MSG_PRIV_HH__
|
|
#define MU_MSG_PRIV_HH__
|
|
|
|
#include <gmime/gmime.h>
|
|
#include <stdlib.h>
|
|
|
|
#include <mu-msg.hh>
|
|
#include <mu-msg-file.hh>
|
|
#include <mu-msg-doc.hh>
|
|
#include "mu-msg-part.hh"
|
|
|
|
namespace Mu {
|
|
|
|
struct MuMsgFile {
|
|
GMimeMessage* _mime_msg;
|
|
time_t _timestamp;
|
|
size_t _size;
|
|
char* _path;
|
|
char* _maildir;
|
|
char* _sha1;
|
|
};
|
|
|
|
/* we put the the MuMsg definition in this separate -priv file, so we
|
|
* can split the mu_msg implementations over separate files */
|
|
struct MuMsg {
|
|
guint _refcount;
|
|
|
|
/* our two backend */
|
|
MuMsgFile* _file; /* based on GMime, ie. a file on disc */
|
|
MuMsgDoc* _doc; /* based on Xapian::Document */
|
|
|
|
/* lists where we push allocated strings / GSLists of string
|
|
* so we can free them when the struct gets destroyed (and we
|
|
* can return them as 'const to callers)
|
|
*/
|
|
GSList* _free_later_str;
|
|
GSList* _free_later_lst;
|
|
};
|
|
|
|
/**
|
|
* convert a GMimePart to a string
|
|
*
|
|
* @param part a GMimePart
|
|
* @param err will receive TRUE if there was an error, FALSE
|
|
* otherwise. Must NOT be NULL.
|
|
*
|
|
* @return utf8 string for this MIME part, to be freed by caller
|
|
*/
|
|
gchar* mu_msg_mime_part_to_string(GMimePart* part,
|
|
gboolean* err) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* Like g_mime_message_foreach, but will recurse into encrypted parts
|
|
* if @param decrypt is TRUE and mu was built with crypto support
|
|
*
|
|
* @param msg a GMimeMessage
|
|
* @param decrypt whether to try to automatically decrypt
|
|
* @param func user callback function for each part
|
|
* @param user_data user point passed to callback function
|
|
* @param err receives error information
|
|
*
|
|
*/
|
|
void mu_mime_message_foreach(GMimeMessage* msg,
|
|
gboolean decrypt,
|
|
GMimeObjectForeachFunc func,
|
|
gpointer user_data);
|
|
|
|
/**
|
|
* callback function to retrieve a password from the user
|
|
*
|
|
* @param user_id the user name / id to get the password for
|
|
* @param prompt_ctx a string containing some helpful context for the prompt
|
|
* @param reprompt whether this is a reprompt after an earlier, incorrect password
|
|
* @param user_data the user_data pointer passed to mu_msg_part_decrypt_foreach
|
|
*
|
|
* @return a newly allocated (g_free'able) string
|
|
*/
|
|
typedef char* (*MuMsgPartPasswordFunc)(const char* user_id,
|
|
const char* prompt_ctx,
|
|
gboolean reprompt,
|
|
gpointer user_data);
|
|
|
|
/**
|
|
* verify the signature of a signed message part
|
|
*
|
|
* @param sig a signed message part
|
|
* @param opts message options
|
|
* @param err receive error information
|
|
*
|
|
* @return a status report object, free with mu_msg_part_sig_status_report_destroy
|
|
*/
|
|
void mu_msg_crypto_verify_part(GMimeMultipartSigned* sig, MuMsgOptions opts, GError** err);
|
|
|
|
/**
|
|
* decrypt the given encrypted mime multipart
|
|
*
|
|
* @param enc encrypted part
|
|
* @param opts options
|
|
* @param password_func callback function to retrieve as password (or NULL)
|
|
* @param user_data pointer passed to the password func
|
|
* @param err receives error data
|
|
*
|
|
* @return the decrypted part, or NULL in case of error
|
|
*/
|
|
GMimeObject* mu_msg_crypto_decrypt_part(GMimeMultipartEncrypted* enc,
|
|
MuMsgOptions opts,
|
|
MuMsgPartPasswordFunc func,
|
|
gpointer user_data,
|
|
GError** err) G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
|
|
|
|
} // namespace Mu
|
|
|
|
#endif /*MU_MSG_PRIV_HH__*/
|