X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Femailer.ts;h=26262972d42e90fc35383991fd22384f6d35dcfa;hb=daaaf3c487f188e54556c6d556d95ee6c2a31bce;hp=a888b7a72ad0f6ac188e4642f893ebaa7aa9bd8e;hpb=0283eaac2a8e73006c66df3cf5bb9012e37450e5;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/emailer.ts b/server/lib/emailer.ts index a888b7a72..26262972d 100644 --- a/server/lib/emailer.ts +++ b/server/lib/emailer.ts @@ -1,13 +1,20 @@ import { createTransport, Transporter } from 'nodemailer' import { isTestInstance } from '../helpers/core-utils' import { bunyanLogger, logger } from '../helpers/logger' -import { CONFIG } from '../initializers/config' +import { CONFIG, isEmailEnabled } from '../initializers/config' import { JobQueue } from './job-queue' import { EmailPayload } from './job-queue/handlers/email' import { readFileSync } from 'fs-extra' import { WEBSERVER } from '../initializers/constants' -import { MCommentOwnerVideo, MVideo, MVideoAbuseVideo, MVideoAccountLight, MVideoBlacklistVideo } from '../typings/models/video' -import { MActorFollowActors, MActorFollowFollowingFullFollowerAccount, MUser } from '../typings/models' +import { + MCommentOwnerVideo, + MVideo, + MVideoAbuseVideo, + MVideoAccountLight, + MVideoBlacklistLightVideo, + MVideoBlacklistVideo +} from '../typings/models/video' +import { MActorFollowActors, MActorFollowFull, MUser } from '../typings/models' import { MVideoImport, MVideoImportVideo } from '@server/typings/models/video/video-import' type SendEmailOptions = { @@ -25,14 +32,15 @@ class Emailer { private initialized = false private transporter: Transporter - private constructor () {} + private constructor () { + } init () { // Already initialized if (this.initialized === true) return this.initialized = true - if (Emailer.isEnabled()) { + if (isEmailEnabled()) { logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT) let tls @@ -90,36 +98,36 @@ class Emailer { const channelName = video.VideoChannel.getDisplayName() const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `Your subscription ${channelName} just published a new video: ${video.name}` + - `\n\n` + + '\n\n' + `You can view it on ${videoUrl} ` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + channelName + ' just published a new video', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + channelName + ' just published a new video', text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addNewFollowNotification (to: string[], actorFollow: MActorFollowFollowingFullFollowerAccount, followType: 'account' | 'channel') { + addNewFollowNotification (to: string[], actorFollow: MActorFollowFull, followType: 'account' | 'channel') { const followerName = actorFollow.ActorFollower.Account.getDisplayName() const followingName = (actorFollow.ActorFollowing.VideoChannel || actorFollow.ActorFollowing.Account).getDisplayName() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `Your ${followType} ${followingName} has a new subscriber: ${followerName}` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + 'New follower on your channel ' + followingName, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New follower on your channel ' + followingName, text } @@ -129,15 +137,31 @@ class Emailer { addNewInstanceFollowerNotification (to: string[], actorFollow: MActorFollowActors) { const awaitingApproval = actorFollow.state === 'pending' ? ' awaiting manual approval.' : '' - const text = `Hi dear admin,\n\n` + + const text = 'Hi dear admin,\n\n' + `Your instance has a new follower: ${actorFollow.ActorFollower.url}${awaitingApproval}` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + 'New instance follower', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New instance follower', + text + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + + addAutoInstanceFollowingNotification (to: string[], actorFollow: MActorFollowActors) { + const text = 'Hi dear admin,\n\n' + + `Your instance automatically followed a new instance: ${actorFollow.ActorFollowing.url}` + + '\n\n' + + 'Cheers,\n' + + `${CONFIG.EMAIL.BODY.SIGNATURE}` + + const emailPayload: EmailPayload = { + to, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Auto instance following', text } @@ -147,17 +171,17 @@ class Emailer { myVideoPublishedNotification (to: string[], video: MVideo) { const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `Your video ${video.name} has been published.` + - `\n\n` + + '\n\n' + `You can view it on ${videoUrl} ` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + `Your video ${video.name} is published`, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Your video ${video.name} is published`, text } @@ -167,17 +191,17 @@ class Emailer { myVideoImportSuccessNotification (to: string[], videoImport: MVideoImportVideo) { const videoUrl = WEBSERVER.URL + videoImport.Video.getWatchStaticPath() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `Your video import ${videoImport.getTargetIdentifier()} is finished.` + - `\n\n` + + '\n\n' + `You can view the imported video on ${videoUrl} ` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + `Your video import ${videoImport.getTargetIdentifier()} is finished`, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Your video import ${videoImport.getTargetIdentifier()} is finished`, text } @@ -187,17 +211,17 @@ class Emailer { myVideoImportErrorNotification (to: string[], videoImport: MVideoImport) { const importUrl = WEBSERVER.URL + '/my-account/video-imports' - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `Your video import ${videoImport.getTargetIdentifier()} encountered an error.` + - `\n\n` + + '\n\n' + `See your videos import dashboard for more information: ${importUrl}` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + `Your video import ${videoImport.getTargetIdentifier()} encountered an error`, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Your video import ${videoImport.getTargetIdentifier()} encountered an error`, text } @@ -209,17 +233,17 @@ class Emailer { const video = comment.Video const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `A new comment has been posted by ${accountName} on your video ${video.name}` + - `\n\n` + + '\n\n' + `You can view it on ${commentUrl} ` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + 'New comment on your video ' + video.name, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New comment on your video ' + video.name, text } @@ -231,17 +255,17 @@ class Emailer { const video = comment.Video const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `${accountName} mentioned you on video ${video.name}` + - `\n\n` + + '\n\n' + `You can view the comment on ${commentUrl} ` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + 'Mention on video ' + video.name, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Mention on video ' + video.name, text } @@ -251,37 +275,37 @@ class Emailer { addVideoAbuseModeratorsNotification (to: string[], videoAbuse: MVideoAbuseVideo) { const videoUrl = WEBSERVER.URL + videoAbuse.Video.getWatchStaticPath() - const text = `Hi,\n\n` + + const text = 'Hi,\n\n' + `${WEBSERVER.HOST} received an abuse for the following video ${videoUrl}\n\n` + - `Cheers,\n` + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + 'Received a video abuse', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Received a video abuse', text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addVideoAutoBlacklistModeratorsNotification (to: string[], video: MVideo) { + addVideoAutoBlacklistModeratorsNotification (to: string[], videoBlacklist: MVideoBlacklistLightVideo) { const VIDEO_AUTO_BLACKLIST_URL = WEBSERVER.URL + '/admin/moderation/video-auto-blacklist/list' - const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() + const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath() - const text = `Hi,\n\n` + - `A recently added video was auto-blacklisted and requires moderator review before publishing.` + - `\n\n` + + const text = 'Hi,\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` + + '\n\n' + `A full list of auto-blacklisted videos can be reviewed here: ${VIDEO_AUTO_BLACKLIST_URL}` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + 'An auto-blacklisted video is awaiting review', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'An auto-blacklisted video is awaiting review', text } @@ -289,14 +313,14 @@ class Emailer { } addNewUserRegistrationNotification (to: string[], user: MUser) { - const text = `Hi,\n\n` + + const text = 'Hi,\n\n' + `User ${user.username} just registered on ${WEBSERVER.HOST} PeerTube instance.\n\n` + - `Cheers,\n` + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + 'New user registration on ' + WEBSERVER.HOST, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New user registration on ' + WEBSERVER.HOST, text } @@ -318,7 +342,7 @@ class Emailer { const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + `Video ${videoName} blacklisted`, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Video ${videoName} blacklisted`, text } @@ -336,7 +360,7 @@ class Emailer { const emailPayload: EmailPayload = { to, - subject: CONFIG.EMAIL.OBJECT.PREFIX + `Video ${video.name} unblacklisted`, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Video ${video.name} unblacklisted`, text } @@ -344,16 +368,32 @@ class Emailer { } addPasswordResetEmailJob (to: string, resetPasswordUrl: string) { - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `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` + + `Please follow this link to reset it: ${resetPasswordUrl} (the link will expire within 1 hour)\n\n` + + 'If you are not the person who initiated this request, please ignore this email.\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to: [ to ], - subject: CONFIG.EMAIL.OBJECT.PREFIX + 'Reset your password', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Reset your password', + text + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + + addPasswordCreateEmailJob (username: string, to: string, resetPasswordUrl: string) { + const text = 'Hi,\n\n' + + `Welcome to your ${WEBSERVER.HOST} PeerTube instance. Your username is: ${username}.\n\n` + + `Please set your password by following this link: ${resetPasswordUrl} (this link will expire within seven days).\n\n` + + 'Cheers,\n' + + `${CONFIG.EMAIL.BODY.SIGNATURE}` + + const emailPayload: EmailPayload = { + to: [ to ], + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New PeerTube account password', text } @@ -361,16 +401,16 @@ class Emailer { } addVerifyEmailJob (to: string, verifyEmailUrl: string) { - const text = `Welcome to PeerTube,\n\n` + + const text = 'Welcome to PeerTube,\n\n' + `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` + + 'If you are not the person who initiated this request, please ignore this email.\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { to: [ to ], - subject: CONFIG.EMAIL.OBJECT.PREFIX + 'Verify your email', + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Verify your email', text } @@ -391,7 +431,7 @@ class Emailer { const to = user.email const emailPayload: EmailPayload = { to: [ to ], - subject: CONFIG.EMAIL.OBJECT.PREFIX + 'Account ' + blockedWord, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Account ' + blockedWord, text } @@ -411,15 +451,15 @@ class Emailer { fromDisplayName: fromEmail, replyTo: fromEmail, to: [ CONFIG.ADMIN.EMAIL ], - subject: CONFIG.EMAIL.OBJECT.PREFIX + subject, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + subject, text } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - sendMail (options: EmailPayload) { - if (!Emailer.isEnabled()) { + async sendMail (options: EmailPayload) { + if (!isEmailEnabled()) { throw new Error('Cannot send mail because SMTP is not configured.') } @@ -427,13 +467,15 @@ class Emailer { ? options.fromDisplayName : WEBSERVER.HOST - return this.transporter.sendMail({ - from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`, - replyTo: options.replyTo, - to: options.to.join(','), - subject: options.subject, - text: options.text - }) + for (const to of options.to) { + await this.transporter.sendMail({ + from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`, + replyTo: options.replyTo, + to, + subject: options.subject, + text: options.text + }) + } } private dieOnConnectionFailure (err?: Error) {