nmo = $nmo; $this->override = $override; } public function backoff() { return [5, 10, 30, 240]; } public function handle() { /*Set the correct database*/ MultiDB::setDb($this->nmo->company->db); /* Serializing models from other jobs wipes the primary key */ $this->company = Company::where('company_key', $this->nmo->company->company_key)->first(); /* If any pre conditions fail, we return early here */ if(!$this->company || $this->preFlightChecksFail()) return; /* Set the email driver */ $this->setMailDriver(); /* Run time we set Reply To Email*/ if (strlen($this->nmo->settings->reply_to_email) > 1) { if(property_exists($this->nmo->settings, 'reply_to_name')) $reply_to_name = strlen($this->nmo->settings->reply_to_name) > 3 ? $this->nmo->settings->reply_to_name : $this->nmo->settings->reply_to_email; else $reply_to_name = $this->nmo->settings->reply_to_email; $this->nmo->mailable->replyTo($this->nmo->settings->reply_to_email, $reply_to_name); } else { $this->nmo->mailable->replyTo($this->company->owner()->email, $this->company->owner()->present()->name()); } /* Run time we set the email tag */ $this->nmo->mailable->tag($this->company->company_key); /* If we have an invitation present, we pass the invitation key into the email headers*/ if($this->nmo->invitation) { $this->nmo ->mailable ->withSymfonyMessage(function ($message) { $message->getHeaders()->addTextHeader('x-invitation', $this->nmo->invitation->key); }); } //send email try { nlog("Trying to send to {$this->nmo->to_user->email} ". now()->toDateTimeString()); nlog("Using mailer => ". $this->mailer); $mailer = Mail::mailer($this->mailer); if($this->client_postmark_secret){ $mailer->postmark_config($this->client_postmark_secret); } if($this->client_mailgun_secret){ $mailer->mailgun_config($this->client_mailgun_secret, $this->client_mailgun_domain); } $mailer ->to($this->nmo->to_user->email) ->send($this->nmo->mailable); /* Count the amount of emails sent across all the users accounts */ Cache::increment($this->company->account->key); LightLogs::create(new EmailSuccess($this->nmo->company->company_key)) ->send(); $this->nmo = null; $this->company = null; } catch(\Symfony\Component\Mime\Exception\RfcComplianceException $e) { nlog("Mailer failed with a Logic Exception {$e->getMessage()}"); $this->fail(); $this->cleanUpMailers(); $this->logMailError($e->getMessage(), $this->company->clients()->first()); return; } catch(\Symfony\Component\Mime\Exception\LogicException $e){ nlog("Mailer failed with a Logic Exception {$e->getMessage()}"); $this->fail(); $this->cleanUpMailers(); $this->logMailError($e->getMessage(), $this->company->clients()->first()); return; } catch (\Exception | \Google\Service\Exception $e) { nlog("Mailer failed with {$e->getMessage()}"); $message = $e->getMessage(); /** * Post mark buries the proper message in a a guzzle response * this merges a text string with a json object * need to harvest the ->Message property using the following */ if(stripos($e->getMessage(), 'code 406') || stripos($e->getMessage(), 'code 300') || stripos($e->getMessage(), 'code 413')) { $message = "Either Attachment too large, or recipient has been suppressed."; $this->fail(); $this->logMailError($e->getMessage(), $this->company->clients()->first()); $this->cleanUpMailers(); return; } //only report once, not on all tries if($this->attempts() == $this->tries) { /* If the is an entity attached to the message send a failure mailer */ if($this->nmo->entity) $this->entityEmailFailed($message); /* Don't send postmark failures to Sentry */ if(Ninja::isHosted() && (!$e instanceof ClientException)) app('sentry')->captureException($e); } /* Releasing immediately does not add in the backoff */ $this->release($this->backoff()[$this->attempts()-1]); } /*Clean up mailers*/ $this->cleanUpMailers(); } /** * Entity notification when an email fails to send * * @param string $message * @return void */ private function entityEmailFailed($message): void { $class = get_class($this->nmo->entity); switch ($class) { case Invoice::class: event(new InvoiceWasEmailedAndFailed($this->nmo->invitation, $this->nmo->company, $message, $this->nmo->reminder_template, Ninja::eventVars(auth()->user() ? auth()->user()->id : null))); break; case Payment::class: event(new PaymentWasEmailedAndFailed($this->nmo->entity, $this->nmo->company, $message, Ninja::eventVars(auth()->user() ? auth()->user()->id : null))); break; default: # code... break; } if ($this->nmo->to_user instanceof ClientContact) $this->logMailError($message, $this->nmo->to_user->client); } /** * Initializes the configured Mailer */ private function setMailDriver() { /* Singletons need to be rebooted each time just in case our Locale is changing*/ App::forgetInstance('translator'); $t = app('translator'); $t->replace(Ninja::transformTranslations($this->nmo->settings)); switch ($this->nmo->settings->email_sending_method) { case 'default': $this->mailer = config('mail.default'); break; case 'gmail': $this->mailer = 'gmail'; $this->setGmailMailer(); return; case 'office365': $this->mailer = 'office365'; $this->setOfficeMailer(); return; case 'client_postmark': $this->mailer = 'postmark'; $this->setPostmarkMailer(); return; case 'client_mailgun': $this->mailer = 'mailgun'; $this->setMailgunMailer(); return; default: break; } if(Ninja::isSelfHost()) $this->setSelfHostMultiMailer(); } /** * Allows configuration of multiple mailers * per company for use by self hosted users */ private function setSelfHostMultiMailer(): void { if (env($this->company->id . '_MAIL_HOST')) { config([ 'mail.mailers.smtp' => [ 'transport' => 'smtp', 'host' => env($this->company->id . '_MAIL_HOST'), 'port' => env($this->company->id . '_MAIL_PORT'), 'username' => env($this->company->id . '_MAIL_USERNAME'), 'password' => env($this->company->id . '_MAIL_PASSWORD'), ], ]); if(env($this->company->id . '_MAIL_FROM_ADDRESS')) { $this->nmo ->mailable ->from(env($this->company->id . '_MAIL_FROM_ADDRESS', env('MAIL_FROM_ADDRESS')), env($this->company->id . '_MAIL_FROM_NAME', env('MAIL_FROM_NAME'))); } } } /** * Ensure we discard any data that is not required * * @return void */ private function cleanUpMailers(): void { $this->client_postmark_secret = false; $this->client_mailgun_secret = false; $this->client_mailgun_domain = false; //always dump the drivers to prevent reuse app('mail.manager')->forgetMailers(); } /** * Check to ensure no cross account * emails can be sent. * * @param User $user */ private function checkValidSendingUser($user) { /* Always ensure the user is set on the correct account */ if($user->account_id != $this->company->account_id){ $this->nmo->settings->email_sending_method = 'default'; return $this->setMailDriver(); } } /** * Resolves the sending user * when configuring the Mailer * on behalf of the client * * @return User $user */ private function resolveSendingUser(): ?User { $sending_user = $this->nmo->settings->gmail_sending_user_id; if($sending_user == "0") $user = $this->company->owner(); else $user = User::find($this->decodePrimaryKey($sending_user)); return $user; } /** * Configures Mailgun using client supplied secret * as the Mailer */ private function setMailgunMailer() { if(strlen($this->nmo->settings->mailgun_secret) > 2 && strlen($this->nmo->settings->mailgun_domain) > 2){ $this->client_mailgun_secret = $this->nmo->settings->mailgun_secret; $this->client_mailgun_domain = $this->nmo->settings->mailgun_domain; } else{ $this->nmo->settings->email_sending_method = 'default'; return $this->setMailDriver(); } $user = $this->resolveSendingUser(); $sending_email = (isset($this->nmo->settings->custom_sending_email) && stripos($this->nmo->settings->custom_sending_email, "@")) ? $this->nmo->settings->custom_sending_email : $user->email; $sending_user = (isset($this->nmo->settings->email_from_name) && strlen($this->nmo->settings->email_from_name) > 2) ? $this->nmo->settings->email_from_name : $user->name(); $this->nmo ->mailable ->from($sending_email, $sending_user); } /** * Configures Postmark using client supplied secret * as the Mailer */ private function setPostmarkMailer() { if(strlen($this->nmo->settings->postmark_secret) > 2){ $this->client_postmark_secret = $this->nmo->settings->postmark_secret; } else{ $this->nmo->settings->email_sending_method = 'default'; return $this->setMailDriver(); } $user = $this->resolveSendingUser(); $sending_email = (isset($this->nmo->settings->custom_sending_email) && stripos($this->nmo->settings->custom_sending_email, "@")) ? $this->nmo->settings->custom_sending_email : $user->email; $sending_user = (isset($this->nmo->settings->email_from_name) && strlen($this->nmo->settings->email_from_name) > 2) ? $this->nmo->settings->email_from_name : $user->name(); $this->nmo ->mailable ->from($sending_email, $sending_user); } /** * Configures Microsoft via Oauth * as the Mailer */ private function setOfficeMailer() { $user = $this->resolveSendingUser(); $this->checkValidSendingUser($user); nlog("Sending via {$user->name()}"); $token = $this->refreshOfficeToken($user); if($token) { $user->oauth_user_token = $token; $user->save(); } else { $this->nmo->settings->email_sending_method = 'default'; return $this->setMailDriver(); } $this->nmo ->mailable ->from($user->email, $user->name()) ->withSymfonyMessage(function ($message) use($token) { $message->getHeaders()->addTextHeader('gmailtoken', $token); }); } /** * Configures GMail via Oauth * as the Mailer */ private function setGmailMailer() { $user = $this->resolveSendingUser(); $this->checkValidSendingUser($user); nlog("Sending via {$user->name()}"); $google = (new Google())->init(); try{ if ($google->getClient()->isAccessTokenExpired()) { $google->refreshToken($user); $user = $user->fresh(); } $google->getClient()->setAccessToken(json_encode($user->oauth_user_token)); } catch(\Exception $e) { $this->logMailError('Gmail Token Invalid', $this->company->clients()->first()); $this->nmo->settings->email_sending_method = 'default'; return $this->setMailDriver(); } /** * If the user doesn't have a valid token, notify them */ if(!$user->oauth_user_token) { $this->company->account->gmailCredentialNotification(); $this->nmo->settings->email_sending_method = 'default'; return $this->setMailDriver(); } /* * Now that our token is refreshed and valid we can boot the * mail driver at runtime and also set the token which will persist * just for this request. */ $token = $user->oauth_user_token->access_token; if(!$token) { $this->company->account->gmailCredentialNotification(); $this->nmo->settings->email_sending_method = 'default'; return $this->setMailDriver(); } $this->nmo ->mailable ->from($user->email, $user->name()) ->withSymfonyMessage(function ($message) use($token) { $message->getHeaders()->addTextHeader('gmailtoken', $token); }); } /** * On the hosted platform we scan all outbound email for * spam. This sequence processes the filters we use on all * emails. * * @return bool */ private function preFlightChecksFail(): bool { /* If we are migrating data we don't want to fire any emails */ if($this->company->is_disabled && !$this->override) return true; /* To handle spam users we drop all emails from flagged accounts */ if(Ninja::isHosted() && $this->company->account && $this->company->account->is_flagged) return true; /* On the hosted platform we set default contacts a @example.com email address - we shouldn't send emails to these types of addresses */ if(Ninja::isHosted() && $this->nmo->to_user && strpos($this->nmo->to_user->email, '@example.com') !== false) return true; /* GMail users are uncapped */ if(Ninja::isHosted() && ($this->nmo->settings->email_sending_method == 'gmail' || $this->nmo->settings->email_sending_method == 'office365')) return false; /* On the hosted platform, if the user is over the email quotas, we do not send the email. */ if(Ninja::isHosted() && $this->company->account && $this->company->account->emailQuotaExceeded()) return true; /* If the account is verified, we allow emails to flow */ if(Ninja::isHosted() && $this->company->account && $this->company->account->is_verified_account) { //11-01-2022 /* Continue to analyse verified accounts in case they later start sending poor quality emails*/ // if(class_exists(\Modules\Admin\Jobs\Account\EmailQuality::class)) // (new \Modules\Admin\Jobs\Account\EmailQuality($this->nmo, $this->company))->run(); return false; } /* Ensure the user has a valid email address */ if(!str_contains($this->nmo->to_user->email, "@")) return true; /* On the hosted platform if the user has not verified their account we fail here - but still check what they are trying to send! */ if(Ninja::isHosted() && $this->company->account && !$this->company->account->account_sms_verified){ if(class_exists(\Modules\Admin\Jobs\Account\EmailQuality::class)) return (new \Modules\Admin\Jobs\Account\EmailQuality($this->nmo, $this->company))->run(); return true; } /* On the hosted platform we actively scan all outbound emails to ensure outbound email quality remains high */ if(class_exists(\Modules\Admin\Jobs\Account\EmailQuality::class)) return (new \Modules\Admin\Jobs\Account\EmailQuality($this->nmo, $this->company))->run(); return false; } /** * Logs any errors to the SystemLog * * @param string $errors * @param App\Models\User | App\Models\Client $recipient_object * @return void */ private function logMailError($errors, $recipient_object) :void { (new SystemLogger( $errors, SystemLog::CATEGORY_MAIL, SystemLog::EVENT_MAIL_SEND, SystemLog::TYPE_FAILURE, $recipient_object, $this->nmo->company ))->handle(); $job_failure = new EmailFailure($this->nmo->company->company_key); $job_failure->string_metric5 = 'failed_email'; $job_failure->string_metric6 = substr($errors, 0, 150); LightLogs::create($job_failure) ->send(); $job_failure = null; } /** * Attempts to refresh the Microsoft refreshToken * * @param App\Models\User * @return string | boool */ private function refreshOfficeToken($user) { $expiry = $user->oauth_user_token_expiry ?: now()->subDay(); if($expiry->lt(now())) { $guzzle = new \GuzzleHttp\Client(); $url = 'https://login.microsoftonline.com/common/oauth2/v2.0/token'; $token = json_decode($guzzle->post($url, [ 'form_params' => [ 'client_id' => config('ninja.o365.client_id') , 'client_secret' => config('ninja.o365.client_secret') , 'scope' => 'email Mail.Send offline_access profile User.Read openid', 'grant_type' => 'refresh_token', 'refresh_token' => $user->oauth_user_refresh_token ], ])->getBody()->getContents()); if($token){ $user->oauth_user_refresh_token = property_exists($token, 'refresh_token') ? $token->refresh_token : $user->oauth_user_refresh_token; $user->oauth_user_token = $token->access_token; $user->oauth_user_token_expiry = now()->addSeconds($token->expires_in); $user->save(); return $token->access_token; } return false; } return $user->oauth_user_token; } public function failed($exception = null) { config(['queue.failed.driver' => null]); } }