mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-03-05 20:50:17 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

✨ Add Reply To parameter to Mailjet node (#1732)

Browse source 
* ⚡ Add Reply To parameter

* ⚡ Add svg logo
This commit is contained in:
Ricardo Espinoza 2021-05-07 19:46:50 -04:00 committed by GitHub
parent fc3ebf1a4c
commit f6fdf6b5e1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 148 additions and 98 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
packages/nodes-base/nodes/Mailjet/EmailDescription.ts
View file

@ -31,9 +31,9 @@ export const emailOperations = [
export const emailFields = [ export const emailFields = [
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
/* email:send */ /* email:send */
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
{ {
displayName: 'From Email', displayName: 'From Email',
name: 'fromEmail', name: 'fromEmail',
@ -162,11 +162,18 @@ export const emailFields = [
type: 'number', type: 'number',
default: 2, default: 2,
}, },
{
displayName: 'Reply To',
name: 'replyTo',
type: 'string',
description: 'The reply-to email address. Multiple ones can be separated by comma.',
default: '',
},
{ {
displayName: 'Template Language', displayName: 'Template Language',
name: 'templateLanguage', name: 'templateLanguage',
type: 'boolean', type: 'boolean',
default: true, default: false,
}, },
{ {
displayName: 'Track Clicks', displayName: 'Track Clicks',
@ -258,9 +265,9 @@ export const emailFields = [
}, },
], ],
}, },
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
/* email:sendTemplate */ /* email:sendTemplate */
/* -------------------------------------------------------------------------- */ /* -------------------------------------------------------------------------- */
{ {
displayName: 'From Email', displayName: 'From Email',
name: 'fromEmail', name: 'fromEmail',
@ -301,7 +308,10 @@ export const emailFields = [
{ {
displayName: 'Template ID', displayName: 'Template ID',
name: 'templateId', name: 'templateId',
type: 'string', type: 'options',
typeOptions: {
loadOptionsMethod: 'getTemplates',
},
required: true, required: true,
default: '', default: '',
displayOptions: { displayOptions: {
@ -336,7 +346,7 @@ export const emailFields = [
displayName: 'Bcc Email', displayName: 'Bcc Email',
name: 'bccEmail', name: 'bccEmail',
type: 'string', type: 'string',
description: 'Bcc Recipients of the email separated by ,.', description: 'BCC Recipients of the email separated by ,.',
default: '', default: '',
}, },
{ {
@ -358,6 +368,13 @@ export const emailFields = [
type: 'number', type: 'number',
default: 2, default: 2,
}, },
{
displayName: 'Reply To',
name: 'replyTo',
type: 'string',
description: 'The reply-to email address. Multiple ones can be separated by comma.',
default: '',
},
{ {
displayName: 'Subject', displayName: 'Subject',
name: 'subject', name: 'subject',
@ -382,7 +399,7 @@ export const emailFields = [
displayName: 'Template Language', displayName: 'Template Language',
name: 'templateLanguage', name: 'templateLanguage',
type: 'boolean', type: 'boolean',
default: true, default: false,
}, },
], ],
}, },

37
packages/nodes-base/nodes/Mailjet/GenericFunctions.ts
View file

@ -1,10 +1,18 @@
import { OptionsWithUri } from 'request'; import {
OptionsWithUri,
} from 'request';
import { import {
IExecuteFunctions, IExecuteFunctions,
IExecuteSingleFunctions, IExecuteSingleFunctions,
ILoadOptionsFunctions, ILoadOptionsFunctions,
} from 'n8n-core'; } from 'n8n-core';
import { IDataObject, IHookFunctions, NodeApiError } from 'n8n-workflow';
import {
IDataObject,
IHookFunctions,
NodeApiError,
} from 'n8n-workflow';
export async function mailjetApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | IHookFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any export async function mailjetApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | IHookFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const emailApiCredentials = this.getCredentials('mailjetEmailApi'); const emailApiCredentials = this.getCredentials('mailjetEmailApi');
@ -16,7 +24,7 @@ export async function mailjetApiRequest(this: IExecuteFunctions | IExecuteSingle
method, method,
qs, qs,
body, body,
uri: uri ||`https://api.mailjet.com${resource}`, uri: uri || `https://api.mailjet.com${resource}`,
json: true, json: true,
}; };
options = Object.assign({}, options, option); options = Object.assign({}, options, option);
@ -25,12 +33,10 @@ export async function mailjetApiRequest(this: IExecuteFunctions | IExecuteSingle
} }
if (emailApiCredentials !== undefined) { if (emailApiCredentials !== undefined) {
const base64Credentials = Buffer.from(`${emailApiCredentials.apiKey}:${emailApiCredentials.secretKey}`).toString('base64'); const base64Credentials = Buffer.from(`${emailApiCredentials.apiKey}:${emailApiCredentials.secretKey}`).toString('base64');
//@ts-ignore options.headers!['Authorization'] = `Basic ${base64Credentials}`;
options.headers['Authorization'] = `Basic ${base64Credentials}`;
} else { } else {
const smsApiCredentials = this.getCredentials('mailjetSmsApi'); const smsApiCredentials = this.getCredentials('mailjetSmsApi');
//@ts-ignore options.headers!['Authorization'] = `Bearer ${smsApiCredentials!.token}`;
options.headers['Authorization'] = `Bearer ${smsApiCredentials.token}`;
} }
try { try {
return await this.helpers.request!(options); return await this.helpers.request!(options);
@ -57,3 +63,20 @@ export async function mailjetApiRequestAllItems(this: IExecuteFunctions | IHookF
); );
return returnData; return returnData;
} }
export interface IMessage {
From?: { Email?: string, Name?: string };
Subject?: string;
To?: IDataObject[];
Cc?: IDataObject[];
Bcc?: IDataObject[];
Variables?: IDataObject;
TemplateLanguage?: boolean;
TemplateID?: number;
HTMLPart?: string;
TextPart?: string;
TrackOpens?: string;
ReplyTo?: IDataObject;
TrackClicks?: string;
Priority?: number;
}

169
packages/nodes-base/nodes/Mailjet/Mailjet.node.ts
View file

@ -1,19 +1,26 @@
import { import {
IExecuteFunctions, IExecuteFunctions,
} from 'n8n-core'; } from 'n8n-core';
import { import {
IDataObject, IDataObject,
ILoadOptionsFunctions,
INodeExecutionData, INodeExecutionData,
INodePropertyOptions,
INodeType, INodeType,
INodeTypeDescription, INodeTypeDescription,
} from 'n8n-workflow'; } from 'n8n-workflow';
import { import {
IMessage,
mailjetApiRequest, mailjetApiRequest,
} from './GenericFunctions'; } from './GenericFunctions';
import { import {
emailFields, emailFields,
emailOperations, emailOperations,
} from './EmailDescription'; } from './EmailDescription';
import { import {
smsFields, smsFields,
smsOperations, smsOperations,
@ -23,7 +30,7 @@ export class Mailjet implements INodeType {
description: INodeTypeDescription = { description: INodeTypeDescription = {
displayName: 'Mailjet', displayName: 'Mailjet',
name: 'mailjet', name: 'mailjet',
icon: 'file:mailjet.png', icon: 'file:mailjet.svg',
group: ['output'], group: ['output'],
version: 1, version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}', subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
@ -83,6 +90,24 @@ export class Mailjet implements INodeType {
], ],
}; };
methods = {
loadOptions: {
// Get all the available custom fields to display them to user so that he can
// select them easily
async getTemplates(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { Data: templates } = await mailjetApiRequest.call(this, 'GET', '/v3/REST/template');
for (const template of templates) {
returnData.push({
name: template.Name,
value: template.ID,
});
}
return returnData;
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> { async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData(); const items = this.getInputData();
const returnData: IDataObject[] = []; const returnData: IDataObject[] = [];
@ -103,80 +128,71 @@ export class Mailjet implements INodeType {
const toEmail = (this.getNodeParameter('toEmail', i) as string).split(',') as string[]; const toEmail = (this.getNodeParameter('toEmail', i) as string).split(',') as string[];
const variables = (this.getNodeParameter('variablesUi', i) as IDataObject).variablesValues as IDataObject[]; const variables = (this.getNodeParameter('variablesUi', i) as IDataObject).variablesValues as IDataObject[];
const body: IDataObject = { const body: IMessage = {
Messages: [ From: {
{ Email: fromEmail,
From: { },
email: fromEmail, Subject: subject,
}, To: [],
subject, Cc: [],
to: [], Bcc: [],
Cc: [], Variables: {},
Bcc: [],
Variables: {},
},
],
//SandboxMode: true,
}; };
for (const email of toEmail) { for (const email of toEmail) {
//@ts-ignore body.To?.push({
body.Messages[0].to.push({ Email: email,
email,
}); });
} }
if (variables) { if (variables) {
for (const variable of variables) { for (const variable of variables) {
//@ts-ignore body.Variables![variable.name as string] = variable.value;
body.Messages[0].Variables[variable.name] = variable.value;
} }
} }
if (htmlBody) { if (htmlBody) {
//@ts-ignore body.HTMLPart = htmlBody;
body.Messages[0].HTMLPart = htmlBody;
} }
if (textBody) { if (textBody) {
//@ts-ignore body.TextPart = textBody;
body.Messages[0].TextPart = textBody;
} }
if (additionalFields.bccEmail) { if (additionalFields.bccEmail) {
const bccEmail = (additionalFields.bccEmail as string).split(',') as string[]; const bccEmail = (additionalFields.bccEmail as string).split(',') as string[];
for (const email of bccEmail) { for (const email of bccEmail) {
//@ts-ignore body.Bcc!.push({
body.Messages[0].Bcc.push({ Email: email,
email,
}); });
} }
} }
if (additionalFields.ccEmail) { if (additionalFields.ccAddresses) {
const ccEmail = (additionalFields.ccEmail as string).split(',') as string[]; const ccEmail = (additionalFields.ccAddresses as string).split(',') as string[];
for (const email of ccEmail) { for (const email of ccEmail) {
//@ts-ignore body.Cc!.push({
body.Messages[0].Cc.push({ Email: email,
email,
}); });
} }
} }
if (additionalFields.trackOpens) { if (additionalFields.trackOpens) {
//@ts-ignore body.TrackOpens = additionalFields.trackOpens as string;
body.Messages[0].TrackOpens = additionalFields.trackOpens as string; }
if (additionalFields.replyTo) {
const replyTo = additionalFields.replyTo as string;
body['ReplyTo'] = {
Email: replyTo,
};
} }
if (additionalFields.trackClicks) { if (additionalFields.trackClicks) {
//@ts-ignore body.TrackClicks = additionalFields.trackClicks as string;
body.Messages[0].TrackClicks = additionalFields.trackClicks as string;
} }
if (additionalFields.fromName) { if (additionalFields.fromName) {
//@ts-ignore body.From!.Name = additionalFields.fromName as string;
body.Messages[0].From.name = additionalFields.fromName as string;
} }
if (additionalFields.templateLanguage) { if (additionalFields.templateLanguage) {
//@ts-ignore body.TemplateLanguage = additionalFields.templateLanguage as boolean;
body.Messages[0].From.TemplateLanguage = additionalFields.templateLanguage as boolean;
} }
if (additionalFields.priority) { if (additionalFields.priority) {
//@ts-ignore body.Priority = additionalFields.priority as number;
body.Messages[0].Priority = additionalFields.priority as number;
} }
responseData = await mailjetApiRequest.call(this, 'POST', '/v3.1/send', body); responseData = await mailjetApiRequest.call(this, 'POST', '/v3.1/send', { Messages: [body] });
responseData = responseData.Messages; responseData = responseData.Messages;
} }
@ -189,73 +205,66 @@ export class Mailjet implements INodeType {
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const toEmail = (this.getNodeParameter('toEmail', i) as string).split(',') as string[]; const toEmail = (this.getNodeParameter('toEmail', i) as string).split(',') as string[];
const body: IDataObject = { const body: IMessage = {
Messages: [ From: {
{ Email: fromEmail,
From: { },
email: fromEmail, Subject: subject,
}, To: [],
Subject: subject, Cc: [],
to: [], Bcc: [],
Cc: [], Variables: {},
Bcc: [], TemplateID: templateId,
Variables: {},
TemplateID: templateId,
},
],
//SandboxMode: true,
}; };
for (const email of toEmail) { for (const email of toEmail) {
//@ts-ignore body.To!.push({
body.Messages[0].to.push({ Email: email,
email,
}); });
} }
if (variables) { if (variables) {
for (const variable of variables) { for (const variable of variables) {
//@ts-ignore body.Variables![variable.name as string] = variable.value;
body.Messages[0].Variables[variable.name] = variable.value;
} }
} }
if (additionalFields.bccEmail) { if (additionalFields.bccEmail) {
const bccEmail = (additionalFields.bccEmail as string).split(',') as string[]; const bccEmail = (additionalFields.bccEmail as string).split(',') as string[];
for (const email of bccEmail) { for (const email of bccEmail) {
//@ts-ignore body.Bcc!.push({
body.Messages[0].Bcc.push({ Email: email,
email,
}); });
} }
} }
if (additionalFields.ccEmail) { if (additionalFields.ccEmail) {
const ccEmail = (additionalFields.ccEmail as string).split(',') as string[]; const ccEmail = (additionalFields.ccEmail as string).split(',') as string[];
for (const email of ccEmail) { for (const email of ccEmail) {
//@ts-ignore body.Cc!.push({
body.Messages[0].Cc.push({ Email: email,
email,
}); });
} }
} }
if (additionalFields.replyTo) {
const replyTo = additionalFields.replyTo as string;
body['ReplyTo'] = {
Email: replyTo,
};
}
if (additionalFields.trackOpens) { if (additionalFields.trackOpens) {
//@ts-ignore body.TrackOpens = additionalFields.trackOpens as string;
body.Messages[0].TrackOpens = additionalFields.trackOpens as string;
} }
if (additionalFields.trackClicks) { if (additionalFields.trackClicks) {
//@ts-ignore body.TrackClicks = additionalFields.trackClicks as string;
body.Messages[0].TrackClicks = additionalFields.trackClicks as string;
} }
if (additionalFields.fromName) { if (additionalFields.fromName) {
//@ts-ignore body.From!.Name = additionalFields.fromName as string;
body.Messages[0].From.name = additionalFields.fromName as string;
} }
if (additionalFields.templateLanguage) { if (additionalFields.templateLanguage) {
//@ts-ignore body.TemplateLanguage = additionalFields.templateLanguage as boolean;
body.Messages[0].From.TemplateLanguage = additionalFields.templateLanguage as boolean;
} }
if (additionalFields.priority) { if (additionalFields.priority) {
//@ts-ignore body.Priority = additionalFields.priority as number;
body.Messages[0].Priority = additionalFields.priority as number;
} }
responseData = await mailjetApiRequest.call(this, 'POST', '/v3.1/send', body); responseData = await mailjetApiRequest.call(this, 'POST', '/v3.1/send', { Messages: [body] });
responseData = responseData.Messages; responseData = responseData.Messages;
} }
} }

