X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Femailer.ts;h=73c2bcb1b520bb0cf022b6100ad96c0fd1c037d4;hb=5f189c9c85449951254646ddf6cd6c84bc4c06ff;hp=672414cc0c95ac94ca18d5fb64cd3f6621cd6ac4;hpb=b718fd22374d64534bcfe69932cf562894abed6a;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/emailer.ts b/server/lib/emailer.ts index 672414cc0..73c2bcb1b 100644 --- a/server/lib/emailer.ts +++ b/server/lib/emailer.ts @@ -1,7 +1,7 @@ import { createTransport, Transporter } from 'nodemailer' import { isTestInstance } from '../helpers/core-utils' import { bunyanLogger, logger } from '../helpers/logger' -import { CONFIG } from '../initializers' +import { CONFIG } from '../initializers/config' import { UserModel } from '../models/account/user' import { VideoModel } from '../models/video/video' import { JobQueue } from './job-queue' @@ -12,6 +12,16 @@ import { VideoAbuseModel } from '../models/video/video-abuse' import { VideoBlacklistModel } from '../models/video/video-blacklist' import { VideoImportModel } from '../models/video/video-import' import { ActorFollowModel } from '../models/activitypub/actor-follow' +import { WEBSERVER } from '../initializers/constants' + +type SendEmailOptions = { + to: string[] + subject: string + text: string + + fromDisplayName?: string + replyTo?: string +} class Emailer { @@ -82,7 +92,7 @@ class Emailer { addNewVideoFromSubscriberNotification (to: string[], video: VideoModel) { const channelName = video.VideoChannel.getDisplayName() - const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath() + const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() const text = `Hi dear user,\n\n` + `Your subscription ${channelName} just published a new video: ${video.name}` + @@ -90,11 +100,11 @@ class Emailer { `You can view it on ${videoUrl} ` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: channelName + ' just published a new video', + subject: CONFIG.EMAIL.OBJECT.PREFIX + channelName + ' just published a new video', text } @@ -109,11 +119,29 @@ class Emailer { `Your ${followType} ${followingName} has a new subscriber: ${followerName}` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` + + const emailPayload: EmailPayload = { + to, + subject: CONFIG.EMAIL.OBJECT.PREFIX + 'New follower on your channel ' + followingName, + text + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + + addNewInstanceFollowerNotification (to: string[], actorFollow: ActorFollowModel) { + const awaitingApproval = actorFollow.state === 'pending' ? ' awaiting manual approval.' : '' + + const text = `Hi dear admin,\n\n` + + `Your instance has a new follower: ${actorFollow.ActorFollower.url}${awaitingApproval}` + + `\n\n` + + `Cheers,\n` + + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: 'New follower on your channel ' + followingName, + subject: CONFIG.EMAIL.OBJECT.PREFIX + 'New instance follower', text } @@ -121,7 +149,7 @@ class Emailer { } myVideoPublishedNotification (to: string[], video: VideoModel) { - const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath() + const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() const text = `Hi dear user,\n\n` + `Your video ${video.name} has been published.` + @@ -129,11 +157,11 @@ class Emailer { `You can view it on ${videoUrl} ` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: `Your video ${video.name} is published`, + subject: CONFIG.EMAIL.OBJECT.PREFIX + `Your video ${video.name} is published`, text } @@ -141,7 +169,7 @@ class Emailer { } myVideoImportSuccessNotification (to: string[], videoImport: VideoImportModel) { - const videoUrl = CONFIG.WEBSERVER.URL + videoImport.Video.getWatchStaticPath() + const videoUrl = WEBSERVER.URL + videoImport.Video.getWatchStaticPath() const text = `Hi dear user,\n\n` + `Your video import ${videoImport.getTargetIdentifier()} is finished.` + @@ -149,11 +177,11 @@ class Emailer { `You can view the imported video on ${videoUrl} ` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: `Your video import ${videoImport.getTargetIdentifier()} is finished`, + subject: CONFIG.EMAIL.OBJECT.PREFIX + `Your video import ${videoImport.getTargetIdentifier()} is finished`, text } @@ -161,7 +189,7 @@ class Emailer { } myVideoImportErrorNotification (to: string[], videoImport: VideoImportModel) { - const importUrl = CONFIG.WEBSERVER.URL + '/my-account/video-imports' + const importUrl = WEBSERVER.URL + '/my-account/video-imports' const text = `Hi dear user,\n\n` + `Your video import ${videoImport.getTargetIdentifier()} encountered an error.` + @@ -169,11 +197,11 @@ class Emailer { `See your videos import dashboard for more information: ${importUrl}` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: `Your video import ${videoImport.getTargetIdentifier()} encountered an error`, + subject: CONFIG.EMAIL.OBJECT.PREFIX + `Your video import ${videoImport.getTargetIdentifier()} encountered an error`, text } @@ -183,7 +211,7 @@ class Emailer { addNewCommentOnMyVideoNotification (to: string[], comment: VideoCommentModel) { const accountName = comment.Account.getDisplayName() const video = comment.Video - const commentUrl = CONFIG.WEBSERVER.URL + comment.getCommentStaticPath() + const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath() const text = `Hi dear user,\n\n` + `A new comment has been posted by ${accountName} on your video ${video.name}` + @@ -191,11 +219,11 @@ class Emailer { `You can view it on ${commentUrl} ` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: 'New comment on your video ' + video.name, + subject: CONFIG.EMAIL.OBJECT.PREFIX + 'New comment on your video ' + video.name, text } @@ -205,7 +233,7 @@ class Emailer { addNewCommentMentionNotification (to: string[], comment: VideoCommentModel) { const accountName = comment.Account.getDisplayName() const video = comment.Video - const commentUrl = CONFIG.WEBSERVER.URL + comment.getCommentStaticPath() + const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath() const text = `Hi dear user,\n\n` + `${accountName} mentioned you on video ${video.name}` + @@ -213,11 +241,11 @@ class Emailer { `You can view the comment on ${commentUrl} ` + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: 'Mention on video ' + video.name, + subject: CONFIG.EMAIL.OBJECT.PREFIX + 'Mention on video ' + video.name, text } @@ -225,16 +253,39 @@ class Emailer { } addVideoAbuseModeratorsNotification (to: string[], videoAbuse: VideoAbuseModel) { - const videoUrl = CONFIG.WEBSERVER.URL + videoAbuse.Video.getWatchStaticPath() + const videoUrl = WEBSERVER.URL + videoAbuse.Video.getWatchStaticPath() + + const text = `Hi,\n\n` + + `${WEBSERVER.HOST} received an abuse for the following video ${videoUrl}\n\n` + + `Cheers,\n` + + `${CONFIG.EMAIL.BODY.SIGNATURE}` + + const emailPayload: EmailPayload = { + to, + subject: CONFIG.EMAIL.OBJECT.PREFIX + 'Received a video abuse', + text + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + + addVideoAutoBlacklistModeratorsNotification (to: string[], video: VideoModel) { + const VIDEO_AUTO_BLACKLIST_URL = WEBSERVER.URL + '/admin/moderation/video-auto-blacklist/list' + const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() const text = `Hi,\n\n` + - `${CONFIG.WEBSERVER.HOST} received an abuse for the following video ${videoUrl}\n\n` + + `A recently added video was auto-blacklisted and requires moderator review before publishing.` + + `\n\n` + + `You can view it and take appropriate action on ${videoUrl}` + + `\n\n` + + `A full list of auto-blacklisted videos can be reviewed here: ${VIDEO_AUTO_BLACKLIST_URL}` + + `\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: '[PeerTube] Received a video abuse', + subject: CONFIG.EMAIL.OBJECT.PREFIX + 'An auto-blacklisted video is awaiting review', text } @@ -243,13 +294,13 @@ class Emailer { addNewUserRegistrationNotification (to: string[], user: UserModel) { const text = `Hi,\n\n` + - `User ${user.username} just registered on ${CONFIG.WEBSERVER.HOST} PeerTube instance.\n\n` + + `User ${user.username} just registered on ${WEBSERVER.HOST} PeerTube instance.\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: '[PeerTube] New user registration on ' + CONFIG.WEBSERVER.HOST, + subject: CONFIG.EMAIL.OBJECT.PREFIX + 'New user registration on ' + WEBSERVER.HOST, text } @@ -258,20 +309,20 @@ class Emailer { addVideoBlacklistNotification (to: string[], videoBlacklist: VideoBlacklistModel) { const videoName = videoBlacklist.Video.name - const videoUrl = CONFIG.WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath() + const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath() const reasonString = videoBlacklist.reason ? ` for the following reason: ${videoBlacklist.reason}` : '' - const blockedString = `Your video ${videoName} (${videoUrl} on ${CONFIG.WEBSERVER.HOST} has been blacklisted${reasonString}.` + const blockedString = `Your video ${videoName} (${videoUrl} on ${WEBSERVER.HOST} has been blacklisted${reasonString}.` const text = 'Hi,\n\n' + blockedString + '\n\n' + 'Cheers,\n' + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: `[PeerTube] Video ${videoName} blacklisted`, + subject: CONFIG.EMAIL.OBJECT.PREFIX + `Video ${videoName} blacklisted`, text } @@ -279,17 +330,17 @@ class Emailer { } addVideoUnblacklistNotification (to: string[], video: VideoModel) { - const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath() + const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() const text = 'Hi,\n\n' + - `Your video ${video.name} (${videoUrl}) on ${CONFIG.WEBSERVER.HOST} has been unblacklisted.` + + `Your video ${video.name} (${videoUrl}) on ${WEBSERVER.HOST} has been unblacklisted.` + '\n\n' + 'Cheers,\n' + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: `[PeerTube] Video ${video.name} unblacklisted`, + subject: CONFIG.EMAIL.OBJECT.PREFIX + `Video ${video.name} unblacklisted`, text } @@ -298,15 +349,15 @@ class Emailer { addPasswordResetEmailJob (to: string, resetPasswordUrl: string) { const text = `Hi dear user,\n\n` + - `A reset password procedure for your account ${to} has been requested on ${CONFIG.WEBSERVER.HOST} ` + + `A reset password procedure for your account ${to} has been requested on ${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.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to: [ to ], - subject: 'Reset your PeerTube password', + subject: CONFIG.EMAIL.OBJECT.PREFIX + 'Reset your password', text } @@ -315,15 +366,15 @@ class Emailer { addVerifyEmailJob (to: string, verifyEmailUrl: string) { const text = `Welcome to PeerTube,\n\n` + - `To start using PeerTube on ${CONFIG.WEBSERVER.HOST} you must verify your email! ` + + `To start using PeerTube on ${WEBSERVER.HOST} you must verify your email! ` + `Please follow this link to verify this email belongs to you: ${verifyEmailUrl}\n\n` + `If you are not the person who initiated this request, please ignore this email.\n\n` + `Cheers,\n` + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to: [ to ], - subject: 'Verify your PeerTube email', + subject: CONFIG.EMAIL.OBJECT.PREFIX + 'Verify your email', text } @@ -333,25 +384,25 @@ class Emailer { addUserBlockJob (user: UserModel, blocked: boolean, reason?: string) { const reasonString = reason ? ` for the following reason: ${reason}` : '' const blockedWord = blocked ? 'blocked' : 'unblocked' - const blockedString = `Your account ${user.username} on ${CONFIG.WEBSERVER.HOST} has been ${blockedWord}${reasonString}.` + const blockedString = `Your account ${user.username} on ${WEBSERVER.HOST} has been ${blockedWord}${reasonString}.` const text = 'Hi,\n\n' + blockedString + '\n\n' + 'Cheers,\n' + - `PeerTube.` + `${CONFIG.EMAIL.BODY.SIGNATURE}` const to = user.email const emailPayload: EmailPayload = { to: [ to ], - subject: '[PeerTube] Account ' + blockedWord, + subject: CONFIG.EMAIL.OBJECT.PREFIX + 'Account ' + blockedWord, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addContactFormJob (fromEmail: string, fromName: string, body: string) { + addContactFormJob (fromEmail: string, fromName: string, subject: string, body: string) { const text = 'Hello dear admin,\n\n' + fromName + ' sent you a message' + '\n\n---------------------------------------\n\n' + @@ -361,25 +412,31 @@ class Emailer { 'PeerTube.' const emailPayload: EmailPayload = { - from: fromEmail, + fromDisplayName: fromEmail, + replyTo: fromEmail, to: [ CONFIG.ADMIN.EMAIL ], - subject: '[PeerTube] Contact form submitted', + subject: CONFIG.EMAIL.OBJECT.PREFIX + subject, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - sendMail (to: string[], subject: string, text: string, from?: string) { + sendMail (options: EmailPayload) { if (!Emailer.isEnabled()) { throw new Error('Cannot send mail because SMTP is not configured.') } + const fromDisplayName = options.fromDisplayName + ? options.fromDisplayName + : WEBSERVER.HOST + return this.transporter.sendMail({ - from: from || CONFIG.SMTP.FROM_ADDRESS, - to: to.join(','), - subject, - text + from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`, + replyTo: options.replyTo, + to: options.to.join(','), + subject: options.subject, + text: options.text }) } @@ -396,5 +453,6 @@ class Emailer { // --------------------------------------------------------------------------- export { - Emailer + Emailer, + SendEmailOptions }