newSubscriberNotificationMailer = $newSubscriberNotificationMailer; $this->confirmationEmailMailer = $confirmationEmailMailer; $this->requiredCustomFieldValidator = $requiredCustomFieldValidator; $this->customFieldsDataSanitizer = $customFieldsDataSanitizer; $this->welcomeScheduler = $welcomeScheduler; } public function getSubscriberFields() { $data = [ [ 'id' => 'email', 'name' => WPFunctions::get()->__('Email', 'mailpoet'), 'type' => 'text', 'params' => [ 'required' => '1', ], ], [ 'id' => 'first_name', 'name' => WPFunctions::get()->__('First name', 'mailpoet'), 'type' => 'text', 'params' => [ 'required' => '', ], ], [ 'id' => 'last_name', 'name' => WPFunctions::get()->__('Last name', 'mailpoet'), 'type' => 'text', 'params' => [ 'required' => '', ], ], ]; $customFields = CustomField::selectMany(['id', 'name', 'type', 'params'])->findMany(); foreach ($customFields as $customField) { $result = [ 'id' => 'cf_' . $customField->id, 'name' => $customField->name, 'type' => $customField->type, ]; if (is_serialized($customField->params)) { $result['params'] = unserialize($customField->params); } else { $result['params'] = $customField->params; } $data[] = $result; } return $data; } public function addSubscriberField(array $data = []) { try { $customField = CustomField::createOrUpdate($this->customFieldsDataSanitizer->sanitize($data)); $errors = $customField->getErrors(); if (!empty($errors)) { throw new APIException('Failed to save a new subscriber field ' . join(', ', $errors), APIException::FAILED_TO_SAVE_SUBSCRIBER_FIELD); } $customField = CustomField::findOne($customField->id); if (!$customField instanceof CustomField) { throw new APIException('Failed to create a new subscriber field', APIException::FAILED_TO_SAVE_SUBSCRIBER_FIELD); } return $customField->asArray(); } catch (\InvalidArgumentException $e) { throw new APIException($e->getMessage(), $e->getCode(), $e); } } public function subscribeToList($subscriberId, $listId, $options = []) { return $this->subscribeToLists($subscriberId, [$listId], $options); } public function subscribeToLists($subscriberId, array $listIds, $options = []) { $scheduleWelcomeEmail = (isset($options['schedule_welcome_email']) && $options['schedule_welcome_email'] === false) ? false : true; $sendConfirmationEmail = (isset($options['send_confirmation_email']) && $options['send_confirmation_email'] === false) ? false : true; $skipSubscriberNotification = (isset($options['skip_subscriber_notification']) && $options['skip_subscriber_notification'] === true) ? true : false; if (empty($listIds)) { throw new APIException(__('At least one segment ID is required.', 'mailpoet'), APIException::SEGMENT_REQUIRED); } // throw exception when subscriber does not exist $subscriber = Subscriber::findOne($subscriberId); if (!$subscriber) { throw new APIException(__('This subscriber does not exist.', 'mailpoet'), APIException::SUBSCRIBER_NOT_EXISTS); } // throw exception when none of the segments exist $foundSegments = Segment::whereIn('id', $listIds)->findMany(); if (!$foundSegments) { $exception = WPFunctions::get()->_n('This list does not exist.', 'These lists do not exist.', count($listIds), 'mailpoet'); throw new APIException($exception, APIException::LIST_NOT_EXISTS); } // throw exception when trying to subscribe to WP Users or WooCommerce Customers segments $foundSegmentsIds = []; foreach ($foundSegments as $foundSegment) { if ($foundSegment->type === Segment::TYPE_WP_USERS) { throw new APIException(__(sprintf("Can't subscribe to a WordPress Users list with ID %d.", $foundSegment->id), 'mailpoet'), APIException::SUBSCRIBING_TO_WP_LIST_NOT_ALLOWED); } if ($foundSegment->type === Segment::TYPE_WC_USERS) { throw new APIException(__(sprintf("Can't subscribe to a WooCommerce Customers list with ID %d.", $foundSegment->id), 'mailpoet'), APIException::SUBSCRIBING_TO_WC_LIST_NOT_ALLOWED); } if ($foundSegment->type !== Segment::TYPE_DEFAULT) { throw new APIException(__(sprintf("Can't subscribe to a list with ID %d.", $foundSegment->id), 'mailpoet'), APIException::SUBSCRIBING_TO_LIST_NOT_ALLOWED); } $foundSegmentsIds[] = $foundSegment->id; } // throw an exception when one or more segments do not exist if (count($foundSegmentsIds) !== count($listIds)) { $missingIds = array_values(array_diff($listIds, $foundSegmentsIds)); $exception = sprintf( WPFunctions::get()->_n('List with ID %s does not exist.', 'Lists with IDs %s do not exist.', count($missingIds), 'mailpoet'), implode(', ', $missingIds) ); throw new APIException(sprintf($exception, implode(', ', $missingIds)), APIException::LIST_NOT_EXISTS); } SubscriberSegment::subscribeToSegments($subscriber, $foundSegmentsIds); // schedule welcome email if ($scheduleWelcomeEmail && $subscriber->status === Subscriber::STATUS_SUBSCRIBED) { $this->_scheduleWelcomeNotification($subscriber, $foundSegmentsIds); } // send confirmation email if ( $sendConfirmationEmail && $subscriber->status === Subscriber::STATUS_UNCONFIRMED && (int)$subscriber->countConfirmations === 0 ) { $result = $this->_sendConfirmationEmail($subscriber); if (!$result && $subscriber->getErrors()) { throw new APIException( WPFunctions::get()->__(sprintf('Subscriber added to lists, but confirmation email failed to send: %s', strtolower(implode(', ', $subscriber->getErrors()))), 'mailpoet'), APIException::CONFIRMATION_FAILED_TO_SEND); } } if (!$skipSubscriberNotification && ($subscriber->status === Subscriber::STATUS_SUBSCRIBED)) { $this->sendSubscriberNotification($subscriber, $foundSegmentsIds); } return $subscriber->withCustomFields()->withSubscriptions()->asArray(); } public function unsubscribeFromList($subscriberId, $listId) { return $this->unsubscribeFromLists($subscriberId, [$listId]); } public function unsubscribeFromLists($subscriberId, array $listIds) { if (empty($listIds)) { throw new APIException(__('At least one segment ID is required.', 'mailpoet'), APIException::SEGMENT_REQUIRED); } // throw exception when subscriber does not exist $subscriber = Subscriber::findOne($subscriberId); if (!$subscriber) { throw new APIException(__('This subscriber does not exist.', 'mailpoet'), APIException::SUBSCRIBER_NOT_EXISTS); } // throw exception when none of the segments exist $foundSegments = Segment::whereIn('id', $listIds)->findMany(); if (!$foundSegments) { $exception = WPFunctions::get()->_n('This list does not exist.', 'These lists do not exist.', count($listIds), 'mailpoet'); throw new APIException($exception, APIException::LIST_NOT_EXISTS); } // throw exception when trying to subscribe to WP Users or WooCommerce Customers segments $foundSegmentsIds = []; foreach ($foundSegments as $segment) { if ($segment->type === Segment::TYPE_WP_USERS) { throw new APIException(__(sprintf("Can't unsubscribe from a WordPress Users list with ID %d.", $segment->id), 'mailpoet'), APIException::SUBSCRIBING_TO_WP_LIST_NOT_ALLOWED); } if ($segment->type === Segment::TYPE_WC_USERS) { throw new APIException(__(sprintf("Can't unsubscribe from a WooCommerce Customers list with ID %d.", $segment->id), 'mailpoet'), APIException::SUBSCRIBING_TO_WC_LIST_NOT_ALLOWED); } $foundSegmentsIds[] = $segment->id; } // throw an exception when one or more segments do not exist if (count($foundSegmentsIds) !== count($listIds)) { $missingIds = array_values(array_diff($listIds, $foundSegmentsIds)); $exception = sprintf( WPFunctions::get()->_n('List with ID %s does not exist.', 'Lists with IDs %s do not exist.', count($missingIds), 'mailpoet'), implode(', ', $missingIds) ); throw new APIException($exception, APIException::LIST_NOT_EXISTS); } SubscriberSegment::unsubscribeFromSegments($subscriber, $foundSegmentsIds); return $subscriber->withCustomFields()->withSubscriptions()->asArray(); } public function getLists() { return Segment::where('type', Segment::TYPE_DEFAULT) ->findArray(); } public function addSubscriber(array $subscriber, $listIds = [], $options = []) { $sendConfirmationEmail = (isset($options['send_confirmation_email']) && $options['send_confirmation_email'] === false) ? false : true; $scheduleWelcomeEmail = (isset($options['schedule_welcome_email']) && $options['schedule_welcome_email'] === false) ? false : true; $skipSubscriberNotification = (isset($options['skip_subscriber_notification']) && $options['skip_subscriber_notification'] === true) ? true : false; // throw exception when subscriber email is missing if (empty($subscriber['email'])) { throw new APIException( WPFunctions::get()->__('Subscriber email address is required.', 'mailpoet'), APIException::EMAIL_ADDRESS_REQUIRED ); } // throw exception when subscriber already exists if (Subscriber::findOne($subscriber['email'])) { throw new APIException( WPFunctions::get()->__('This subscriber already exists.', 'mailpoet'), APIException::SUBSCRIBER_EXISTS ); } if (empty($subscriber['subscribed_ip'])) { $subscriber['subscribed_ip'] = Helpers::getIP(); } // separate data into default and custom fields list($defaultFields, $customFields) = Subscriber::extractCustomFieldsFromFromObject($subscriber); // filter out all incoming data that we don't want to change, like status ... $defaultFields = array_intersect_key($defaultFields, array_flip(['email', 'first_name', 'last_name', 'subscribed_ip'])); // if some required default fields are missing, set their values $defaultFields = Subscriber::setRequiredFieldsDefaultValues($defaultFields); $this->requiredCustomFieldValidator->validate($customFields); // add subscriber $newSubscriber = Subscriber::create(); $newSubscriber->hydrate($defaultFields); $newSubscriber = Source::setSource($newSubscriber, Source::API); $newSubscriber->save(); if ($newSubscriber->getErrors() !== false) { throw new APIException( WPFunctions::get()->__(sprintf('Failed to add subscriber: %s', strtolower(implode(', ', $newSubscriber->getErrors()))), 'mailpoet'), APIException::FAILED_TO_SAVE_SUBSCRIBER ); } if (!empty($customFields)) { $newSubscriber->saveCustomFields($customFields); } // reload subscriber to get the saved status/created|updated|delete dates/other fields $newSubscriber = Subscriber::findOne($newSubscriber->id); // subscribe to segments and optionally: 1) send confirmation email, 2) schedule welcome email(s) if (!empty($listIds)) { $this->subscribeToLists($newSubscriber->id, $listIds, [ 'send_confirmation_email' => $sendConfirmationEmail, 'schedule_welcome_email' => $scheduleWelcomeEmail, 'skip_subscriber_notification' => $skipSubscriberNotification, ]); // schedule welcome email(s) if ($scheduleWelcomeEmail && $newSubscriber->status === Subscriber::STATUS_SUBSCRIBED) { $this->_scheduleWelcomeNotification($newSubscriber, $listIds); } if (!$skipSubscriberNotification && ($newSubscriber->status === Subscriber::STATUS_SUBSCRIBED)) { $this->sendSubscriberNotification($newSubscriber, $listIds); } } return $newSubscriber->withCustomFields()->withSubscriptions()->asArray(); } public function addList(array $list) { // throw exception when list name is missing if (empty($list['name'])) { throw new APIException( WPFunctions::get()->__('List name is required.', 'mailpoet'), APIException::LIST_NAME_REQUIRED ); } // throw exception when list already exists if (Segment::where('name', $list['name'])->findOne()) { throw new APIException( WPFunctions::get()->__('This list already exists.', 'mailpoet'), APIException::LIST_EXISTS ); } // filter out all incoming data that we don't want to change, like type, $list = array_intersect_key($list, array_flip(['name', 'description'])); // add list $newList = Segment::create(); $newList->hydrate($list); $newList->save(); if ($newList->getErrors() !== false) { throw new APIException( WPFunctions::get()->__(sprintf('Failed to add list: %s', strtolower(implode(', ', $newList->getErrors()))), 'mailpoet'), APIException::FAILED_TO_SAVE_LIST ); } // reload list to get the saved created|updated|delete dates/other fields $newList = Segment::findOne($newList->id); if (!$newList instanceof Segment) { throw new APIException(WPFunctions::get()->__('Failed to add list', 'mailpoet'), APIException::FAILED_TO_SAVE_LIST); } return $newList->asArray(); } public function getSubscriber($subscriberEmail) { $subscriber = Subscriber::findOne($subscriberEmail); // throw exception when subscriber does not exist if (!$subscriber) { throw new APIException(__('This subscriber does not exist.', 'mailpoet'), APIException::SUBSCRIBER_NOT_EXISTS); } return $subscriber->withCustomFields()->withSubscriptions()->asArray(); } protected function _sendConfirmationEmail(Subscriber $subscriber) { return $this->confirmationEmailMailer->sendConfirmationEmail($subscriber); } protected function _scheduleWelcomeNotification(Subscriber $subscriber, array $segments) { $result = $this->welcomeScheduler->scheduleSubscriberWelcomeNotification($subscriber->id, $segments); if (is_array($result)) { foreach ($result as $queue) { if ($queue instanceof Sending && $queue->getErrors()) { throw new APIException( WPFunctions::get()->__(sprintf('Subscriber added, but welcome email failed to send: %s', strtolower(implode(', ', $queue->getErrors()))), 'mailpoet'), APIException::WELCOME_FAILED_TO_SEND ); } } } return $result; } private function sendSubscriberNotification(Subscriber $subscriber, array $segmentIds) { $this->newSubscriberNotificationMailer->send($subscriber, Segment::whereIn('id', $segmentIds)->findMany()); } }