2
packages/nodes-base/nodes/Mailjet/MailjetTrigger.node.ts
View file

@ -18,7 +18,7 @@ export class MailjetTrigger implements INodeType {
description: INodeTypeDescription = { description: INodeTypeDescription = {
displayName: 'Mailjet Trigger', displayName: 'Mailjet Trigger',
name: 'mailjetTrigger', name: 'mailjetTrigger',
icon: 'file:mailjet.png', icon: 'file:mailjet.svg',
group: ['trigger'], group: ['trigger'],
version: 1, version: 1,
description: 'Handle Mailjet events via webhooks', description: 'Handle Mailjet events via webhooks',

BIN
packages/nodes-base/nodes/Mailjet/mailjet.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 891 B

1
packages/nodes-base/nodes/Mailjet/mailjet.svg Normal file
View file

@ -0,0 +1 @@
<svg height="2500" viewBox=".5 90 402.6 222.2" width="2500" xmlns="http://www.w3.org/2000/svg"><path d="m129.1 195.5-7 46.5-48 70.2 16.2-8.9 263.7-145.2 49.1-27zm-1.7-12.3 206.8-47-13.4-1.8-54.3-7.6-115.2-15.9-150.8-20.9 55.3 40.6 69.5 51.1z" fill="#fead0c"/></svg>
Side by side

After

Width:  |  Height:  |  Size: 265 B