summaryrefslogtreecommitdiffstats
path: root/src/messagebuilder.h
blob: f9de277e825d9d65294eb17920a3e1cb4f42c446 (plain)
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
/*
 * 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 <QByteArray>
#include <QString>

#include "types.h"

struct Account;

/// Turns an OutgoingMessage into the RFC822 bytes that get sent.
///
/// ONE built message serves three consumers: the autosaved draft, the bytes on
/// the send command's stdin, and the sent copy. A draft is therefore
/// byte-identical to what would be sent.
///
/// GMime rather than assembling RFC822 by string. The alternative means
/// reimplementing RFC 2047 header encoding, quoted-printable for accented
/// bodies, boundary uniqueness and line-length limits. This user writes
/// Italian; a body containing an accented character is every message, and a
/// bug there produces mail that looks correct locally and arrives as mojibake.
namespace MessageBuilder {

struct Result
{
    QByteArray bytes;    ///< The complete message. Empty on failure.
    QString error;       ///< Empty on success.
    QString messageId;   ///< The generated Message-ID, for the caller's records.

    bool ok() const { return error.isEmpty(); }
};

/// Builds \p message as sent from \p account.
///
/// Fails, rather than sending a partial message, when an attachment named in
/// the message no longer exists. That is checked HERE, at build time, rather
/// than when the file was attached: a file can vanish in between, and the
/// failure must stop the send rather than produce a message missing the thing
/// it was written to carry.
Result build(const OutgoingMessage &message, const Account &account);

}  // namespace MessageBuilder