Add files via upload
This commit is contained in:
GitHub
parent
630ca11228
commit
7bc9aee861
1 changed files with 924 additions and 0 deletions
924
overleafserver/EmailBuilder.js
Normal file
924
overleafserver/EmailBuilder.js
Normal file
|
|
@ -0,0 +1,924 @@
|
|||
const _ = require('lodash')
|
||||
const settings = require('@overleaf/settings')
|
||||
const moment = require('moment')
|
||||
const EmailMessageHelper = require('./EmailMessageHelper')
|
||||
const StringHelper = require('../Helpers/StringHelper')
|
||||
const BaseWithHeaderEmailLayout = require('./Layouts/BaseWithHeaderEmailLayout')
|
||||
const SpamSafe = require('./SpamSafe')
|
||||
const ctaEmailBody = require('./Bodies/cta-email')
|
||||
const NoCTAEmailBody = require('./Bodies/NoCTAEmailBody')
|
||||
|
||||
function _emailBodyPlainText(content, opts, ctaEmail) {
|
||||
let emailBody = `${content.greeting(opts, true)}`
|
||||
emailBody += `\r\n\r\n`
|
||||
emailBody += `${content.message(opts, true).join('\r\n\r\n')}`
|
||||
|
||||
if (ctaEmail) {
|
||||
emailBody += `\r\n\r\n`
|
||||
emailBody += `${content.ctaText(opts, true)}: ${content.ctaURL(opts, true)}`
|
||||
}
|
||||
|
||||
if (
|
||||
content.secondaryMessage(opts, true) &&
|
||||
content.secondaryMessage(opts, true).length > 0
|
||||
) {
|
||||
emailBody += `\r\n\r\n`
|
||||
emailBody += `${content.secondaryMessage(opts, true).join('\r\n\r\n')}`
|
||||
}
|
||||
|
||||
emailBody += `\r\n\r\n`
|
||||
emailBody += `Regards,\r\nThe ${settings.appName} Team - ${settings.siteUrl}`
|
||||
|
||||
if (
|
||||
settings.email &&
|
||||
settings.email.template &&
|
||||
settings.email.template.customFooter
|
||||
) {
|
||||
emailBody += `\r\n\r\n`
|
||||
emailBody += settings.email.template.customFooter
|
||||
}
|
||||
|
||||
return emailBody
|
||||
}
|
||||
|
||||
function ctaTemplate(content) {
|
||||
if (
|
||||
!content.ctaURL ||
|
||||
!content.ctaText ||
|
||||
!content.message ||
|
||||
!content.subject
|
||||
) {
|
||||
throw new Error('missing required CTA email content')
|
||||
}
|
||||
if (!content.title) {
|
||||
content.title = () => {}
|
||||
}
|
||||
if (!content.greeting) {
|
||||
content.greeting = () => 'Hi,'
|
||||
}
|
||||
if (!content.secondaryMessage) {
|
||||
content.secondaryMessage = () => []
|
||||
}
|
||||
if (!content.gmailGoToAction) {
|
||||
content.gmailGoToAction = () => {}
|
||||
}
|
||||
return {
|
||||
subject(opts) {
|
||||
return content.subject(opts)
|
||||
},
|
||||
layout: BaseWithHeaderEmailLayout,
|
||||
plainTextTemplate(opts) {
|
||||
return _emailBodyPlainText(content, opts, true)
|
||||
},
|
||||
compiledTemplate(opts) {
|
||||
return ctaEmailBody({
|
||||
title: content.title(opts),
|
||||
greeting: content.greeting(opts),
|
||||
message: content.message(opts),
|
||||
secondaryMessage: content.secondaryMessage(opts),
|
||||
ctaText: content.ctaText(opts),
|
||||
ctaURL: content.ctaURL(opts),
|
||||
gmailGoToAction: content.gmailGoToAction(opts),
|
||||
StringHelper,
|
||||
})
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
function NoCTAEmailTemplate(content) {
|
||||
if (content.greeting == null) {
|
||||
content.greeting = () => 'Hi,'
|
||||
}
|
||||
if (!content.message) {
|
||||
throw new Error('missing message')
|
||||
}
|
||||
return {
|
||||
subject(opts) {
|
||||
return content.subject(opts)
|
||||
},
|
||||
layout: BaseWithHeaderEmailLayout,
|
||||
plainTextTemplate(opts) {
|
||||
return `\
|
||||
${content.greeting(opts)}
|
||||
|
||||
${content.message(opts, true).join('\r\n\r\n')}
|
||||
|
||||
Regards,
|
||||
The ${settings.appName} Team - ${settings.siteUrl}\
|
||||
`
|
||||
},
|
||||
compiledTemplate(opts) {
|
||||
return NoCTAEmailBody({
|
||||
title:
|
||||
typeof content.title === 'function' ? content.title(opts) : undefined,
|
||||
greeting: content.greeting(opts),
|
||||
highlightedText:
|
||||
typeof content.highlightedText === 'function'
|
||||
? content.highlightedText(opts)
|
||||
: undefined,
|
||||
message: content.message(opts),
|
||||
StringHelper,
|
||||
})
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
function buildEmail(templateName, opts) {
|
||||
const template = templates[templateName]
|
||||
opts.siteUrl = settings.siteUrl
|
||||
opts.body = template.compiledTemplate(opts)
|
||||
return {
|
||||
subject: template.subject(opts),
|
||||
html: template.layout(opts),
|
||||
text: template.plainTextTemplate && template.plainTextTemplate(opts),
|
||||
}
|
||||
}
|
||||
|
||||
const templates = {}
|
||||
|
||||
templates.registered = ctaTemplate({
|
||||
subject() {
|
||||
return `Activate your ${settings.appName} Account`
|
||||
},
|
||||
message(opts) {
|
||||
return [
|
||||
`Congratulations, you've just had an account created for you on ${
|
||||
settings.appName
|
||||
} with the email address '${_.escape(opts.to)}'.`,
|
||||
'Click here to set your password and log in:',
|
||||
]
|
||||
},
|
||||
secondaryMessage() {
|
||||
return [
|
||||
`If you have any questions or problems, please contact ${settings.adminEmail}`,
|
||||
]
|
||||
},
|
||||
ctaText() {
|
||||
return 'Set password'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.setNewPasswordUrl
|
||||
},
|
||||
})
|
||||
|
||||
templates.canceledSubscription = ctaTemplate({
|
||||
subject() {
|
||||
return `${settings.appName} thoughts`
|
||||
},
|
||||
message() {
|
||||
return [
|
||||
`We are sorry to see you cancelled your ${settings.appName} premium subscription. Would you mind giving us some feedback on what the site is lacking at the moment via this quick survey?`,
|
||||
]
|
||||
},
|
||||
secondaryMessage() {
|
||||
return ['Thank you in advance!']
|
||||
},
|
||||
ctaText() {
|
||||
return 'Leave Feedback'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return 'https://docs.google.com/forms/d/e/1FAIpQLSfa7z_s-cucRRXm70N4jEcSbFsZeb0yuKThHGQL8ySEaQzF0Q/viewform?usp=sf_link'
|
||||
},
|
||||
})
|
||||
|
||||
templates.reactivatedSubscription = ctaTemplate({
|
||||
subject() {
|
||||
return `Subscription Reactivated - ${settings.appName}`
|
||||
},
|
||||
message(opts) {
|
||||
return ['Your subscription was reactivated successfully.']
|
||||
},
|
||||
ctaText() {
|
||||
return 'View Subscription Dashboard'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return `${settings.siteUrl}/user/subscription`
|
||||
},
|
||||
})
|
||||
|
||||
templates.passwordResetRequested = ctaTemplate({
|
||||
subject() {
|
||||
return `Password Reset - ${settings.appName}`
|
||||
},
|
||||
title() {
|
||||
return 'Password Reset'
|
||||
},
|
||||
message() {
|
||||
return [`We got a request to reset your ${settings.appName} password.`]
|
||||
},
|
||||
secondaryMessage() {
|
||||
return [
|
||||
"If you ignore this message, your password won't be changed.",
|
||||
"If you didn't request a password reset, let us know.",
|
||||
]
|
||||
},
|
||||
ctaText() {
|
||||
return 'Reset password'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.setNewPasswordUrl
|
||||
},
|
||||
})
|
||||
|
||||
templates.confirmEmail = ctaTemplate({
|
||||
subject() {
|
||||
return `Confirm Email - ${settings.appName}`
|
||||
},
|
||||
title() {
|
||||
return 'Confirm Email'
|
||||
},
|
||||
message(opts) {
|
||||
return [
|
||||
`Please confirm that you have added a new email, ${opts.to}, to your ${settings.appName} account.`,
|
||||
]
|
||||
},
|
||||
secondaryMessage() {
|
||||
return [
|
||||
`If you did not request this, please let us know at <a href="mailto:${settings.adminEmail}">${settings.adminEmail}</a>.`,
|
||||
`If you have any questions or trouble confirming your email address, please get in touch with our support team at ${settings.adminEmail}.`,
|
||||
]
|
||||
},
|
||||
ctaText() {
|
||||
return 'Confirm Email'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.confirmEmailUrl
|
||||
},
|
||||
})
|
||||
|
||||
templates.confirmCode = NoCTAEmailTemplate({
|
||||
greeting(opts) {
|
||||
return ''
|
||||
},
|
||||
subject(opts) {
|
||||
return `Confirm your email address on Overleaf (${opts.confirmCode})`
|
||||
},
|
||||
title(opts) {
|
||||
return 'Confirm your email address'
|
||||
},
|
||||
message(opts, isPlainText) {
|
||||
const msg = [
|
||||
`Welcome to Overleaf! We're so glad you joined us.`,
|
||||
'Use this 6-digit confirmation code to finish your setup.',
|
||||
]
|
||||
|
||||
if (isPlainText && opts.confirmCode) {
|
||||
msg.push(opts.confirmCode)
|
||||
}
|
||||
return msg
|
||||
},
|
||||
highlightedText(opts) {
|
||||
return opts.confirmCode
|
||||
},
|
||||
})
|
||||
|
||||
templates.projectInvite = ctaTemplate({
|
||||
subject(opts) {
|
||||
const safeName = SpamSafe.isSafeProjectName(opts.project.name)
|
||||
const safeEmail = SpamSafe.isSafeEmail(opts.owner.email)
|
||||
|
||||
if (safeName && safeEmail) {
|
||||
return `"${_.escape(opts.project.name)}" — shared by ${_.escape(
|
||||
opts.owner.email
|
||||
)}`
|
||||
}
|
||||
if (safeName) {
|
||||
return `${settings.appName} project shared with you — "${_.escape(
|
||||
opts.project.name
|
||||
)}"`
|
||||
}
|
||||
if (safeEmail) {
|
||||
return `${_.escape(opts.owner.email)} shared an ${
|
||||
settings.appName
|
||||
} project with you`
|
||||
}
|
||||
|
||||
return `An ${settings.appName} project has been shared with you`
|
||||
},
|
||||
title(opts) {
|
||||
return 'Project Invite'
|
||||
},
|
||||
greeting(opts) {
|
||||
return ''
|
||||
},
|
||||
message(opts, isPlainText) {
|
||||
// build message depending on spam-safe variables
|
||||
const message = [`You have been invited to an ${settings.appName} project.`]
|
||||
|
||||
if (SpamSafe.isSafeProjectName(opts.project.name)) {
|
||||
message.push('<br/> Project:')
|
||||
message.push(`<b>${_.escape(opts.project.name)}</b>`)
|
||||
}
|
||||
|
||||
if (SpamSafe.isSafeEmail(opts.owner.email)) {
|
||||
message.push(`<br/> Shared by:`)
|
||||
message.push(`<b>${_.escape(opts.owner.email)}</b>`)
|
||||
}
|
||||
|
||||
if (message.length === 1) {
|
||||
message.push('<br/> Please view the project to find out more.')
|
||||
}
|
||||
|
||||
return message.map(m => {
|
||||
return EmailMessageHelper.cleanHTML(m, isPlainText)
|
||||
})
|
||||
},
|
||||
ctaText() {
|
||||
return 'View project'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.inviteUrl
|
||||
},
|
||||
gmailGoToAction(opts) {
|
||||
return {
|
||||
target: opts.inviteUrl,
|
||||
name: 'View project',
|
||||
description: `Join ${_.escape(
|
||||
SpamSafe.safeProjectName(opts.project.name, 'project')
|
||||
)} at ${settings.appName}`,
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
templates.reconfirmEmail = ctaTemplate({
|
||||
subject() {
|
||||
return `Reconfirm Email - ${settings.appName}`
|
||||
},
|
||||
title() {
|
||||
return 'Reconfirm Email'
|
||||
},
|
||||
message(opts) {
|
||||
return [
|
||||
`Please reconfirm your email address, ${opts.to}, on your ${settings.appName} account.`,
|
||||
]
|
||||
},
|
||||
secondaryMessage() {
|
||||
return [
|
||||
'If you did not request this, you can simply ignore this message.',
|
||||
`If you have any questions or trouble confirming your email address, please get in touch with our support team at ${settings.adminEmail}.`,
|
||||
]
|
||||
},
|
||||
ctaText() {
|
||||
return 'Reconfirm Email'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.confirmEmailUrl
|
||||
},
|
||||
})
|
||||
|
||||
templates.verifyEmailToJoinTeam = ctaTemplate({
|
||||
subject(opts) {
|
||||
return `${opts.reminder ? 'Reminder: ' : ''}${_.escape(
|
||||
_formatUserNameAndEmail(opts.inviter, 'A collaborator')
|
||||
)} has invited you to join a group subscription on ${settings.appName}`
|
||||
},
|
||||
title(opts) {
|
||||
return `${opts.reminder ? 'Reminder: ' : ''}${_.escape(
|
||||
_formatUserNameAndEmail(opts.inviter, 'A collaborator')
|
||||
)} has invited you to join a group subscription on ${settings.appName}`
|
||||
},
|
||||
message(opts) {
|
||||
return [
|
||||
`Please click the button below to join the group subscription and enjoy the benefits of an upgraded ${settings.appName} account.`,
|
||||
]
|
||||
},
|
||||
ctaText(opts) {
|
||||
return 'Join now'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.acceptInviteUrl
|
||||
},
|
||||
})
|
||||
|
||||
templates.verifyEmailToJoinManagedUsers = ctaTemplate({
|
||||
subject(opts) {
|
||||
return `${
|
||||
opts.reminder ? 'Reminder: ' : ''
|
||||
}You’ve been invited by ${_.escape(
|
||||
_formatUserNameAndEmail(opts.inviter, 'a collaborator')
|
||||
)} to join an ${settings.appName} group subscription.`
|
||||
},
|
||||
title(opts) {
|
||||
return `${
|
||||
opts.reminder ? 'Reminder: ' : ''
|
||||
}You’ve been invited by ${_.escape(
|
||||
_formatUserNameAndEmail(opts.inviter, 'a collaborator')
|
||||
)} to join an ${settings.appName} group subscription.`
|
||||
},
|
||||
message(opts) {
|
||||
return [
|
||||
`By joining this group, you'll have access to ${settings.appName} premium features such as additional collaborators, greater maximum compile time, and real-time track changes.`,
|
||||
]
|
||||
},
|
||||
secondaryMessage(opts, isPlainText) {
|
||||
const changeProjectOwnerLink = EmailMessageHelper.displayLink(
|
||||
'change project owner',
|
||||
`${settings.siteUrl}/learn/how-to/How_to_Transfer_Project_Ownership`,
|
||||
isPlainText
|
||||
)
|
||||
|
||||
return [
|
||||
`<b>User accounts in this group are managed by ${_.escape(
|
||||
_formatUserNameAndEmail(opts.admin, 'an admin')
|
||||
)}</b>`,
|
||||
`If you accept, you’ll transfer the management of your ${settings.appName} account to the owner of the group subscription, who will then have admin rights over your account and control over your stuff.`,
|
||||
`If you have personal projects in your ${settings.appName} account that you want to keep separate, that’s not a problem. You can set up another account under a personal email address and change the ownership of your personal projects to the new account. Find out how to ${changeProjectOwnerLink}.`,
|
||||
]
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.acceptInviteUrl
|
||||
},
|
||||
ctaText(opts) {
|
||||
return 'Accept invitation'
|
||||
},
|
||||
greeting() {
|
||||
return ''
|
||||
},
|
||||
})
|
||||
|
||||
templates.inviteNewUserToJoinManagedUsers = ctaTemplate({
|
||||
subject(opts) {
|
||||
return `${
|
||||
opts.reminder ? 'Reminder: ' : ''
|
||||
}You’ve been invited by ${_.escape(
|
||||
_formatUserNameAndEmail(opts.inviter, 'a collaborator')
|
||||
)} to join an ${settings.appName} group subscription.`
|
||||
},
|
||||
title(opts) {
|
||||
return `${
|
||||
opts.reminder ? 'Reminder: ' : ''
|
||||
}You’ve been invited by ${_.escape(
|
||||
_formatUserNameAndEmail(opts.inviter, 'a collaborator')
|
||||
)} to join an ${settings.appName} group subscription.`
|
||||
},
|
||||
message(opts) {
|
||||
return ['']
|
||||
},
|
||||
secondaryMessage(opts) {
|
||||
return [
|
||||
`<b>User accounts in this group are managed by ${_.escape(
|
||||
_formatUserNameAndEmail(opts.admin, 'an admin')
|
||||
)}.</b>`,
|
||||
`If you accept, the owner of the group subscription will have admin rights over your account and control over your stuff.`,
|
||||
`<b>What is ${settings.appName}?</b>`,
|
||||
`${settings.appName} is the collaborative online LaTeX editor loved by researchers and technical writers. With thousands of ready-to-use templates and an array of LaTeX learning resources you’ll be up and running in no time.`,
|
||||
]
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.acceptInviteUrl
|
||||
},
|
||||
ctaText(opts) {
|
||||
return 'Accept invitation'
|
||||
},
|
||||
greeting() {
|
||||
return ''
|
||||
},
|
||||
})
|
||||
|
||||
templates.groupSSOLinkingInvite = ctaTemplate({
|
||||
subject(opts) {
|
||||
const subjectPrefix = opts.reminder ? 'Reminder: ' : 'Action required: '
|
||||
return `${subjectPrefix}Authenticate your Overleaf account`
|
||||
},
|
||||
title(opts) {
|
||||
const titlePrefix = opts.reminder ? 'Reminder: ' : ''
|
||||
return `${titlePrefix}Single sign-on enabled`
|
||||
},
|
||||
message(opts) {
|
||||
return [
|
||||
`Hi,
|
||||
<div>
|
||||
Your group administrator has enabled single sign-on for your group.
|
||||
</div>
|
||||
</br>
|
||||
<div>
|
||||
<strong>What does this mean for you?</strong>
|
||||
</div>
|
||||
</br>
|
||||
<div>
|
||||
You won't need to remember a separate email address and password to sign in to Overleaf.
|
||||
All you need to do is authenticate your existing Overleaf account with your SSO provider.
|
||||
</div>
|
||||
`,
|
||||
]
|
||||
},
|
||||
secondaryMessage(opts) {
|
||||
return [``]
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.authenticateWithSSO
|
||||
},
|
||||
ctaText(opts) {
|
||||
return 'Authenticate with SSO'
|
||||
},
|
||||
greeting() {
|
||||
return ''
|
||||
},
|
||||
})
|
||||
|
||||
templates.groupSSODisabled = ctaTemplate({
|
||||
subject(opts) {
|
||||
return `Action required: Set your Overleaf password`
|
||||
},
|
||||
title(opts) {
|
||||
return `Single sign-on disabled`
|
||||
},
|
||||
message(opts) {
|
||||
return [
|
||||
`Hi,
|
||||
<div>
|
||||
Your group administrator has disabled single sign-on for your group.
|
||||
</div>
|
||||
</br>
|
||||
<div>
|
||||
<strong>What does this mean for you?</strong>
|
||||
</div>
|
||||
</br>
|
||||
<div>
|
||||
You now need an email address and password to sign in to your Overleaf account.
|
||||
</div>
|
||||
`,
|
||||
]
|
||||
},
|
||||
secondaryMessage(opts) {
|
||||
return [``]
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.setNewPasswordUrl
|
||||
},
|
||||
ctaText(opts) {
|
||||
return 'Set your new password'
|
||||
},
|
||||
greeting() {
|
||||
return ''
|
||||
},
|
||||
})
|
||||
|
||||
templates.surrenderAccountForManagedUsers = ctaTemplate({
|
||||
subject(opts) {
|
||||
const admin = _.escape(_formatUserNameAndEmail(opts.admin, 'an admin'))
|
||||
|
||||
const toGroupName = opts.groupName ? ` to ${opts.groupName}` : ''
|
||||
|
||||
return `${
|
||||
opts.reminder ? 'Reminder: ' : ''
|
||||
}You’ve been invited by ${admin} to transfer management of your ${
|
||||
settings.appName
|
||||
} account${toGroupName}`
|
||||
},
|
||||
title(opts) {
|
||||
const admin = _.escape(_formatUserNameAndEmail(opts.admin, 'an admin'))
|
||||
|
||||
const toGroupName = opts.groupName ? ` to ${opts.groupName}` : ''
|
||||
|
||||
return `${
|
||||
opts.reminder ? 'Reminder: ' : ''
|
||||
}You’ve been invited by ${admin} to transfer management of your ${
|
||||
settings.appName
|
||||
} account${toGroupName}`
|
||||
},
|
||||
message(opts, isPlainText) {
|
||||
const admin = _.escape(_formatUserNameAndEmail(opts.admin, 'an admin'))
|
||||
|
||||
const managedUsersLink = EmailMessageHelper.displayLink(
|
||||
'user account management',
|
||||
`${settings.siteUrl}/learn/how-to/Understanding_Managed_Overleaf_Accounts`,
|
||||
isPlainText
|
||||
)
|
||||
|
||||
return [
|
||||
`Your ${settings.appName} account ${_.escape(
|
||||
opts.to
|
||||
)} is part of ${admin}'s group. They’ve now enabled ${managedUsersLink} for the group. This will ensure that projects aren’t lost when someone leaves the group.`,
|
||||
]
|
||||
},
|
||||
secondaryMessage(opts, isPlainText) {
|
||||
const transferProjectOwnershipLink = EmailMessageHelper.displayLink(
|
||||
'change project owner',
|
||||
`${settings.siteUrl}/learn/how-to/How_to_Transfer_Project_Ownership`,
|
||||
isPlainText
|
||||
)
|
||||
|
||||
return [
|
||||
`<b>What does this mean for you?</b>`,
|
||||
`If you accept, you’ll transfer the management of your ${settings.appName} account to the owner of the group subscription, who will then have admin rights over your account and control over your stuff.`,
|
||||
`If you have personal projects in your ${settings.appName} account that you want to keep separate, that’s not a problem. You can set up another account under a personal email address and change the ownership of your personal projects to the new account. Find out how to ${transferProjectOwnershipLink}.`,
|
||||
`If you think this invitation has been sent in error please contact your group administrator.`,
|
||||
]
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.acceptInviteUrl
|
||||
},
|
||||
ctaText(opts) {
|
||||
return 'Accept invitation'
|
||||
},
|
||||
greeting() {
|
||||
return ''
|
||||
},
|
||||
})
|
||||
|
||||
templates.testEmail = ctaTemplate({
|
||||
subject() {
|
||||
return `A Test Email from ${settings.appName}`
|
||||
},
|
||||
title() {
|
||||
return `A Test Email from ${settings.appName}`
|
||||
},
|
||||
greeting() {
|
||||
return 'Hi,'
|
||||
},
|
||||
message() {
|
||||
return [`This is a test Email from ${settings.appName}`]
|
||||
},
|
||||
ctaText() {
|
||||
return `Open ${settings.appName}`
|
||||
},
|
||||
ctaURL() {
|
||||
return settings.siteUrl
|
||||
},
|
||||
})
|
||||
|
||||
templates.ownershipTransferConfirmationPreviousOwner = NoCTAEmailTemplate({
|
||||
subject(opts) {
|
||||
return `Project ownership transfer - ${settings.appName}`
|
||||
},
|
||||
title(opts) {
|
||||
const projectName = _.escape(
|
||||
SpamSafe.safeProjectName(opts.project.name, 'Your project')
|
||||
)
|
||||
return `${projectName} - Owner change`
|
||||
},
|
||||
message(opts, isPlainText) {
|
||||
const nameAndEmail = _.escape(
|
||||
_formatUserNameAndEmail(opts.newOwner, 'a collaborator')
|
||||
)
|
||||
const projectName = _.escape(
|
||||
SpamSafe.safeProjectName(opts.project.name, 'your project')
|
||||
)
|
||||
const projectNameDisplay = isPlainText
|
||||
? projectName
|
||||
: `<b>${projectName}</b>`
|
||||
return [
|
||||
`As per your request, we have made ${nameAndEmail} the owner of ${projectNameDisplay}.`,
|
||||
`If you haven't asked to change the owner of ${projectNameDisplay}, please get in touch with us via ${settings.adminEmail}.`,
|
||||
]
|
||||
},
|
||||
})
|
||||
|
||||
templates.ownershipTransferConfirmationNewOwner = ctaTemplate({
|
||||
subject(opts) {
|
||||
return `Project ownership transfer - ${settings.appName}`
|
||||
},
|
||||
title(opts) {
|
||||
const projectName = _.escape(
|
||||
SpamSafe.safeProjectName(opts.project.name, 'Your project')
|
||||
)
|
||||
return `${projectName} - Owner change`
|
||||
},
|
||||
message(opts, isPlainText) {
|
||||
const nameAndEmail = _.escape(
|
||||
_formatUserNameAndEmail(opts.previousOwner, 'A collaborator')
|
||||
)
|
||||
const projectName = _.escape(
|
||||
SpamSafe.safeProjectName(opts.project.name, 'a project')
|
||||
)
|
||||
const projectNameEmphasized = isPlainText
|
||||
? projectName
|
||||
: `<b>${projectName}</b>`
|
||||
return [
|
||||
`${nameAndEmail} has made you the owner of ${projectNameEmphasized}. You can now manage ${projectName} sharing settings.`,
|
||||
]
|
||||
},
|
||||
ctaText(opts) {
|
||||
return 'View project'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
const projectUrl = `${
|
||||
settings.siteUrl
|
||||
}/project/${opts.project._id.toString()}`
|
||||
return projectUrl
|
||||
},
|
||||
})
|
||||
|
||||
templates.userOnboardingEmail = NoCTAEmailTemplate({
|
||||
subject(opts) {
|
||||
return `Getting more out of ${settings.appName}`
|
||||
},
|
||||
greeting(opts) {
|
||||
return ''
|
||||
},
|
||||
title(opts) {
|
||||
return `Getting more out of ${settings.appName}`
|
||||
},
|
||||
message(opts, isPlainText) {
|
||||
const learnLatexLink = EmailMessageHelper.displayLink(
|
||||
'Learn LaTeX in 30 minutes',
|
||||
`${settings.siteUrl}/learn/latex/Learn_LaTeX_in_30_minutes?utm_source=overleaf&utm_medium=email&utm_campaign=onboarding`,
|
||||
isPlainText
|
||||
)
|
||||
const templatesLinks = EmailMessageHelper.displayLink(
|
||||
'Find a beautiful template',
|
||||
`${settings.siteUrl}/latex/templates?utm_source=overleaf&utm_medium=email&utm_campaign=onboarding`,
|
||||
isPlainText
|
||||
)
|
||||
const collaboratorsLink = EmailMessageHelper.displayLink(
|
||||
'Work with your collaborators',
|
||||
`${settings.siteUrl}/learn/how-to/Sharing_a_project?utm_source=overleaf&utm_medium=email&utm_campaign=onboarding`,
|
||||
isPlainText
|
||||
)
|
||||
const siteLink = EmailMessageHelper.displayLink(
|
||||
'www.overleaf.com',
|
||||
settings.siteUrl,
|
||||
isPlainText
|
||||
)
|
||||
const userSettingsLink = EmailMessageHelper.displayLink(
|
||||
'here',
|
||||
`${settings.siteUrl}/user/email-preferences`,
|
||||
isPlainText
|
||||
)
|
||||
const onboardingSurveyLink = EmailMessageHelper.displayLink(
|
||||
'Join our user feedback program',
|
||||
'https://forms.gle/DB7pdk2B1VFQqVVB9',
|
||||
isPlainText
|
||||
)
|
||||
return [
|
||||
`Thanks for signing up for ${settings.appName} recently. We hope you've been finding it useful! Here are some key features to help you get the most out of the service:`,
|
||||
`${learnLatexLink}: In this tutorial we provide a quick and easy first introduction to LaTeX with no prior knowledge required. By the time you are finished, you will have written your first LaTeX document!`,
|
||||
`${templatesLinks}: If you're looking for a template or example to get started, we've a large selection available in our template gallery, including CVs, project reports, journal articles and more.`,
|
||||
`${collaboratorsLink}: One of the key features of Overleaf is the ability to share projects and collaborate on them with other users. Find out how to share your projects with your colleagues in this quick how-to guide.`,
|
||||
`${onboardingSurveyLink} to help us make Overleaf even better!`,
|
||||
'Thanks again for using Overleaf :)',
|
||||
`Lee`,
|
||||
`Lee Shalit<br />CEO<br />${siteLink}<hr>`,
|
||||
`You're receiving this email because you've recently signed up for an Overleaf account. If you've previously subscribed to emails about product offers and company news and events, you can unsubscribe ${userSettingsLink}.`,
|
||||
]
|
||||
},
|
||||
})
|
||||
|
||||
templates.securityAlert = NoCTAEmailTemplate({
|
||||
subject(opts) {
|
||||
return `Overleaf security note: ${opts.action}`
|
||||
},
|
||||
title(opts) {
|
||||
return opts.action.charAt(0).toUpperCase() + opts.action.slice(1)
|
||||
},
|
||||
message(opts, isPlainText) {
|
||||
const dateFormatted = moment().format('dddd D MMMM YYYY')
|
||||
const timeFormatted = moment().format('HH:mm')
|
||||
const helpLink = EmailMessageHelper.displayLink(
|
||||
'quick guide',
|
||||
`${settings.siteUrl}/learn/how-to/Keeping_your_account_secure`,
|
||||
isPlainText
|
||||
)
|
||||
|
||||
const actionDescribed = EmailMessageHelper.cleanHTML(
|
||||
opts.actionDescribed,
|
||||
isPlainText
|
||||
)
|
||||
|
||||
if (!opts.message) {
|
||||
opts.message = []
|
||||
}
|
||||
const message = opts.message.map(m => {
|
||||
return EmailMessageHelper.cleanHTML(m, isPlainText)
|
||||
})
|
||||
|
||||
return [
|
||||
`We are writing to let you know that ${actionDescribed} on ${dateFormatted} at ${timeFormatted} GMT.`,
|
||||
...message,
|
||||
`If this was you, you can ignore this email.`,
|
||||
`If this was not you, we recommend getting in touch with our support team at ${settings.adminEmail} to report this as potentially suspicious activity on your account.`,
|
||||
`We also encourage you to read our ${helpLink} to keeping your ${settings.appName} account safe.`,
|
||||
]
|
||||
},
|
||||
})
|
||||
|
||||
templates.SAMLDataCleared = ctaTemplate({
|
||||
subject(opts) {
|
||||
return `Institutional Login No Longer Linked - ${settings.appName}`
|
||||
},
|
||||
title(opts) {
|
||||
return 'Institutional Login No Longer Linked'
|
||||
},
|
||||
message(opts, isPlainText) {
|
||||
return [
|
||||
`We're writing to let you know that due to a bug on our end, we've had to temporarily disable logging into your ${settings.appName} through your institution.`,
|
||||
`To get it going again, you'll need to relink your institutional email address to your ${settings.appName} account via your settings.`,
|
||||
]
|
||||
},
|
||||
secondaryMessage() {
|
||||
return [
|
||||
`If you ordinarily log in to your ${settings.appName} account through your institution, you may need to set or reset your password to regain access to your account first.`,
|
||||
'This bug did not affect the security of any accounts, but it may have affected license entitlements for a small number of users. We are sorry for any inconvenience that this may cause for you.',
|
||||
`If you have any questions, please get in touch with our support team at ${settings.adminEmail} or by replying to this email.`,
|
||||
]
|
||||
},
|
||||
ctaText(opts) {
|
||||
return 'Update my Emails and Affiliations'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return `${settings.siteUrl}/user/settings`
|
||||
},
|
||||
})
|
||||
|
||||
templates.welcome = ctaTemplate({
|
||||
subject() {
|
||||
return `Welcome to ${settings.appName}`
|
||||
},
|
||||
title() {
|
||||
return `Welcome to ${settings.appName}`
|
||||
},
|
||||
greeting() {
|
||||
return 'Hi,'
|
||||
},
|
||||
message(opts, isPlainText) {
|
||||
const logInAgainDisplay = EmailMessageHelper.displayLink(
|
||||
'log in again',
|
||||
`${settings.siteUrl}/login`,
|
||||
isPlainText
|
||||
)
|
||||
const helpGuidesDisplay = EmailMessageHelper.displayLink(
|
||||
'Help Guides',
|
||||
`${settings.siteUrl}/learn`,
|
||||
isPlainText
|
||||
)
|
||||
const templatesDisplay = EmailMessageHelper.displayLink(
|
||||
'Templates',
|
||||
`${settings.siteUrl}/templates`,
|
||||
isPlainText
|
||||
)
|
||||
|
||||
return [
|
||||
`Thanks for signing up to ${settings.appName}! If you ever get lost, you can ${logInAgainDisplay} with the email address '${opts.to}'.`,
|
||||
`If you're new to LaTeX, take a look at our ${helpGuidesDisplay} and ${templatesDisplay}.`,
|
||||
`Please also take a moment to confirm your email address for ${settings.appName}:`,
|
||||
]
|
||||
},
|
||||
secondaryMessage() {
|
||||
return [
|
||||
`PS. We love talking to our users about ${settings.appName}. Reply to this email to get in touch with us directly, whatever the reason. Questions, comments, problems, suggestions, all welcome!`,
|
||||
]
|
||||
},
|
||||
ctaText() {
|
||||
return 'Confirm Email'
|
||||
},
|
||||
ctaURL(opts) {
|
||||
return opts.confirmEmailUrl
|
||||
},
|
||||
})
|
||||
|
||||
templates.welcomeWithoutCTA = NoCTAEmailTemplate({
|
||||
subject() {
|
||||
return `Welcome to ${settings.appName}`
|
||||
},
|
||||
title() {
|
||||
return `Welcome to ${settings.appName}`
|
||||
},
|
||||
greeting() {
|
||||
return 'Hi,'
|
||||
},
|
||||
message(opts, isPlainText) {
|
||||
const logInAgainDisplay = EmailMessageHelper.displayLink(
|
||||
'log in again',
|
||||
`${settings.siteUrl}/login`,
|
||||
isPlainText
|
||||
)
|
||||
const helpGuidesDisplay = EmailMessageHelper.displayLink(
|
||||
'Help Guides',
|
||||
`${settings.siteUrl}/learn`,
|
||||
isPlainText
|
||||
)
|
||||
const templatesDisplay = EmailMessageHelper.displayLink(
|
||||
'Templates',
|
||||
`${settings.siteUrl}/templates`,
|
||||
isPlainText
|
||||
)
|
||||
|
||||
return [
|
||||
`Thanks for signing up to ${settings.appName}! If you ever get lost, you can ${logInAgainDisplay} with the email address '${opts.to}'.`,
|
||||
`If you're new to LaTeX, take a look at our ${helpGuidesDisplay} and ${templatesDisplay}.`,
|
||||
`PS. We love talking to our users about ${settings.appName}. Reply to this email to get in touch with us directly, whatever the reason. Questions, comments, problems, suggestions, all welcome!`,
|
||||
]
|
||||
},
|
||||
})
|
||||
|
||||
function _formatUserNameAndEmail(user, placeholder) {
|
||||
if (user.first_name && user.last_name) {
|
||||
const fullName = `${user.first_name} ${user.last_name}`
|
||||
if (SpamSafe.isSafeUserName(fullName)) {
|
||||
if (SpamSafe.isSafeEmail(user.email)) {
|
||||
return `${fullName} (${user.email})`
|
||||
} else {
|
||||
return fullName
|
||||
}
|
||||
}
|
||||
}
|
||||
return SpamSafe.safeEmail(user.email, placeholder)
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
templates,
|
||||
ctaTemplate,
|
||||
NoCTAEmailTemplate,
|
||||
buildEmail,
|
||||
}
|
||||
Loading…
Reference in a new issue