import { VideoCommentModel } from '../models/video/video-comment'
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'
class Emailer {
private static instance: Emailer
private initialized = false
private transporter: Transporter
- private enabled = false
private constructor () {}
if (this.initialized === true) return
this.initialized = true
- if (CONFIG.SMTP.HOSTNAME && CONFIG.SMTP.PORT) {
+ if (Emailer.isEnabled()) {
logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT)
let tls
tls,
auth
})
-
- this.enabled = true
} else {
if (!isTestInstance()) {
logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!')
}
}
- isEnabled () {
- return this.enabled
+ static isEnabled () {
+ return !!CONFIG.SMTP.HOSTNAME && !!CONFIG.SMTP.PORT
}
async checkConnectionOrDie () {
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
+ addNewFollowNotification (to: string[], actorFollow: ActorFollowModel, 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` +
+ `Your ${followType} ${followingName} has a new subscriber: ${followerName}` +
+ `\n\n` +
+ `Cheers,\n` +
+ `PeerTube.`
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: 'New follower on your channel ' + followingName,
+ text
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ myVideoPublishedNotification (to: string[], video: VideoModel) {
+ const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath()
+
+ const text = `Hi dear user,\n\n` +
+ `Your video ${video.name} has been published.` +
+ `\n\n` +
+ `You can view it on ${videoUrl} ` +
+ `\n\n` +
+ `Cheers,\n` +
+ `PeerTube.`
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: `Your video ${video.name} is published`,
+ text
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ myVideoImportSuccessNotification (to: string[], videoImport: VideoImportModel) {
+ const videoUrl = CONFIG.WEBSERVER.URL + videoImport.Video.getWatchStaticPath()
+
+ const text = `Hi dear user,\n\n` +
+ `Your video import ${videoImport.getTargetIdentifier()} is finished.` +
+ `\n\n` +
+ `You can view the imported video on ${videoUrl} ` +
+ `\n\n` +
+ `Cheers,\n` +
+ `PeerTube.`
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: `Your video import ${videoImport.getTargetIdentifier()} is finished`,
+ text
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ myVideoImportErrorNotification (to: string[], videoImport: VideoImportModel) {
+ const importUrl = CONFIG.WEBSERVER.URL + '/my-account/video-imports'
+
+ const text = `Hi dear user,\n\n` +
+ `Your video import ${videoImport.getTargetIdentifier()} encountered an error.` +
+ `\n\n` +
+ `See your videos import dashboard for more information: ${importUrl}` +
+ `\n\n` +
+ `Cheers,\n` +
+ `PeerTube.`
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: `Your video import ${videoImport.getTargetIdentifier()} encountered an error`,
+ text
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
addNewCommentOnMyVideoNotification (to: string[], comment: VideoCommentModel) {
const accountName = comment.Account.getDisplayName()
const video = comment.Video
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
- async addVideoAbuseModeratorsNotification (to: string[], videoAbuse: VideoAbuseModel) {
+ addNewCommentMentionNotification (to: string[], comment: VideoCommentModel) {
+ const accountName = comment.Account.getDisplayName()
+ const video = comment.Video
+ const commentUrl = CONFIG.WEBSERVER.URL + comment.getCommentStaticPath()
+
+ const text = `Hi dear user,\n\n` +
+ `${accountName} mentioned you on video ${video.name}` +
+ `\n\n` +
+ `You can view the comment on ${commentUrl} ` +
+ `\n\n` +
+ `Cheers,\n` +
+ `PeerTube.`
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: 'Mention on video ' + video.name,
+ text
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addVideoAbuseModeratorsNotification (to: string[], videoAbuse: VideoAbuseModel) {
const videoUrl = CONFIG.WEBSERVER.URL + videoAbuse.Video.getWatchStaticPath()
const text = `Hi,\n\n` +
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
- async addVideoBlacklistNotification (to: string[], videoBlacklist: VideoBlacklistModel) {
+ addNewUserRegistrationNotification (to: string[], user: UserModel) {
+ const text = `Hi,\n\n` +
+ `User ${user.username} just registered on ${CONFIG.WEBSERVER.HOST} PeerTube instance.\n\n` +
+ `Cheers,\n` +
+ `PeerTube.`
+
+ const emailPayload: EmailPayload = {
+ to,
+ subject: '[PeerTube] New user registration on ' + CONFIG.WEBSERVER.HOST,
+ text
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ addVideoBlacklistNotification (to: string[], videoBlacklist: VideoBlacklistModel) {
const videoName = videoBlacklist.Video.name
const videoUrl = CONFIG.WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath()
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
- async addVideoUnblacklistNotification (to: string[], video: VideoModel) {
+ addVideoUnblacklistNotification (to: string[], video: VideoModel) {
const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath()
const text = 'Hi,\n\n' +
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
- addForgetPasswordEmailJob (to: string, resetPasswordUrl: string) {
+ addPasswordResetEmailJob (to: string, resetPasswordUrl: string) {
const text = `Hi dear user,\n\n` +
- `It seems you forgot your password on ${CONFIG.WEBSERVER.HOST}! ` +
+ `A reset password procedure for your account ${to} has been requested 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` +
return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
}
- sendMail (to: string[], subject: string, text: string) {
- if (!this.enabled) {
+ addContactFormJob (fromEmail: string, fromName: string, body: string) {
+ const text = 'Hello dear admin,\n\n' +
+ fromName + ' sent you a message' +
+ '\n\n---------------------------------------\n\n' +
+ body +
+ '\n\n---------------------------------------\n\n' +
+ 'Cheers,\n' +
+ 'PeerTube.'
+
+ const emailPayload: EmailPayload = {
+ fromDisplayName: fromEmail,
+ replyTo: fromEmail,
+ to: [ CONFIG.ADMIN.EMAIL ],
+ subject: '[PeerTube] Contact form submitted',
+ text
+ }
+
+ return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+ }
+
+ sendMail (options: EmailPayload) {
+ if (!Emailer.isEnabled()) {
throw new Error('Cannot send mail because SMTP is not configured.')
}
+ const fromDisplayName = options.fromDisplayName
+ ? options.fromDisplayName
+ : CONFIG.WEBSERVER.HOST
+
return this.transporter.sendMail({
- 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
})
}