n8n/packages/nodes-base/nodes/Mailgun/Mailgun.node.ts

194 lines
4.7 KiB
TypeScript
Raw Normal View History

2019-06-23 03:35:23 -07:00
import {
BINARY_ENCODING,
2021-02-22 06:07:53 -08:00
IExecuteFunctions,
2019-06-23 03:35:23 -07:00
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodeType,
INodeTypeDescription,
2019-06-23 03:35:23 -07:00
} from 'n8n-workflow';
export class Mailgun implements INodeType {
description: INodeTypeDescription = {
displayName: 'Mailgun',
name: 'mailgun',
2019-07-26 02:50:57 -07:00
icon: 'file:mailgun.png',
2019-06-23 03:35:23 -07:00
group: ['output'],
version: 1,
description: 'Sends an Email via Mailgun',
defaults: {
name: 'Mailgun',
color: '#c02428',
2019-06-23 03:35:23 -07:00
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'mailgunApi',
required: true,
2020-10-22 06:46:03 -07:00
},
2019-06-23 03:35:23 -07:00
],
properties: [
{
displayName: 'From Email',
name: 'fromEmail',
type: 'string',
default: '',
required: true,
placeholder: 'Admin <admin@example.com>',
description: 'Email address of the sender optional with name.',
},
{
displayName: 'To Email',
name: 'toEmail',
type: 'string',
default: '',
required: true,
placeholder: 'info@example.com',
description: 'Email address of the recipient. Multiple ones can be separated by comma.',
},
{
displayName: 'Cc Email',
name: 'ccEmail',
type: 'string',
default: '',
placeholder: '',
description: 'Cc Email address of the recipient. Multiple ones can be separated by comma.',
},
{
displayName: 'Bcc Email',
name: 'bccEmail',
type: 'string',
default: '',
placeholder: '',
description: 'Bcc Email address of the recipient. Multiple ones can be separated by comma.',
},
{
displayName: 'Subject',
name: 'subject',
type: 'string',
default: '',
placeholder: 'My subject line',
description: 'Subject line of the email.',
},
{
displayName: 'Text',
name: 'text',
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
rows: 5,
},
default: '',
description: 'Plain text message of email.',
},
{
displayName: 'HTML',
name: 'html',
type: 'string',
typeOptions: {
rows: 5,
},
default: '',
description: 'HTML text message of email.',
},
{
displayName: 'Attachments',
name: 'attachments',
type: 'string',
default: '',
description: 'Name of the binary properties which contain<br />data which should be added to email as attachment.<br />Multiple ones can be comma separated.',
},
],
};
2021-03-29 02:20:10 -07:00
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
2021-02-22 06:07:53 -08:00
const items = this.getInputData();
2021-03-29 02:20:10 -07:00
2021-02-22 06:07:53 -08:00
const returnData: INodeExecutionData[] = [];
const length = items.length as unknown as number;
let item: INodeExecutionData;
2019-06-23 03:35:23 -07:00
2021-02-22 06:07:53 -08:00
for (let itemIndex = 0; itemIndex < length; itemIndex++) {
item = items[itemIndex];
2019-06-23 03:35:23 -07:00
2021-02-22 06:07:53 -08:00
const fromEmail = this.getNodeParameter('fromEmail', itemIndex) as string;
const toEmail = this.getNodeParameter('toEmail', itemIndex) as string;
const ccEmail = this.getNodeParameter('ccEmail', itemIndex) as string;
const bccEmail = this.getNodeParameter('bccEmail', itemIndex) as string;
const subject = this.getNodeParameter('subject', itemIndex) as string;
const text = this.getNodeParameter('text', itemIndex) as string;
const html = this.getNodeParameter('html', itemIndex) as string;
const attachmentPropertyString = this.getNodeParameter('attachments', itemIndex) as string;
const credentials = this.getCredentials('mailgunApi');
if (credentials === undefined) {
throw new Error('No credentials got returned!');
2019-06-23 03:35:23 -07:00
}
2021-02-22 06:07:53 -08:00
const formData: IDataObject = {
from: fromEmail,
to: toEmail,
subject,
text,
html,
};
if (ccEmail.length !== 0) {
formData.cc = ccEmail;
}
if (bccEmail.length !== 0) {
formData.bcc = bccEmail;
2019-06-23 03:35:23 -07:00
}
2021-02-22 06:07:53 -08:00
if (attachmentPropertyString && item.binary) {
const attachments = [];
const attachmentProperties: string[] = attachmentPropertyString.split(',').map((propertyName) => {
return propertyName.trim();
});
2019-06-23 03:35:23 -07:00
2021-02-22 06:07:53 -08:00
for (const propertyName of attachmentProperties) {
if (!item.binary.hasOwnProperty(propertyName)) {
continue;
}
attachments.push({
value: Buffer.from(item.binary[propertyName].data, BINARY_ENCODING),
options: {
filename: item.binary[propertyName].fileName || 'unknown',
},
});
}
if (attachments.length) {
// @ts-ignore
formData.attachment = attachments;
}
}
const options = {
method: 'POST',
formData,
uri: `https://${credentials.apiDomain}/v3/${credentials.emailDomain}/messages`,
auth: {
user: 'api',
pass: credentials.apiKey as string,
},
json: true,
};
const responseData = await this.helpers.request(options);
returnData.push({
json: responseData,
});
2021-03-29 02:20:10 -07:00
}
return this.prepareOutputData(returnData);
2019-06-23 03:35:23 -07:00
}
}