1 import { createTransport, Transporter } from 'nodemailer'
2 import { isTestInstance } from '../helpers/core-utils'
3 import { bunyanLogger, logger } from '../helpers/logger'
4 import { CONFIG } from '../initializers'
5 import { UserModel } from '../models/account/user'
6 import { VideoModel } from '../models/video/video'
7 import { JobQueue } from './job-queue'
8 import { EmailPayload } from './job-queue/handlers/email'
9 import { readFileSync } from 'fs-extra'
10 import { VideoCommentModel } from '../models/video/video-comment'
11 import { VideoAbuseModel } from '../models/video/video-abuse'
12 import { VideoBlacklistModel } from '../models/video/video-blacklist'
13 import { VideoImportModel } from '../models/video/video-import'
17 private static instance: Emailer
18 private initialized = false
19 private transporter: Transporter
20 private enabled = false
22 private constructor () {}
25 // Already initialized
26 if (this.initialized === true) return
27 this.initialized = true
29 if (CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) {
30 logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT)
33 if (CONFIG.SMTP.CA_FILE) {
35 ca: [ readFileSync(CONFIG.SMTP.CA_FILE) ]
40 if (CONFIG.SMTP.USERNAME && CONFIG.SMTP.PASSWORD) {
42 user: CONFIG.SMTP.USERNAME,
43 pass: CONFIG.SMTP.PASSWORD
47 this.transporter = createTransport({
48 host: CONFIG.SMTP.HOSTNAME,
49 port: CONFIG.SMTP.PORT,
50 secure: CONFIG.SMTP.TLS,
51 debug: CONFIG.LOG.LEVEL === 'debug',
52 logger: bunyanLogger as any,
53 ignoreTLS: CONFIG.SMTP.DISABLE_STARTTLS,
60 if (!isTestInstance()) {
61 logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!')
70 async checkConnectionOrDie () {
71 if (!this.transporter) return
73 logger.info('Testing SMTP server...')
76 const success = await this.transporter.verify()
77 if (success !== true) this.dieOnConnectionFailure()
79 logger.info('Successfully connected to SMTP server.')
81 this.dieOnConnectionFailure(err)
85 addNewVideoFromSubscriberNotification (to: string[], video: VideoModel) {
86 const channelName = video.VideoChannel.getDisplayName()
87 const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath()
89 const text = `Hi dear user,\n\n` +
90 `Your subscription ${channelName} just published a new video: ${video.name}` +
92 `You can view it on ${videoUrl} ` +
97 const emailPayload: EmailPayload = {
99 subject: channelName + ' just published a new video',
103 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
106 myVideoPublishedNotification (to: string[], video: VideoModel) {
107 const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath()
109 const text = `Hi dear user,\n\n` +
110 `Your video ${video.name} has been published.` +
112 `You can view it on ${videoUrl} ` +
117 const emailPayload: EmailPayload = {
119 subject: `Your video ${video.name} is published`,
123 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
126 myVideoImportSuccessNotification (to: string[], videoImport: VideoImportModel) {
127 const videoUrl = CONFIG.WEBSERVER.URL + videoImport.Video.getWatchStaticPath()
129 const text = `Hi dear user,\n\n` +
130 `Your video import ${videoImport.getTargetIdentifier()} is finished.` +
132 `You can view the imported video on ${videoUrl} ` +
137 const emailPayload: EmailPayload = {
139 subject: `Your video import ${videoImport.getTargetIdentifier()} is finished`,
143 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
146 myVideoImportErrorNotification (to: string[], videoImport: VideoImportModel) {
147 const importUrl = CONFIG.WEBSERVER.URL + '/my-account/video-imports'
149 const text = `Hi dear user,\n\n` +
150 `Your video import ${videoImport.getTargetIdentifier()} encountered an error.` +
152 `See your videos import dashboard for more information: ${importUrl}` +
157 const emailPayload: EmailPayload = {
159 subject: `Your video import ${videoImport.getTargetIdentifier()} encountered an error`,
163 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
166 addNewCommentOnMyVideoNotification (to: string[], comment: VideoCommentModel) {
167 const accountName = comment.Account.getDisplayName()
168 const video = comment.Video
169 const commentUrl = CONFIG.WEBSERVER.URL + comment.getCommentStaticPath()
171 const text = `Hi dear user,\n\n` +
172 `A new comment has been posted by ${accountName} on your video ${video.name}` +
174 `You can view it on ${commentUrl} ` +
179 const emailPayload: EmailPayload = {
181 subject: 'New comment on your video ' + video.name,
185 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
188 async addVideoAbuseModeratorsNotification (to: string[], videoAbuse: VideoAbuseModel) {
189 const videoUrl = CONFIG.WEBSERVER.URL + videoAbuse.Video.getWatchStaticPath()
191 const text = `Hi,\n\n` +
192 `${CONFIG.WEBSERVER.HOST} received an abuse for the following video ${videoUrl}\n\n` +
196 const emailPayload: EmailPayload = {
198 subject: '[PeerTube] Received a video abuse',
202 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
205 async addVideoBlacklistNotification (to: string[], videoBlacklist: VideoBlacklistModel) {
206 const videoName = videoBlacklist.Video.name
207 const videoUrl = CONFIG.WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath()
209 const reasonString = videoBlacklist.reason ? ` for the following reason: ${videoBlacklist.reason}` : ''
210 const blockedString = `Your video ${videoName} (${videoUrl} on ${CONFIG.WEBSERVER.HOST} has been blacklisted${reasonString}.`
212 const text = 'Hi,\n\n' +
218 const emailPayload: EmailPayload = {
220 subject: `[PeerTube] Video ${videoName} blacklisted`,
224 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
227 async addVideoUnblacklistNotification (to: string[], video: VideoModel) {
228 const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath()
230 const text = 'Hi,\n\n' +
231 `Your video ${video.name} (${videoUrl}) on ${CONFIG.WEBSERVER.HOST} has been unblacklisted.` +
236 const emailPayload: EmailPayload = {
238 subject: `[PeerTube] Video ${video.name} unblacklisted`,
242 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
245 addForgetPasswordEmailJob (to: string, resetPasswordUrl: string) {
246 const text = `Hi dear user,\n\n` +
247 `It seems you forgot your password on ${CONFIG.WEBSERVER.HOST}! ` +
248 `Please follow this link to reset it: ${resetPasswordUrl}\n\n` +
249 `If you are not the person who initiated this request, please ignore this email.\n\n` +
253 const emailPayload: EmailPayload = {
255 subject: 'Reset your PeerTube password',
259 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
262 addVerifyEmailJob (to: string, verifyEmailUrl: string) {
263 const text = `Welcome to PeerTube,\n\n` +
264 `To start using PeerTube on ${CONFIG.WEBSERVER.HOST} you must verify your email! ` +
265 `Please follow this link to verify this email belongs to you: ${verifyEmailUrl}\n\n` +
266 `If you are not the person who initiated this request, please ignore this email.\n\n` +
270 const emailPayload: EmailPayload = {
272 subject: 'Verify your PeerTube email',
276 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
279 addUserBlockJob (user: UserModel, blocked: boolean, reason?: string) {
280 const reasonString = reason ? ` for the following reason: ${reason}` : ''
281 const blockedWord = blocked ? 'blocked' : 'unblocked'
282 const blockedString = `Your account ${user.username} on ${CONFIG.WEBSERVER.HOST} has been ${blockedWord}${reasonString}.`
284 const text = 'Hi,\n\n' +
290 const to = user.email
291 const emailPayload: EmailPayload = {
293 subject: '[PeerTube] Account ' + blockedWord,
297 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
300 sendMail (to: string[], subject: string, text: string) {
302 throw new Error('Cannot send mail because SMTP is not configured.')
305 return this.transporter.sendMail({
306 from: CONFIG.SMTP.FROM_ADDRESS,
313 private dieOnConnectionFailure (err?: Error) {
314 logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, { err })
318 static get Instance () {
319 return this.instance || (this.instance = new this())
323 // ---------------------------------------------------------------------------