. * * The interactive user interfaces in modified source and object code versions * of this program must display Appropriate Legal Notices, as required under * Section 5 of the GNU Affero General Public License version 3. * * In accordance with Section 7(b) of the GNU Affero General Public License version 3, * these Appropriate Legal Notices must retain the display of the "EspoCRM" word. ************************************************************************/ namespace Espo\Modules\Crm\Entities; use Espo\Core\ORM\Entity; use Espo\Entities\EmailTemplate; use Espo\ORM\EntityCollection; class MassEmail extends Entity { public const ENTITY_TYPE = 'MassEmail'; public const STATUS_COMPLETE = 'Complete'; public const STATUS_FAILED = 'Failed'; public const STATUS_IN_PROCESS = 'In Process'; public const STATUS_PENDING = 'Pending'; public const STATUS_DRAFT = 'Draft'; public function getStatus(): ?string { return $this->get('status'); } public function getEmailTemplateId(): ?string { return $this->get('emailTemplateId'); } /** * @return EntityCollection */ public function getTargetLists(): EntityCollection { /** @var EntityCollection */ return $this->relations->getMany('targetLists'); } /** * @return EntityCollection */ public function getExcludingTargetLists(): EntityCollection { /** @var EntityCollection */ return $this->relations->getMany('excludingTargetLists'); } public function getEmailTemplate(): ?EmailTemplate { /** @var ?EmailTemplate */ return $this->relations->getOne('emailTemplate'); } public function getCampaign(): ?Campaign { /** @var ?Campaign */ return $this->relations->getOne('campaign'); } public function getCampaignId(): ?string { return $this->get('campaignId'); } public function getInboundEmailId(): ?string { return $this->get('inboundEmailId'); } public function getFromName(): ?string { return $this->get('fromName'); } public function getReplyToName(): ?string { return $this->get('replyToName'); } public function getFromAddress(): ?string { return $this->get('fromAddress'); } public function getReplyToAddress(): ?string { return $this->get('replyToAddress'); } public function storeSentEmails(): bool { return (bool) $this->get('storeSentEmails'); } public function optOutEntirely(): bool { return (bool) $this->get('optOutEntirely'); } public function setStatus(string $status): self { $this->set('status', $status); return $this; } }