Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated support/reply email address flow #12161

Merged
merged 4 commits into from Aug 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 31 additions & 11 deletions core/server/api/canary/settings.js
Expand Up @@ -74,30 +74,39 @@ module.exports = {
}
},

validateMembersFromEmail: {
validateMembersEmailUpdate: {
options: [
'token'
'token',
'action'
],
permissions: false,
validation: {
options: {
token: {
required: true
},
action: {
values: ['fromaddressupdate', 'supportaddressupdate']
}
}
},
async query(frame) {
// This is something you have to do if you want to use the "framework" with access to the raw req/res
frame.response = async function (req, res) {
try {
const updatedFromAddress = membersService.settings.getEmailFromToken({token: frame.options.token});
if (updatedFromAddress) {
const {token, action} = frame.options;
const updatedEmailAddress = membersService.settings.getEmailFromToken({token});
const actionToKeyMapping = {
fromAddressUpdate: 'members_from_address',
supportAddressUpdate: 'members_support_address'
};
if (updatedEmailAddress) {
return models.Settings.edit({
key: 'members_from_address',
value: updatedFromAddress
key: actionToKeyMapping[action],
value: updatedEmailAddress
}).then(() => {
// Redirect to Ghost-Admin settings page
const adminLink = membersService.settings.getAdminRedirectLink();
const adminLink = membersService.settings.getAdminRedirectLink({type: action});
res.redirect(adminLink);
});
} else {
Expand All @@ -115,21 +124,32 @@ module.exports = {
}
},

updateMembersFromEmail: {
updateMembersEmail: {
permissions: {
method: 'edit'
},
data: [
'email',
'type'
],
async query(frame) {
const email = frame.data.from_address;
const {email, type} = frame.data;
if (typeof email !== 'string' || !validator.isEmail(email)) {
throw new BadRequestError({
message: i18n.t('errors.api.settings.invalidEmailReceived')
});
}

if (!type || !['fromAddressUpdate', 'supportAddressUpdate'].includes(type)) {
throw new BadRequestError({
message: 'Invalid email type recieved'
});
}
try {
// Send magic link to update fromAddress
await membersService.settings.sendFromAddressUpdateMagicLink({
email
await membersService.settings.sendEmailAddressUpdateMagicLink({
email,
type
});
} catch (err) {
throw new BadRequestError({
Expand Down
2 changes: 1 addition & 1 deletion core/server/data/importer/importers/data/settings.js
Expand Up @@ -143,7 +143,7 @@ class SettingsImporter extends BaseImporter {
}

// CASE: we do not import "from address" for members settings as that needs to go via validation with magic link
if (obj.key === 'members_from_address') {
if ((obj.key === 'members_from_address') || (obj.key === 'members_support_address')) {
obj.value = null;
}

Expand Down
3 changes: 3 additions & 0 deletions core/server/services/bulk-email/index.js
Expand Up @@ -81,6 +81,8 @@ module.exports = {
}

const blogTitle = settingsCache.get('title') ? settingsCache.get('title').replace(/"/g, '\\"') : '';
const supportAddress = settingsCache.get('members_support_address');
const replyToAddress = (settingsCache.get('members_reply_address') === 'support') ? supportAddress : fromAddress;
fromAddress = blogTitle ? `"${blogTitle}"<${fromAddress}>` : fromAddress;

const chunkedRecipients = _.chunk(recipients, BATCH_SIZE);
Expand All @@ -94,6 +96,7 @@ module.exports = {
const batchData = {
to: toAddresses,
from: fromAddress,
'h:Reply-To': replyToAddress || fromAddress,
'recipient-variables': recipientVariables
};

Expand Down
2 changes: 1 addition & 1 deletion core/server/services/members/api.js
Expand Up @@ -26,7 +26,7 @@ function createApiInstance(config) {
logging.warn(message.text);
}
let msg = Object.assign({
from: config.getEmailFromAddress(),
from: config.getAuthEmailFromAddress(),
subject: 'Signin',
forceTextContent: true
}, message);
Expand Down
5 changes: 5 additions & 0 deletions core/server/services/members/config.js
Expand Up @@ -44,6 +44,11 @@ class MembersConfigProvider {
return fromAddress;
}

getAuthEmailFromAddress() {
const supportAddress = this._settingsCache.get('members_support_address');
return supportAddress || this.getEmailFromAddress();
}

getPublicPlans() {
const CURRENCY_SYMBOLS = {
USD: '$',
Expand Down
2 changes: 2 additions & 0 deletions core/server/services/members/index.js
Expand Up @@ -39,6 +39,8 @@ events.on('settings.edited', function updateSettingFromModel(settingModel) {
if (![
'members_allow_free_signup',
'members_from_address',
'members_support_address',
'members_reply_address',
'stripe_publishable_key',
'stripe_secret_key',
'stripe_product_name',
Expand Down
26 changes: 20 additions & 6 deletions core/server/services/members/settings.js
Expand Up @@ -17,7 +17,7 @@ function createSettingsInstance(config) {
logging.warn(message.text);
}
let msg = Object.assign({
from: config.getEmailFromAddress(),
from: config.getAuthEmailFromAddress(),
subject: 'Update email address',
forceTextContent: true
}, message);
Expand Down Expand Up @@ -70,21 +70,35 @@ function createSettingsInstance(config) {
getSubject
});

const sendFromAddressUpdateMagicLink = ({email, payload = {}}) => {
return magicLinkService.sendMagicLink({email, payload, subject: email, type: 'updateFromAddress'});
const sendEmailAddressUpdateMagicLink = ({email, payload = {}, type = 'fromAddressUpdate'}) => {
magicLinkService.transporter = {
sendMail(message) {
if (process.env.NODE_ENV !== 'production') {
logging.warn(message.text);
}
let msg = Object.assign({
from: email,
subject: 'Update email address',
forceTextContent: true
}, message);

return ghostMailer.send(msg);
}
};
return magicLinkService.sendMagicLink({email, payload, subject: email, type});
};

const getEmailFromToken = ({token}) => {
return magicLinkService.getUserFromToken(token);
};

const getAdminRedirectLink = () => {
const getAdminRedirectLink = ({type}) => {
const adminUrl = urlUtils.urlFor('admin', true);
return urlUtils.urlJoin(adminUrl, '#/settings/labs/?fromAddressUpdate=success');
return urlUtils.urlJoin(adminUrl, `#/settings/labs/?${type}=success`);
};

return {
sendFromAddressUpdateMagicLink,
sendEmailAddressUpdateMagicLink,
getEmailFromToken,
getAdminRedirectLink
};
Expand Down
4 changes: 2 additions & 2 deletions core/server/web/api/canary/admin/routes.js
Expand Up @@ -61,8 +61,8 @@ module.exports = function apiRoutes() {
router.get('/settings', mw.authAdminApi, http(apiCanary.settings.browse));
router.get('/settings/:key', mw.authAdminApi, http(apiCanary.settings.read));
router.put('/settings', mw.authAdminApi, http(apiCanary.settings.edit));
router.get('/settings/members/email', http(apiCanary.settings.validateMembersFromEmail));
router.post('/settings/members/email', mw.authAdminApi, http(apiCanary.settings.updateMembersFromEmail));
router.get('/settings/members/email', http(apiCanary.settings.validateMembersEmailUpdate));
router.post('/settings/members/email', mw.authAdminApi, http(apiCanary.settings.updateMembersEmail));
router.del('/settings/stripe/connect', mw.authAdminApi, http(apiCanary.settings.disconnectStripeConnectIntegration));

// ## Users
Expand Down