1 | <?php |
||
27 | class Email |
||
28 | { |
||
29 | /** |
||
30 | * @var string |
||
31 | */ |
||
32 | private $subject; |
||
33 | |||
34 | /** |
||
35 | * @var EmailPart[] |
||
36 | */ |
||
37 | private $parts = []; |
||
38 | |||
39 | /** |
||
40 | * @var EmailAddress|null |
||
41 | */ |
||
42 | private $from; |
||
43 | |||
44 | /** |
||
45 | * @var EmailAddress[] |
||
46 | */ |
||
47 | private $to = []; |
||
48 | |||
49 | /** |
||
50 | * @var EmailAddress[] |
||
51 | */ |
||
52 | private $cc = []; |
||
53 | |||
54 | /** |
||
55 | * @var EmailAddress[] |
||
56 | */ |
||
57 | private $bcc = []; |
||
58 | |||
59 | /** |
||
60 | * @var EmailHeader[] |
||
61 | */ |
||
62 | private $headers = []; |
||
63 | |||
64 | /** |
||
65 | * @var bool |
||
66 | */ |
||
67 | private $trackMessageOpening; |
||
68 | |||
69 | /** |
||
70 | * @var bool |
||
71 | */ |
||
72 | private $trackClicks; |
||
73 | |||
74 | /** |
||
75 | * With this, an email provider like Mailchimp can track how many emails were open, etc. |
||
76 | * |
||
77 | * @var string |
||
78 | */ |
||
79 | private $trackingCampaign = ''; |
||
80 | |||
81 | /** |
||
82 | * @var array |
||
83 | */ |
||
84 | private $tags = []; |
||
85 | |||
86 | /** |
||
87 | * @var EmailAttachment[] |
||
88 | */ |
||
89 | private $attachments = []; |
||
90 | |||
91 | public function __construct(string $subject, EmailAddress $from) |
||
99 | |||
100 | public function setBodyHtml(string $content, string $charset = null): void |
||
104 | |||
105 | public function setBodyText(string $content, string $charset = null): void |
||
109 | |||
110 | public function getPlainTextPart(): ?EmailPart |
||
120 | |||
121 | public function getHtmlPart(): ?EmailPart |
||
131 | |||
132 | /** |
||
133 | * @throws EmailPartAlreadyProvidedException |
||
134 | */ |
||
135 | protected function addPart(string $content, string $contentType = null, string $charset = null): void |
||
145 | |||
146 | public function getSubject(): string |
||
150 | |||
151 | /** |
||
152 | * @return EmailPart[] |
||
153 | */ |
||
154 | public function getParts(): array |
||
158 | |||
159 | public function addTo(EmailAddress $emailAddress): void |
||
163 | |||
164 | public function addCc(EmailAddress $emailAddress): void |
||
168 | |||
169 | public function addBcc(EmailAddress $emailAddress): void |
||
173 | |||
174 | public function getFrom(): EmailAddress |
||
178 | |||
179 | /** |
||
180 | * @return EmailAddress[] |
||
181 | */ |
||
182 | public function getTo(): array |
||
186 | |||
187 | /** |
||
188 | * @return EmailAddress[] |
||
189 | */ |
||
190 | public function getCc(): array |
||
194 | |||
195 | /** |
||
196 | * @return EmailAddress[] |
||
197 | */ |
||
198 | public function getBcc(): array |
||
202 | |||
203 | public function addHeader(string $name, string $value = ''): void |
||
207 | |||
208 | /** |
||
209 | * @return EmailHeader[] |
||
210 | */ |
||
211 | public function getHeaders(): array |
||
215 | |||
216 | public function setTrackMessageOpening(bool $state): void |
||
220 | |||
221 | public function setTrackClicks(bool $state): void |
||
225 | |||
226 | public function setTrackingCampaign(string $trackingCampaign): void |
||
230 | |||
231 | public function getTrackingCampaign(): string |
||
235 | |||
236 | public function setTags(array $tags): void |
||
240 | |||
241 | public function getTags(): array |
||
245 | |||
246 | public function shouldTrackClicks(): bool |
||
250 | |||
251 | public function shouldTrackMessageOpening(): bool |
||
255 | |||
256 | public function getFirstTo(): EmailAddress |
||
262 | |||
263 | /** |
||
264 | * @throws EmailAddressNotFoundException |
||
265 | */ |
||
266 | public function getFirstToMatchingRegex(string $regex): EmailAddress |
||
278 | |||
279 | public function addAttachment(EmailAttachmentInterface $attachment): void |
||
283 | |||
284 | /** |
||
285 | * @return EmailAttachmentInterface[] |
||
286 | */ |
||
287 | public function getAttachments(): array |
||
291 | |||
292 | public function hasAttachments(): bool |
||
296 | } |
||
297 |