import { createTransport, Transporter } from 'nodemailer'
-import { UserRight } from '../../shared/models/users'
-import { isTestInstance } from '../helpers/core-utils'
+import { isTestInstance, root } from '../helpers/core-utils'
import { bunyanLogger, logger } from '../helpers/logger'
-import { CONFIG } from '../initializers'
-import { UserModel } from '../models/account/user'
-import { VideoModel } from '../models/video/video'
+import { CONFIG, isEmailEnabled } from '../initializers/config'
import { JobQueue } from './job-queue'
-import { EmailPayload } from './job-queue/handlers/email'
-import { readFileSync } from 'fs'
+import { readFileSync } from 'fs-extra'
+import { WEBSERVER } from '../initializers/constants'
+import {
+ MCommentOwnerVideo,
+ MVideo,
+ MVideoAbuseVideo,
+ MVideoAccountLight,
+ MVideoBlacklistLightVideo,
+ MVideoBlacklistVideo
+} from '../types/models/video'
+import { MActorFollowActors, MActorFollowFull, MUser } from '../types/models'
+import { MVideoImport, MVideoImportVideo } from '@server/types/models/video/video-import'
+import { EmailPayload } from '@shared/models'
+import { join } from 'path'
+import { VideoAbuse } from '../../shared/models/videos'
+import { SendEmailOptions } from '../../shared/models/server/emailer.model'
+import { merge } from 'lodash'
+import { VideoChannelModel } from '@server/models/video/video-channel'
+const Email = require('email-templates')
class Emailer {
private initialized = false
private transporter: Transporter
- private constructor () {}
+ private constructor () {
+ }
init () {
// Already initialized
if (this.initialized === true) return
this.initialized = true
- if (CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) {
- logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT)
+ if (isEmailEnabled()) {
+ if (CONFIG.SMTP.TRANSPORT === 'smtp') {
+ logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT)
- let tls
- if (CONFIG.SMTP.CA_FILE) {
- tls = {
- ca: [ readFileSync(CONFIG.SMTP.CA_FILE) ]
+ let tls
+ if (CONFIG.SMTP.CA_FILE) {
+ tls = {
+ ca: [ readFileSync(CONFIG.SMTP.CA_FILE) ]
+ }
}
- }
- let auth
- if (CONFIG.SMTP.USERNAME && CONFIG.SMTP.PASSWORD) {
- auth = {
- user: CONFIG.SMTP.USERNAME,
- pass: CONFIG.SMTP.PASSWORD
+ let auth
+ if (CONFIG.SMTP.USERNAME && CONFIG.SMTP.PASSWORD) {
+ auth = {
+ user: CONFIG.SMTP.USERNAME,
+ pass: CONFIG.SMTP.PASSWORD
+ }
}
- }
- this.transporter = createTransport({
- host: CONFIG.SMTP.HOSTNAME,
- port: CONFIG.SMTP.PORT,
- secure: CONFIG.SMTP.TLS,
- debug: CONFIG.LOG.LEVEL === 'debug',
- logger: bunyanLogger as any,
- ignoreTLS: CONFIG.SMTP.DISABLE_STARTTLS,
- tls,
- auth
- })
+ this.transporter = createTransport({
+ host: CONFIG.SMTP.HOSTNAME,
+ port: CONFIG.SMTP.PORT,
+ secure: CONFIG.SMTP.TLS,
+ debug: CONFIG.LOG.LEVEL === 'debug',
+ logger: bunyanLogger as any,
+ ignoreTLS: CONFIG.SMTP.DISABLE_STARTTLS,
+ tls,
+ auth
+ })
+ } else { // sendmail
+ logger.info('Using sendmail to send emails')
+
+ this.transporter = createTransport({
+ sendmail: true,
+ newline: 'unix',
+ path: CONFIG.SMTP.SENDMAIL
+ })
+ }
} else {
if (!isTestInstance()) {
logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!')
}
}
+ static isEnabled () {
+ if (CONFIG.SMTP.TRANSPORT === 'sendmail') {
+ return !!CONFIG.SMTP.SENDMAIL
+ } else if (CONFIG.SMTP.TRANSPORT === 'smtp') {
+ return !!CONFIG.SMTP.HOSTNAME && !!CONFIG.SMTP.PORT
+ } else {
+ return false
+ }
+ }
+
async checkConnectionOrDie () {
- if (!this.transporter) return
+ if (!this.transporter || CONFIG.SMTP.TRANSPORT !== 'smtp') return
logger.info('Testing SMTP server...')
}
}
- addForgetPasswordEmailJob (to: string, resetPasswordUrl: string) {
- const text = `Hi dear user,\n\n` +
- `It seems you forgot your password on ${CONFIG.WEBSERVER.HOST}! ` +
- `Please follow this link to reset it: ${resetPasswordUrl}\n\n` +
- `If you are not the person who initiated this request, please ignore this email.\n\n` +
- `Cheers,\n` +
- `PeerTube.`
+ addNewVideoFromSubscriberNotification (to: string[], video: MVideoAccountLight) {
+ const channelName = video.VideoChannel.getDisplayName()
+ const videoUrl = WEBSERVER.URL + video.getWatchStaticPath()
const emailPayload: EmailPayload = {
- to: [ to ],
- subject: 'Reset your PeerTube password',
- text
+ to,
+ subject: channelName + ' just published a new video',
+ text: `Your subscription ${channelName} just published a new video: "${video.name}".`,
+ locals: {
+ title: 'New content ',
+ action: {
+ text: 'View video',
+ url: videoUrl
+ }
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addNewFollowNotification (to: string[], actorFollow: MActorFollowFull, followType: 'account' | 'channel') {
+ const followingName = (actorFollow.ActorFollowing.VideoChannel || actorFollow.ActorFollowing.Account).getDisplayName()
+
+ const emailPayload: EmailPayload = {
+ template: 'follower-on-channel',
+ to,
+ subject: `New follower on your channel ${followingName}`,
+ locals: {
+ followerName: actorFollow.ActorFollower.Account.getDisplayName(),
+ followerUrl: actorFollow.ActorFollower.url,
+ followingName,
+ followingUrl: actorFollow.ActorFollowing.url,
+ followType
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addNewInstanceFollowerNotification (to: string[], actorFollow: MActorFollowActors) {
+ const awaitingApproval = actorFollow.state === 'pending' ? ' awaiting manual approval.' : ''
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: 'New instance follower',
+ text: `Your instance has a new follower: ${actorFollow.ActorFollower.url}${awaitingApproval}.`,
+ locals: {
+ title: 'New instance follower',
+ action: {
+ text: 'Review followers',
+ url: WEBSERVER.URL + '/admin/follows/followers-list'
+ }
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addAutoInstanceFollowingNotification (to: string[], actorFollow: MActorFollowActors) {
+ const instanceUrl = actorFollow.ActorFollowing.url
+ const emailPayload: EmailPayload = {
+ to,
+ subject: 'Auto instance following',
+ text: `Your instance automatically followed a new instance: <a href="${instanceUrl}">${instanceUrl}</a>.`
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ myVideoPublishedNotification (to: string[], video: MVideo) {
+ const videoUrl = WEBSERVER.URL + video.getWatchStaticPath()
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: `Your video ${video.name} has been published`,
+ text: `Your video "${video.name}" has been published.`,
+ locals: {
+ title: 'You video is live',
+ action: {
+ text: 'View video',
+ url: videoUrl
+ }
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ myVideoImportSuccessNotification (to: string[], videoImport: MVideoImportVideo) {
+ const videoUrl = WEBSERVER.URL + videoImport.Video.getWatchStaticPath()
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: `Your video import ${videoImport.getTargetIdentifier()} is complete`,
+ text: `Your video "${videoImport.getTargetIdentifier()}" just finished importing.`,
+ locals: {
+ title: 'Import complete',
+ action: {
+ text: 'View video',
+ url: videoUrl
+ }
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ myVideoImportErrorNotification (to: string[], videoImport: MVideoImport) {
+ const importUrl = WEBSERVER.URL + '/my-account/video-imports'
+
+ const text =
+ `Your video import "${videoImport.getTargetIdentifier()}" encountered an error.` +
+ '\n\n' +
+ `See your videos import dashboard for more information: <a href="${importUrl}">${importUrl}</a>.`
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: `Your video import "${videoImport.getTargetIdentifier()}" encountered an error`,
+ text,
+ locals: {
+ title: 'Import failed',
+ action: {
+ text: 'Review imports',
+ url: importUrl
+ }
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addNewCommentOnMyVideoNotification (to: string[], comment: MCommentOwnerVideo) {
+ const video = comment.Video
+ const videoUrl = WEBSERVER.URL + comment.Video.getWatchStaticPath()
+ const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath()
+
+ const emailPayload: EmailPayload = {
+ template: 'video-comment-new',
+ to,
+ subject: 'New comment on your video ' + video.name,
+ locals: {
+ accountName: comment.Account.getDisplayName(),
+ accountUrl: comment.Account.Actor.url,
+ comment,
+ video,
+ videoUrl,
+ action: {
+ text: 'View comment',
+ url: commentUrl
+ }
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addNewCommentMentionNotification (to: string[], comment: MCommentOwnerVideo) {
+ const accountName = comment.Account.getDisplayName()
+ const video = comment.Video
+ const videoUrl = WEBSERVER.URL + comment.Video.getWatchStaticPath()
+ const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath()
+
+ const emailPayload: EmailPayload = {
+ template: 'video-comment-mention',
+ to,
+ subject: 'Mention on video ' + video.name,
+ locals: {
+ comment,
+ video,
+ videoUrl,
+ accountName,
+ action: {
+ text: 'View comment',
+ url: commentUrl
+ }
+ }
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
- async addVideoAbuseReport (videoId: number) {
- const video = await VideoModel.load(videoId)
- if (!video) throw new Error('Unknown Video id during Abuse report.')
+ addVideoAbuseModeratorsNotification (to: string[], parameters: {
+ videoAbuse: VideoAbuse
+ videoAbuseInstance: MVideoAbuseVideo
+ reporter: string
+ }) {
+ const videoAbuseUrl = WEBSERVER.URL + '/admin/moderation/video-abuses/list?search=%23' + parameters.videoAbuse.id
+ const videoUrl = WEBSERVER.URL + parameters.videoAbuseInstance.Video.getWatchStaticPath()
+
+ const emailPayload: EmailPayload = {
+ template: 'video-abuse-new',
+ to,
+ subject: `New video abuse report from ${parameters.reporter}`,
+ locals: {
+ videoUrl,
+ videoAbuseUrl,
+ videoCreatedAt: new Date(parameters.videoAbuseInstance.Video.createdAt).toLocaleString(),
+ videoPublishedAt: new Date(parameters.videoAbuseInstance.Video.publishedAt).toLocaleString(),
+ videoAbuse: parameters.videoAbuse,
+ reporter: parameters.reporter,
+ action: {
+ text: 'View report #' + parameters.videoAbuse.id,
+ url: videoAbuseUrl
+ }
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
- const text = `Hi,\n\n` +
- `Your instance received an abuse for the following video ${video.url}\n\n` +
- `Cheers,\n` +
- `PeerTube.`
+ async addVideoAutoBlacklistModeratorsNotification (to: string[], videoBlacklist: MVideoBlacklistLightVideo) {
+ const VIDEO_AUTO_BLACKLIST_URL = WEBSERVER.URL + '/admin/moderation/video-auto-blacklist/list'
+ const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath()
+ const channel = (await VideoChannelModel.loadByIdAndPopulateAccount(videoBlacklist.Video.channelId)).toFormattedSummaryJSON()
- const to = await UserModel.listEmailsWithRight(UserRight.MANAGE_VIDEO_ABUSES)
const emailPayload: EmailPayload = {
+ template: 'video-auto-blacklist-new',
to,
- subject: '[PeerTube] Received a video abuse',
- text
+ subject: 'A new video is pending moderation',
+ locals: {
+ channel,
+ videoUrl,
+ videoName: videoBlacklist.Video.name,
+ action: {
+ text: 'Review autoblacklist',
+ url: VIDEO_AUTO_BLACKLIST_URL
+ }
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addNewUserRegistrationNotification (to: string[], user: MUser) {
+ const emailPayload: EmailPayload = {
+ template: 'user-registered',
+ to,
+ subject: `a new user registered on ${WEBSERVER.HOST}: ${user.username}`,
+ locals: {
+ user
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addVideoBlacklistNotification (to: string[], videoBlacklist: MVideoBlacklistVideo) {
+ const videoName = videoBlacklist.Video.name
+ const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath()
+
+ const reasonString = videoBlacklist.reason ? ` for the following reason: ${videoBlacklist.reason}` : ''
+ const blockedString = `Your video ${videoName} (${videoUrl} on ${WEBSERVER.HOST} has been blacklisted${reasonString}.`
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: `Video ${videoName} blacklisted`,
+ text: blockedString,
+ locals: {
+ title: 'Your video was blacklisted'
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addVideoUnblacklistNotification (to: string[], video: MVideo) {
+ const videoUrl = WEBSERVER.URL + video.getWatchStaticPath()
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: `Video ${video.name} unblacklisted`,
+ text: `Your video "${video.name}" (${videoUrl}) on ${WEBSERVER.HOST} has been unblacklisted.`,
+ locals: {
+ title: 'Your video was unblacklisted'
+ }
}
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
- sendMail (to: string[], subject: string, text: string) {
- if (!this.transporter) {
+ addPasswordResetEmailJob (to: string, resetPasswordUrl: string) {
+ const emailPayload: EmailPayload = {
+ template: 'password-reset',
+ to: [ to ],
+ subject: 'Reset your account password',
+ locals: {
+ resetPasswordUrl
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addPasswordCreateEmailJob (username: string, to: string, createPasswordUrl: string) {
+ const emailPayload: EmailPayload = {
+ template: 'password-create',
+ to: [ to ],
+ subject: 'Create your account password',
+ locals: {
+ username,
+ createPasswordUrl
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addVerifyEmailJob (to: string, verifyEmailUrl: string) {
+ const emailPayload: EmailPayload = {
+ template: 'verify-email',
+ to: [ to ],
+ subject: `Verify your email on ${WEBSERVER.HOST}`,
+ locals: {
+ verifyEmailUrl
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addUserBlockJob (user: MUser, blocked: boolean, reason?: string) {
+ const reasonString = reason ? ` for the following reason: ${reason}` : ''
+ const blockedWord = blocked ? 'blocked' : 'unblocked'
+
+ const to = user.email
+ const emailPayload: EmailPayload = {
+ to: [ to ],
+ subject: 'Account ' + blockedWord,
+ text: `Your account ${user.username} on ${WEBSERVER.HOST} has been ${blockedWord}${reasonString}.`
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addContactFormJob (fromEmail: string, fromName: string, subject: string, body: string) {
+ const emailPayload: EmailPayload = {
+ template: 'contact-form',
+ to: [ CONFIG.ADMIN.EMAIL ],
+ replyTo: `"${fromName}" <${fromEmail}>`,
+ subject: `(contact form) ${subject}`,
+ locals: {
+ fromName,
+ fromEmail,
+ body
+ }
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ async sendMail (options: EmailPayload) {
+ if (!isEmailEnabled()) {
throw new Error('Cannot send mail because SMTP is not configured.')
}
- return this.transporter.sendMail({
- from: CONFIG.SMTP.FROM_ADDRESS,
- to: to.join(','),
- subject,
- text
+ const fromDisplayName = options.from
+ ? options.from
+ : WEBSERVER.HOST
+
+ const email = new Email({
+ send: true,
+ message: {
+ from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`
+ },
+ transport: this.transporter,
+ views: {
+ root: join(root(), 'dist', 'server', 'lib', 'emails')
+ },
+ subjectPrefix: CONFIG.EMAIL.SUBJECT.PREFIX
})
+
+ for (const to of options.to) {
+ await email
+ .send(merge(
+ {
+ template: 'common',
+ message: {
+ to,
+ from: options.from,
+ subject: options.subject,
+ replyTo: options.replyTo
+ },
+ locals: { // default variables available in all templates
+ WEBSERVER,
+ EMAIL: CONFIG.EMAIL,
+ text: options.text,
+ subject: options.subject
+ }
+ },
+ options // overriden/new variables given for a specific template in the payload
+ ) as SendEmailOptions)
+ .then(res => logger.debug('Sent email.', { res }))
+ .catch(err => logger.error('Error in email sender.', { err }))
+ }
}
private dieOnConnectionFailure (err?: Error) {
projects / github / Chocobozzz / PeerTube.git / blobdiff