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 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
<?php
/* --------------------------------------------------------------
Email.inc.php 2015-01-29 gm
Gambio GmbH
http://www.gambio.de
Copyright (c) 2015 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
MainFactory::load_class('EmailInterface');
/**
* Class representing the database entity of an email.
*
* @category System
* @package Email
* @subpackage Entities
*/
class Email implements EmailInterface
{
/**
* E-Mail ID.
* @var int
*/
protected $id;
/**
* E-Mail sender.
* @var EmailContactInterface
*/
protected $sender;
/**
* E-Mail recipient.
* @var EmailContactInterface
*/
protected $recipient;
/**
* E-Mail reply-to contact.
* @var EmailContactInterface
*/
protected $replyTo;
/**
* E-Mail subject.
* @var EmailSubjectInterface
*/
protected $subject;
/**
* E-Mail plain content
* @var EmailContentInterface
*/
protected $contentPlain;
/**
* E-Mail HTML content.
* @var EmailContentInterface
*/
protected $contentHtml;
/**
* E-Mail attachments.
* @var AttachmentCollectionInterface
*/
protected $attachments;
/**
* E-Mail BCC.
* @var ContactCollectionInterface
*/
protected $bcc;
/**
* E-Mail CC.
* @var ContactCollectionInterface
*/
protected $cc;
/**
* Is E-Mail pending?
* @var bool
*/
protected $isPending;
/**
* Create date time.
* @var DateTime
*/
protected $creationDate;
/**
* Sent date time.
* @var DateTime
*/
protected $sentDate;
/**
* Class Constructor
*
* All parameters are optional and can be set after the creation of the Email
* object. All class properties will have "null" as default value.
*
* @param EmailContactInterface $sender (optional) E-Mail sender.
* @param EmailContactInterface $recipient (optional) E-Mail recipient.
* @param EmailSubjectInterface $subject (optional) E-Mail subject.
* @param EmailContentInterface $contentHtml (optional) E-Mail HTML content.
* @param EmailContentInterface $contentPlain (optional) E-Mail plain content.
*/
public function __construct(EmailContactInterface $sender = null,
EmailContactInterface $recipient = null,
EmailSubjectInterface $subject = null,
EmailContentInterface $contentHtml = null,
EmailContentInterface $contentPlain = null)
{
// Required Email Properties
$this->sender = $sender;
$this->recipient = $recipient;
$this->subject = $subject;
$this->contentHtml = $contentHtml;
$this->contentPlain = $contentPlain;
// Optional Email Properties
$this->id = null;
$this->bcc = MainFactory::create('ContactCollection');
$this->cc = MainFactory::create('ContactCollection');
$this->attachments = MainFactory::create('AttachmentCollection');
$this->isPending = true;
$this->creationDate = new DateTime(); // Current datetime as default value.
$this->sentDate = null;
}
/**
* Sets the ID of an email.
*
* @param IdType $id E-Mail ID.
*/
public function setId(IdType $id)
{
$this->id = (int)(string)$id;
}
/**
* Returns the ID of an email.
*
* @return IdType E-Mail ID.
*/
public function getId()
{
return $this->id;
}
/**
* Sets the sender of an email.
*
* @param EmailContactInterface $sender E-Mail sender.
*/
public function setSender(EmailContactInterface $sender)
{
$this->sender = $sender;
}
/**
* Returns the sender of an email
*
* @return EmailContactInterface E-Mail sender.
*/
public function getSender()
{
return $this->sender;
}
/**
* Sets the recipient of an email.
*
* @param EmailContactInterface $recipient E-Mail recipient.
*/
public function setRecipient(EmailContactInterface $recipient)
{
$this->recipient = $recipient;
}
/**
* Returns the recipient of an email.
*
* @return EmailContactInterface E-Mail recipient.
*/
public function getRecipient()
{
return $this->recipient;
}
/**
* Sets the 'reply to' option value of an email.
*
* @param EmailContactInterface $recipient E-Mail reply-to.
*/
public function setReplyTo(EmailContactInterface $recipient)
{
$this->replyTo = $recipient;
}
/**
* Returns the 'reply to' option value of an email.
*
* @return EmailContactInterface E-Mail reply-to.
*/
public function getReplyTo()
{
return $this->replyTo;
}
/**
* Sets the subject of an email.
*
* @param EmailSubjectInterface $subject E-Mail subject.
*/
public function setSubject(EmailSubjectInterface $subject)
{
$this->subject = $subject;
}
/**
* Returns the subject of an email.
*
* @return EmailSubjectInterface E-Mail subject.
*/
public function getSubject()
{
return $this->subject;
}
/**
* Sets the plain content of an email.
*
* @param EmailContentInterface $contentPlain E-Mail plain content.
*/
public function setContentPlain(EmailContentInterface $contentPlain)
{
$this->contentPlain = $contentPlain;
}
/**
* Returns the plain content of an email.
*
* @return EmailContentInterface E-Mail plain content.
*/
public function getContentPlain()
{
return $this->contentPlain;
}
/**
* Sets the HTML content of an email.
*
* @param EmailContentInterface $contentHtml E-Mail HTML content.
*/
public function setContentHtml(EmailContentInterface $contentHtml)
{
$this->contentHtml = $contentHtml;
}
/**
* Returns the HTML content of an email.
*
* @return EmailContentInterface E-Mail HTML content.
*/
public function getContentHtml()
{
return $this->contentHtml;
}
/**
* Sets the attachments of an email.
*
* @param AttachmentCollectionInterface $attachments E-Mail attachments.
*/
public function setAttachments(AttachmentCollectionInterface $attachments)
{
$this->attachments = $attachments;
}
/**
* Returns the attachments of an email.
*
* @return AttachmentCollectionInterface E-Mail attachments.
*/
public function getAttachments()
{
return $this->attachments;
}
/**
* Sets the BCC of an email.
*
* @param ContactCollectionInterface $bcc E-Mail BCC.
*/
public function setBcc(ContactCollectionInterface $bcc)
{
$this->bcc = $bcc;
}
/**
* Returns the BCC of an email.
*
* @return ContactCollectionInterface E-Mail BCC.
*/
public function getBcc()
{
return $this->bcc;
}
/**
* Sets the CC of an email.
*
* @param ContactCollectionInterface $cc E-Mail CC.
*/
public function setCc(ContactCollectionInterface $cc)
{
$this->cc = $cc;
}
/**
* Returns the CC of an email.
*
* @return ContactCollectionInterface E-Mail CC.
*/
public function getCc()
{
return $this->cc;
}
/**
* Sets an email status to pending if true is given, else sent.
*
* @param bool $p_isPending E-Mail pending status.
*
* @throws InvalidArgumentException If "$p_isPending" is not valid.
*/
public function setPending($p_isPending)
{
if(!is_bool($p_isPending))
{
throw new InvalidArgumentException('Invalid argument provided (expected bool) $p_isPending: '
. print_r($p_isPending, true));
}
$this->isPending = (bool)$p_isPending;
}
/**
* Returns if an email is pending or sent.
*
* @return bool E-Mail pending status.
*/
public function isPending()
{
return $this->isPending;
}
/**
* Sets the creation date of an email.
*
* @param DateTime $creationDate E-Mail creation date.
*/
public function setCreationDate(DateTime $creationDate)
{
$this->creationDate = $creationDate;
}
/**
* Returns the creation date of an email.
*
* @return DateTime E-Mail creation date.
*/
public function getCreationDate()
{
return $this->creationDate;
}
/**
* Sets the sent date of an email.
*
* @param DateTime $sentDate E-Mail sent date.
*/
public function setSentDate(DateTime $sentDate)
{
$this->sentDate = $sentDate;
}
/**
* Returns the sent date of an email.
*
* @return DateTime E-Mail sent date.
*/
public function getSentDate()
{
return $this->sentDate;
}
}