aboutsummaryrefslogtreecommitdiff
path: root/vmime-master/src/vmime/net/transport.hpp
blob: daa4717ff5b8bdae661aa62f8781da8250b557a9 (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
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
//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
//
// 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.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library.  Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//

#ifndef VMIME_NET_TRANSPORT_HPP_INCLUDED
#define VMIME_NET_TRANSPORT_HPP_INCLUDED


#include "vmime/config.hpp"


#if VMIME_HAVE_MESSAGING_FEATURES


#include "vmime/net/dsnAttributes.hpp"
#include "vmime/net/service.hpp"
#include "vmime/utility/stream.hpp"

#include "vmime/mailboxList.hpp"


namespace vmime {

class header;
class headerField;
class message;
class mailbox;
class mailboxList;

namespace net {


/** A transport service.
  * Encapsulate protocols that can send messages.
  */
class VMIME_EXPORT transport : public service {

protected:

	transport(
		const shared_ptr <session>& sess,
		const serviceInfos& infos,
		const shared_ptr <security::authenticator>& auth
	);

public:

	/** Send a message over this transport service.
	  * The default implementation simply generates the whole message into
	  * a string buffer and "streams" it via a inputStreamStringAdapter.
	  *
	  * @param msg message to send
	  * @param progress progress listener, or NULL if not used
	  * @param dsnAttributes attributes for Delivery Status Notification (if needed)
	  */
	virtual void send(
		const shared_ptr <vmime::message>& msg,
		utility::progressListener* progress = NULL,
		const dsnAttributes& dsnAttrs = dsnAttributes()
	);

	/** Send a message over this transport service.
	  *
	  * @param expeditor expeditor mailbox
	  * @param recipients list of recipient mailboxes
	  * @param is input stream providing message data (header + body)
	  * @param size size of the message data
	  * @param progress progress listener, or NULL if not used
	  * @param sender envelope sender (if empty, expeditor will be used)
	  * @param dsnAttributes attributes for Delivery Status Notification (if needed)
	  */
	virtual void send(
		const mailbox& expeditor,
		const mailboxList& recipients,
		utility::inputStream& is,
		const size_t size,
		utility::progressListener* progress = NULL,
		const mailbox& sender = mailbox(),
		const dsnAttributes& dsnAttrs = dsnAttributes()
	) = 0;

	/** Send a message over this transport service.
	  * The default implementation simply generates the whole message into
	  * a string buffer and "streams" it via a inputStreamStringAdapter.
	  *
	  * @param msg message to send
	  * @param expeditor expeditor mailbox
	  * @param recipients list of recipient mailboxes
	  * @param progress progress listener, or NULL if not used
	  * @param sender envelope sender (if empty, expeditor will be used)
	  * @param dsnAttributes attributes for Delivery Status Notification (if needed)
	  */
	virtual void send(
		const shared_ptr <vmime::message>& msg,
		const mailbox& expeditor,
		const mailboxList& recipients,
		utility::progressListener* progress = NULL,
		const mailbox& sender = mailbox(),
		const dsnAttributes& dsnAttrs = dsnAttributes()
	);


	Type getType() const;

protected:

	/** Called by processHeader().
	  * Decides what to do with the specified header field.
	  *
	  * @return NULL if the header should be removed, a reference to a new headerField
	  * if the field is to be replaced, or a reference to the same headerField
	  * that was passed if the field should be left as is
	  */
	shared_ptr <headerField> processHeaderField(const shared_ptr <headerField>& field);

	/** Prepares the header before transmitting the message.
	  * Removes headers that should not be present (eg. "Bcc", "Return-Path"),
	  * or adds missing headers that are required/recommended by the RFCs.
	  * The header is modified inline.
	  *
	  * @param header headers to process
	  */
	void processHeader(const shared_ptr <header>& header);
};


} // net
} // vmime


#endif // VMIME_HAVE_MESSAGING_FEATURES

#endif // VMIME_NET_TRANSPORT_HPP_INCLUDED