src/App/Entity/EmailDeliveryNotification.php line 25

Open in your IDE?
  1. <?php
  3. namespace App\Entity;
  5. use App\Utility\GuidUtility;
  6. use DateTime;
  7. use Doctrine\ORM\Mapping as ORM;
  8. use Exception;
  9. use ReflectionClass;
  11. /**
  12. * @ORM\Entity
  13. *
  14. * @ORM\Table(
  15. * name="email_delivery_notifications",
  16. * indexes={
  17. *
  18. * @ORM\Index(name="users_id_mail_sent_at_idx", columns={"users_id", "mail_sent_at"}),
  19. * @ORM\Index(name="email_mail_sent_at_idx", columns={"email", "mail_sent_at"}),
  20. * @ORM\Index(name="notification_type_mail_sent_at_idx", columns={"notification_type", "mail_sent_at"}),
  21. * @ORM\Index(name="mail_sent_at_idx", columns={"mail_sent_at"})
  22. * }
  23. * )
  24. */
  25. class EmailDeliveryNotification
  26. {
  27. public const NOTIFICATION_TYPE_DELIVERY = 0;
  28. public const NOTIFICATION_TYPE_BOUNCE = 1;
  29. public const NOTIFICATION_TYPE_COMPLAINT = 2;
  31. /**
  32. * @var string
  33. *
  34. * @ORM\GeneratedValue(strategy="CUSTOM")
  35. *
  36. * @ORM\CustomIdGenerator(class="App\Utility\DatabaseIdGenerator")
  37. *
  38. * @ORM\Column(name="id", type="guid")
  39. *
  40. * @ORM\Id
  41. */
  42. protected $id;
  44. public function setId(string $id): void
  45. {
  46. GuidUtility::validOrThrow($id);
  47. $this->id = $id;
  48. }
  50. public function getId()
  51. {
  52. return $this->id;
  53. }
  55. /**
  56. * @var User
  57. *
  58. * @ORM\ManyToOne(targetEntity="App\Entity\User", inversedBy="emailDeliveryNotifications")
  59. *
  60. * @ORM\JoinColumn(name="users_id", onDelete="CASCADE", nullable=true)
  61. */
  62. protected $user;
  64. public function getUser(): ?User
  65. {
  66. return $this->user;
  67. }
  69. public function setUser(?User $user = null): void
  70. {
  71. $this->user = $user;
  72. }
  74. /**
  75. * @var int
  76. *
  77. * @ORM\Column(name="notification_type", type="smallint", nullable=false)
  78. */
  79. protected $notificationType;
  81. /**
  82. * @throws Exception
  83. */
  84. public function setNotificationType(int $notificationType): void
  85. {
  86. $refl = new ReflectionClass(EmailDeliveryNotification::class);
  87. $constants = $refl->getConstants();
  88. $found = false;
  89. foreach ($constants as $constantName => $constantValue) {
  90. if (substr($constantName, 0, 18) === 'NOTIFICATION_TYPE_' && $constantValue === $notificationType) {
  91. $found = true;
  92. }
  93. }
  95. if (!$found) {
  96. throw new Exception('Value ' . $notificationType . ' not allowed for notificationType.');
  97. }
  98. $this->notificationType = $notificationType;
  99. }
  101. public function getNotificationType(): int
  102. {
  103. return $this->notificationType;
  104. }
  106. /**
  107. * @var int
  108. *
  109. * @ORM\Column(name="email", type="string", length=255, nullable=false)
  110. */
  111. protected $email;
  113. /**
  114. * @throws Exception
  115. */
  116. public function setEmail(string $email): void
  117. {
  118. $this->email = $email;
  119. }
  121. public function getEmail(): string
  122. {
  123. return $this->email;
  124. }
  126. /**
  127. * @ORM\Column(name="smtp_message", type="string", length=8192, nullable=false)
  128. */
  129. protected $smtpMessage;
  131. /**
  132. * @throws Exception
  133. */
  134. public function setSmtpMessage(string $smtpMessage): void
  135. {
  136. $this->smtpMessage = $smtpMessage;
  137. }
  139. public function getSmtpMessage(): string
  140. {
  141. return $this->smtpMessage;
  142. }
  144. /**
  145. * @ORM\Column(name="mail_message_id", type="string", length=2014, nullable=false)
  146. */
  147. protected $mailMessageId;
  149. /**
  150. * @throws Exception
  151. */
  152. public function setMailMessageId(string $mailMessageId): void
  153. {
  154. $this->mailMessageId = $mailMessageId;
  155. }
  157. public function getMailMessageId(): string
  158. {
  159. return $this->mailMessageId;
  160. }
  162. /**
  163. * @var DateTime
  164. *
  165. * @ORM\Column(name="notification_received_at", type="datetime", nullable=false)
  166. */
  167. protected $notificationReceivedAt;
  169. public function setNotificationReceivedAt(DateTime $notificationReceivedAt): void
  170. {
  171. $this->notificationReceivedAt = $notificationReceivedAt;
  172. }
  174. public function getNotificationReceivedAt(): DateTime
  175. {
  176. return $this->notificationReceivedAt;
  177. }
  179. /**
  180. * @var DateTime
  181. *
  182. * @ORM\Column(name="mail_sent_at", type="datetime", nullable=false)
  183. */
  184. protected $mailSentAt;
  186. public function setMailSentAt(DateTime $mailSentAt): void
  187. {
  188. $this->mailSentAt = $mailSentAt;
  189. }
  191. public function getMailSentAt(): DateTime
  192. {
  193. return $this->mailSentAt;
  194. }
  196. /**
  197. * @var DateTime
  198. *
  199. * @ORM\Column(name="delivery_event_occured_at", type="datetime", nullable=false)
  200. */
  201. protected $deliveryEventOccuredAt;
  203. public function setDeliveryEventOccuredAt(DateTime $deliveryEventOccuredAt): void
  204. {
  205. $this->deliveryEventOccuredAt = $deliveryEventOccuredAt;
  206. }
  208. public function getDeliveryEventOccuredAt(): DateTime
  209. {
  210. return $this->deliveryEventOccuredAt;
  211. }
  213. /**
  214. * @ORM\Column(name="subject", type="text", length=4096, nullable=true)
  215. */
  216. protected $subject;
  218. /**
  219. * @throws Exception
  220. */
  221. public function setSubject(string $subject)
  222. {
  223. $this->subject = $subject;
  224. }
  226. public function getSubject()
  227. {
  228. return $this->subject;
  229. }
  231. /**
  232. * @ORM\Column(name="raw_notification_message", type="text", length=8192, nullable=false)
  233. */
  234. protected $rawNotificationMessage;
  236. /**
  237. * @throws Exception
  238. */
  239. public function setRawNotificationMessage(string $rawNotificationMessage)
  240. {
  241. if (is_null(json_decode($rawNotificationMessage))) {
  242. throw new Exception('rawNotificationMessage must be valid JSON, but ' . $rawNotificationMessage . ' is not.');
  243. }
  244. $this->rawNotificationMessage = $rawNotificationMessage;
  245. }
  247. public function getRawNotificationMessage()
  248. {
  249. return $this->rawNotificationMessage;
  250. }
  251. }