1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*
* qtmaildir - a Qt6 mail client for notmuch-indexed Maildirs
* Copyright (C) 2026 Danilo M. <danix@danix.xyz>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* 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.
*/
#pragma once
#include <QDir>
#include <QFile>
#include <QProcess>
#include <QString>
#include <QTemporaryDir>
#include <QTextStream>
/// A throwaway notmuch database in a temporary directory.
///
/// Builds a Maildir tree, writes a notmuch config pointing at it, and runs
/// `notmuch new`. Nothing touches the developer's own ~/Mail or
/// ~/.notmuch-config: the config path is handed to the worker explicitly.
///
/// Maildir flags are not decoration. notmuch synchronizes them with tags at
/// index time, so a file named `...:2,S` ("seen") comes out WITHOUT the unread
/// tag no matter what [new] tags says. addMessage() takes the unread state and
/// picks the filename accordingly.
class NotmuchFixture
{
public:
/// True when the temporary tree was created. Check before use.
bool isValid() const { return m_dir.isValid(); }
QString configPath() const { return m_dir.filePath(QStringLiteral("config")); }
QString maildirPath() const { return m_dir.filePath(QStringLiteral("mail")); }
/// Where the Xapian index lives. Equal to maildirPath()/.notmuch in the
/// ordinary layout; a directory of its own once splitIndex() is called.
QString indexPath() const
{
return m_splitIndex ? m_dir.filePath(QStringLiteral("index"))
: maildirPath() + QStringLiteral("/.notmuch");
}
/// Puts the index OUTSIDE the mail root, as notmuch's `mail_root`/`path`
/// split does (item 124).
///
/// This is opt-in because it is the only layout that can tell
/// `notmuch_database_get_path()` apart from the mail root: in the ordinary
/// layout the two return the same string, so a test written against it
/// passes whichever accessor the code uses. Call before index().
void splitIndex() { m_splitIndex = true; }
/// Writes one message into <folder>/cur (or new/ when unread).
///
/// Returns false if the file could not be written. Call index() afterwards.
/// `to` defaults to a single generic recipient. Pass one explicitly to
/// exercise the recipient summary, which is the only thing that reads it.
bool addMessage(const QString &folder, const QString &messageId,
const QString &subject, const QString &from,
const QString &date, const QString &body,
bool unread = true, const QString &inReplyTo = QString(),
const QString &to = QStringLiteral("you@example.org"))
{
// Unread messages must not carry the maildir "S" flag, so they go to
// new/ where no flags exist at all.
const QString sub = unread ? QStringLiteral("new") : QStringLiteral("cur");
const QString dirPath = maildirPath() + QLatin1Char('/') + folder;
QDir dir;
if (!dir.mkpath(dirPath + QStringLiteral("/cur"))
|| !dir.mkpath(dirPath + QStringLiteral("/new"))
|| !dir.mkpath(dirPath + QStringLiteral("/tmp"))) {
return false;
}
// The local part of the id makes a safe, unique, flag-free filename.
QString base = messageId;
base.remove(QLatin1Char('<')).remove(QLatin1Char('>'));
base.replace(QLatin1Char('@'), QLatin1Char('.'));
base.replace(QLatin1Char('/'), QLatin1Char('.'));
if (!unread)
base += QStringLiteral(":2,S");
QFile file(dirPath + QLatin1Char('/') + sub + QLatin1Char('/') + base);
if (!file.open(QIODevice::WriteOnly | QIODevice::Text))
return false;
QTextStream out(&file);
out << "From: " << from << "\n"
<< "To: " << to << "\n"
<< "Subject: " << subject << "\n"
<< "Message-ID: <" << messageId << ">\n"
<< "Date: " << date << "\n";
if (!inReplyTo.isEmpty())
out << "In-Reply-To: <" << inReplyTo << ">\n"
<< "References: <" << inReplyTo << ">\n";
out << "\n" << body << "\n";
out.flush();
file.close();
return true;
}
/// Writes the config and runs `notmuch new`. Safe to call repeatedly.
/// Returns false (with error() set) if notmuch is missing or fails.
bool index()
{
QFile config(configPath());
if (!config.open(QIODevice::WriteOnly | QIODevice::Text)) {
m_error = QStringLiteral("cannot write fixture config");
return false;
}
QTextStream out(&config);
out << "[database]\n";
if (m_splitIndex) {
// Two keys: the mail stays put and only the index moves. notmuch
// reads `path` as the database directory ITSELF here, not as a
// parent to create `.notmuch` in.
QDir().mkpath(indexPath());
out << "mail_root=" << maildirPath() << "\n"
<< "path=" << indexPath() << "\n";
} else {
out << "path=" << maildirPath() << "\n";
}
out << "[new]\n"
<< "tags=unread;inbox;\n";
out.flush();
config.close();
QProcess proc;
QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
env.insert(QStringLiteral("NOTMUCH_CONFIG"), configPath());
proc.setProcessEnvironment(env);
proc.start(QStringLiteral("notmuch"), { QStringLiteral("new") });
if (!proc.waitForStarted(5000)) {
m_error = QStringLiteral("notmuch not found on PATH");
return false;
}
if (!proc.waitForFinished(30000) || proc.exitCode() != 0) {
m_error = QStringLiteral("notmuch new failed: %1")
.arg(QString::fromLocal8Bit(proc.readAllStandardError()));
return false;
}
return true;
}
QString error() const { return m_error; }
private:
QTemporaryDir m_dir;
QString m_error;
bool m_splitIndex = false;
};
|
