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
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2017 Joas Schilling <coding@schilljs.com>
*
* @author Joas Schilling <coding@schilljs.com>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Mail;
/**
* Interface IMessage
*
* @since 13.0.0
*/
interface IMessage {
/**
* Set the subject of this message
*
* @param string $subject
*
* @return self
* @since 28.0.0
*/
public function setSubject(string $subject): IMessage;
/**
* Set the plain-text body of this message
*
* @param string $body
*
* @return self
* @since 28.0.0
*/
public function setPlainBody(string $body): IMessage;
/**
* Set the HTML body of this message. Consider also sending a plain-text body instead of only an HTML one.
*
* @param string $body
*
* @return self
* @since 28.0.0
*/
public function setHtmlBody(string $body): IMessage;
/**
* @param IAttachment $attachment
* @return IMessage
* @since 13.0.0
*/
public function attach(IAttachment $attachment): IMessage;
/**
* Can be used to "attach content inline" as message parts with specific MIME type and encoding.
*
* @param string $body body of the MIME part
* @param string $name the file name
* @param string|null $contentType MIME Content-Type (e.g. text/plain or text/calendar)
*
* @return IMessage
* @since 27.0.0
*/
public function attachInline(string $body, string $name, string $contentType = null): IMessage;
/**
* Set the from address of this message.
*
* If no "From" address is used \OC\Mail\Mailer will use mail_from_address and mail_domain from config.php
*
* @param array $addresses Example: array('sender@domain.org', 'other@domain.org' => 'A name')
* @return IMessage
* @since 13.0.0
*/
public function setFrom(array $addresses): IMessage;
/**
* Set the Reply-To address of this message
*
* @param array $addresses
* @return IMessage
* @since 13.0.0
*/
public function setReplyTo(array $addresses): IMessage;
/**
* Set the to addresses of this message.
*
* @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
* @return IMessage
* @since 13.0.0
*/
public function setTo(array $recipients): IMessage;
/**
* Set the CC recipients of this message.
*
* @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
* @return IMessage
* @since 13.0.0
*/
public function setCc(array $recipients): IMessage;
/**
* Set the BCC recipients of this message.
*
* @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
* @return IMessage
* @since 13.0.0
*/
public function setBcc(array $recipients): IMessage;
/**
* @param IEMailTemplate $emailTemplate
* @return IMessage
* @since 13.0.0
*/
public function useTemplate(IEMailTemplate $emailTemplate): IMessage;
/**
* Add the Auto-Submitted header to the email, preventing most automated
* responses to automated messages.
*
* @param Headers\AutoSubmitted::VALUE_* $value (one of AutoSubmitted::VALUE_NO, AutoSubmitted::VALUE_AUTO_GENERATED, AutoSubmitted::VALUE_AUTO_REPLIED)
* @return IMessage
* @since 26.0.0
*/
public function setAutoSubmitted(string $value): IMessage;
}
|
