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'
14 import { ActorFollowModel } from '../models/activitypub/actor-follow'
18 private static instance: Emailer
19 private initialized = false
20 private transporter: Transporter
22 private constructor () {}
25 // Already initialized
26 if (this.initialized === true) return
27 this.initialized = true
29 if (Emailer.isEnabled()) {
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,
58 if (!isTestInstance()) {
59 logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!')
65 return !!CONFIG.SMTP.HOSTNAME && !!CONFIG.SMTP.PORT
68 async checkConnectionOrDie () {
69 if (!this.transporter) return
71 logger.info('Testing SMTP server...')
74 const success = await this.transporter.verify()
75 if (success !== true) this.dieOnConnectionFailure()
77 logger.info('Successfully connected to SMTP server.')
79 this.dieOnConnectionFailure(err)
83 addNewVideoFromSubscriberNotification (to: string[], video: VideoModel) {
84 const channelName = video.VideoChannel.getDisplayName()
85 const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath()
87 const text = `Hi dear user,\n\n` +
88 `Your subscription ${channelName} just published a new video: ${video.name}` +
90 `You can view it on ${videoUrl} ` +
95 const emailPayload: EmailPayload = {
97 subject: channelName + ' just published a new video',
101 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
104 addForceResetPasswordEmailJob (to: string, resetPasswordUrl: string) {
105 const text = `Hi dear user,\n\n` +
106 `Your password has been reset on ${CONFIG.WEBSERVER.HOST}! ` +
107 `Please follow this link to reset it: ${resetPasswordUrl}\n\n` +
111 const emailPayload: EmailPayload = {
113 subject: 'Reset of your PeerTube password',
117 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
120 addNewFollowNotification (to: string[], actorFollow: ActorFollowModel, followType: 'account' | 'channel') {
121 const followerName = actorFollow.ActorFollower.Account.getDisplayName()
122 const followingName = (actorFollow.ActorFollowing.VideoChannel || actorFollow.ActorFollowing.Account).getDisplayName()
124 const text = `Hi dear user,\n\n` +
125 `Your ${followType} ${followingName} has a new subscriber: ${followerName}` +
130 const emailPayload: EmailPayload = {
132 subject: 'New follower on your channel ' + followingName,
136 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
139 myVideoPublishedNotification (to: string[], video: VideoModel) {
140 const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath()
142 const text = `Hi dear user,\n\n` +
143 `Your video ${video.name} has been published.` +
145 `You can view it on ${videoUrl} ` +
150 const emailPayload: EmailPayload = {
152 subject: `Your video ${video.name} is published`,
156 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
159 myVideoImportSuccessNotification (to: string[], videoImport: VideoImportModel) {
160 const videoUrl = CONFIG.WEBSERVER.URL + videoImport.Video.getWatchStaticPath()
162 const text = `Hi dear user,\n\n` +
163 `Your video import ${videoImport.getTargetIdentifier()} is finished.` +
165 `You can view the imported video on ${videoUrl} ` +
170 const emailPayload: EmailPayload = {
172 subject: `Your video import ${videoImport.getTargetIdentifier()} is finished`,
176 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
179 myVideoImportErrorNotification (to: string[], videoImport: VideoImportModel) {
180 const importUrl = CONFIG.WEBSERVER.URL + '/my-account/video-imports'
182 const text = `Hi dear user,\n\n` +
183 `Your video import ${videoImport.getTargetIdentifier()} encountered an error.` +
185 `See your videos import dashboard for more information: ${importUrl}` +
190 const emailPayload: EmailPayload = {
192 subject: `Your video import ${videoImport.getTargetIdentifier()} encountered an error`,
196 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
199 addNewCommentOnMyVideoNotification (to: string[], comment: VideoCommentModel) {
200 const accountName = comment.Account.getDisplayName()
201 const video = comment.Video
202 const commentUrl = CONFIG.WEBSERVER.URL + comment.getCommentStaticPath()
204 const text = `Hi dear user,\n\n` +
205 `A new comment has been posted by ${accountName} on your video ${video.name}` +
207 `You can view it on ${commentUrl} ` +
212 const emailPayload: EmailPayload = {
214 subject: 'New comment on your video ' + video.name,
218 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
221 addNewCommentMentionNotification (to: string[], comment: VideoCommentModel) {
222 const accountName = comment.Account.getDisplayName()
223 const video = comment.Video
224 const commentUrl = CONFIG.WEBSERVER.URL + comment.getCommentStaticPath()
226 const text = `Hi dear user,\n\n` +
227 `${accountName} mentioned you on video ${video.name}` +
229 `You can view the comment on ${commentUrl} ` +
234 const emailPayload: EmailPayload = {
236 subject: 'Mention on video ' + video.name,
240 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
243 addVideoAbuseModeratorsNotification (to: string[], videoAbuse: VideoAbuseModel) {
244 const videoUrl = CONFIG.WEBSERVER.URL + videoAbuse.Video.getWatchStaticPath()
246 const text = `Hi,\n\n` +
247 `${CONFIG.WEBSERVER.HOST} received an abuse for the following video ${videoUrl}\n\n` +
251 const emailPayload: EmailPayload = {
253 subject: '[PeerTube] Received a video abuse',
257 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
260 addNewUserRegistrationNotification (to: string[], user: UserModel) {
261 const text = `Hi,\n\n` +
262 `User ${user.username} just registered on ${CONFIG.WEBSERVER.HOST} PeerTube instance.\n\n` +
266 const emailPayload: EmailPayload = {
268 subject: '[PeerTube] New user registration on ' + CONFIG.WEBSERVER.HOST,
272 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
275 addVideoBlacklistNotification (to: string[], videoBlacklist: VideoBlacklistModel) {
276 const videoName = videoBlacklist.Video.name
277 const videoUrl = CONFIG.WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath()
279 const reasonString = videoBlacklist.reason ? ` for the following reason: ${videoBlacklist.reason}` : ''
280 const blockedString = `Your video ${videoName} (${videoUrl} on ${CONFIG.WEBSERVER.HOST} has been blacklisted${reasonString}.`
282 const text = 'Hi,\n\n' +
288 const emailPayload: EmailPayload = {
290 subject: `[PeerTube] Video ${videoName} blacklisted`,
294 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
297 addVideoUnblacklistNotification (to: string[], video: VideoModel) {
298 const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath()
300 const text = 'Hi,\n\n' +
301 `Your video ${video.name} (${videoUrl}) on ${CONFIG.WEBSERVER.HOST} has been unblacklisted.` +
306 const emailPayload: EmailPayload = {
308 subject: `[PeerTube] Video ${video.name} unblacklisted`,
312 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
315 addForgetPasswordEmailJob (to: string, resetPasswordUrl: string) {
316 const text = `Hi dear user,\n\n` +
317 `It seems you forgot your password on ${CONFIG.WEBSERVER.HOST}! ` +
318 `Please follow this link to reset it: ${resetPasswordUrl}\n\n` +
319 `If you are not the person who initiated this request, please ignore this email.\n\n` +
323 const emailPayload: EmailPayload = {
325 subject: 'Reset your PeerTube password',
329 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
332 addVerifyEmailJob (to: string, verifyEmailUrl: string) {
333 const text = `Welcome to PeerTube,\n\n` +
334 `To start using PeerTube on ${CONFIG.WEBSERVER.HOST} you must verify your email! ` +
335 `Please follow this link to verify this email belongs to you: ${verifyEmailUrl}\n\n` +
336 `If you are not the person who initiated this request, please ignore this email.\n\n` +
340 const emailPayload: EmailPayload = {
342 subject: 'Verify your PeerTube email',
346 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
349 addUserBlockJob (user: UserModel, blocked: boolean, reason?: string) {
350 const reasonString = reason ? ` for the following reason: ${reason}` : ''
351 const blockedWord = blocked ? 'blocked' : 'unblocked'
352 const blockedString = `Your account ${user.username} on ${CONFIG.WEBSERVER.HOST} has been ${blockedWord}${reasonString}.`
354 const text = 'Hi,\n\n' +
360 const to = user.email
361 const emailPayload: EmailPayload = {
363 subject: '[PeerTube] Account ' + blockedWord,
367 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
370 addContactFormJob (fromEmail: string, fromName: string, body: string) {
371 const text = 'Hello dear admin,\n\n' +
372 fromName + ' sent you a message' +
373 '\n\n---------------------------------------\n\n' +
375 '\n\n---------------------------------------\n\n' +
379 const emailPayload: EmailPayload = {
381 to: [ CONFIG.ADMIN.EMAIL ],
382 subject: '[PeerTube] Contact form submitted',
386 return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
389 sendMail (to: string[], subject: string, text: string, from?: string) {
390 if (!Emailer.isEnabled()) {
391 throw new Error('Cannot send mail because SMTP is not configured.')
394 return this.transporter.sendMail({
395 from: from || CONFIG.SMTP.FROM_ADDRESS,
402 private dieOnConnectionFailure (err?: Error) {
403 logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, { err })
407 static get Instance () {
408 return this.instance || (this.instance = new this())
412 // ---------------------------------------------------------------------------