If you want to use service like this click
here to read more. Also you can opt out from our email subscription
here.
ยฉ 2019 erxes inc Growth Marketing Platform
-#### 2. Clone and install dependencies.
+erxes helps you attract and engage more customers while giving you high lead conversion. With erxes, all your marketing, sales and customer service tools are merged into one platform for greater output. Replace Hubspot with the mission and community-driven ecosystem.
-```Shell
-git clone https://github.com/erxes/erxes-api.git
-cd erxes-api
-yarn install
-```
-
-#### 3. Create configuration from sample file. We use [dotenv](https://github.com/motdotla/dotenv) for this.
-
-```Shell
-cp .env.sample .env
-```
-
-.env file description
-
-```.env
-NODE_ENV=development (Node environment: development | production)
-PORT=3300 (Server port)
-
-MONGO_URL=mongodb://localhost/erxes (MongoDB url)
-TEST_MONGO_URL=mongodb://localhost/test
-
-REDIS_HOST=localhost (Redis server url)
-REDIS_PORT=6379 (Redis server port)
-
-MAIN_APP_DOMAIN=http://localhost:3000 (erxes project url)
-```
-
-#### 4. Start the server.
-
-For development:
-
-```Shell
-yarn dev
-```
-
-For production:
-
-```Shell
-yarn build
-yarn start
-```
-
-#### 5. Running servers
-- GraphQL server: [http://localhost:3300/graphql](http://localhost:3300/graphql)
-- Websocket subscriptions server: [ws://localhost:3300/subscriptions](ws://localhost:3300/subscriptions)
+* **Growth Hacking:** Managing your entire growth operation made easy. From ideas to actual performance, making sure everything recorded, prioritized and centralized in the single platform to get tested with pool of analysis and learnings, which made the growing as pleasure.
+* **Email & SMS Marketing:** Reach your customer with personalized messaging. Keeping your customers hooked is definitely a challenge. Start converting your prospects into potential customers through email, SMS, Live chat, and In-app-messaging or more interactions to drive them to a successful close. You can connect to your customers in a whole new way with Erxes!
+* **Pop-ups & Forms:** Create Stylish Pop-ups and Forms that Bring Leads. Turn regular visitors into qualified leads by capturing them with a customizable pop-ups, forms, and embedded placements. Erxes helps you to create stylish and contextual pop-ups, banners and bars fit all your marketing needs.
+* **Sales Pipeline:** Track your entire sales pipeline from one dashboard. All your customer information and sales process in one board to follow up flawlessly. Have your sales managers to know everything needed to deliver increased levels of personalization before they contact customers.
+* **Contact Management:** Manage Visitors, Customers, and Companies. Access our all-in-one CRM system in one go so that itโs easier to coordinate and manage your contacts and interactions with your customers. Erxes Contacts provides whole segmentation tools for you to work more effiecently.
+* **Lead Scoring:** Identify and Target Sales-Ready Leads.
+* **Shared Team Inbox:** Communicate faster and easier with your customers via one truly omnichannel platform. Combine real-time client and team communication with in-app messaging, live chat, email and form, so your customers can reach you however and wherever they want.
+* **Messenger:** Talk to Your Customers in Continuous Omnichannel Conversations. Enable businesses to capture every single customer feedback and communicate in real time. You can educate your customers through knowledge-base from the erxes Messenger.
+* **Knowledge base:** Create Help Articles for Customer Self-service. Educate both your customers and staff by creating a help center related to your brands, products and services to reach higher level of satisfactions.
+* **Task Management:** Work More Collaboratively and Get More Done. Save time, manage your projects, monitor your team and increase your productivity in just a few clicks. Erxes helps to turn chaos into clarity and make everything perfect.
+## Documentation
+ * Install erxes 
-
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/erxes#sponsor)]
@@ -85,11 +53,8 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
-
-
-
## In-kind sponsors
@@ -100,4 +65,4 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
## License
-GNU General Public License v3.0
+GNU General Public License v3.0
diff --git a/app.json b/app.json
index e20d1c9e6..66e562d59 100644
--- a/app.json
+++ b/app.json
@@ -21,10 +21,6 @@
"description": "A port number that erxes api will be running on",
"value": "3300"
},
- "DOMAIN": {
- "description": "Erxes API URL",
- "value": "https://erxes-api.herokuapp.com"
- },
"MAIN_APP_DOMAIN": {
"description": "Erxes URL",
"value": "https://erxes.herokuapp.com"
diff --git a/elkSyncer/main.py b/elkSyncer/main.py
index 414317ffb..49904073e 100644
--- a/elkSyncer/main.py
+++ b/elkSyncer/main.py
@@ -14,6 +14,9 @@
client = Elasticsearch([ELASTICSEARCH_URL])
customer_mapping = {
+ 'state': {
+ 'type': 'keyword',
+ },
'primaryEmail': {
'type': 'text',
'analyzer': 'uax_url_email_analyzer',
@@ -36,9 +39,6 @@
'leadStatus': {
'type': 'keyword',
},
- 'lifecycleState': {
- 'type': 'keyword',
- },
'tagIds': {
'type': 'keyword',
},
@@ -51,6 +51,9 @@
'status': {
'type': 'keyword',
},
+ 'emailValidationStatus': {
+ 'type': 'keyword',
+ },
}
company_mapping = {
@@ -73,12 +76,6 @@
'ownerId': {
'type': 'keyword',
},
- 'leadStatus': {
- 'type': 'keyword',
- },
- 'lifecycleState': {
- 'type': 'keyword',
- },
'tagIds': {
'type': 'keyword',
},
diff --git a/email-verifier/.env.sample b/email-verifier/.env.sample
new file mode 100644
index 000000000..05798b64f
--- /dev/null
+++ b/email-verifier/.env.sample
@@ -0,0 +1,11 @@
+# general
+NODE_ENV=development
+PORT=4100
+
+# MongoDB
+MONGO_URL=mongodb://localhost/erxes-email-verifier
+
+# RabbitMQ
+RABBITMQ_HOST=amqp://localhost
+
+TRUE_MAIL_API_KEY=
\ No newline at end of file
diff --git a/email-verifier/Dockerfile b/email-verifier/Dockerfile
new file mode 100644
index 000000000..ef70cb19e
--- /dev/null
+++ b/email-verifier/Dockerfile
@@ -0,0 +1,7 @@
+FROM node:10.16.0-slim
+WORKDIR /erxes-email-verifier
+RUN chown -R node:node /erxes-email-verifier
+COPY --chown=node:node . /erxes-email-verifier
+USER node
+EXPOSE 4100
+ENTRYPOINT ["node", "--max_old_space_size=8192", "dist"]
\ No newline at end of file
diff --git a/email-verifier/package.json b/email-verifier/package.json
new file mode 100644
index 000000000..bbb2d4471
--- /dev/null
+++ b/email-verifier/package.json
@@ -0,0 +1,35 @@
+{
+ "name": "erxes-email-verifier",
+ "private": true,
+ "scripts": {
+ "start": "node dist",
+ "dev": "NODE_ENV=development DEBUG=erxes-email-verifier:* node_modules/.bin/ts-node-dev --experimental-worker --respawn src",
+ "build": "tsc -p tsconfig.prod.json",
+ "checkAndGetBulkEmails": "ts-node ./src/commands/checkAndGetBulkEmails.ts"
+ },
+ "dependencies": {
+ "amqplib": "^0.5.5",
+ "body-parser": "^1.19.0",
+ "debug": "^4.1.1",
+ "dotenv": "^4.0.0",
+ "email-deep-validator": "^3.3.0",
+ "express": "^4.16.4",
+ "mongoose": "5.7.5",
+ "requestify": "^0.2.5",
+ "xss": "^1.0.6"
+ },
+ "peerOptionalDependencies": {
+ "kerberos": "^1.0.0"
+ },
+ "devDependencies": {
+ "@types/dotenv": "^4.0.3",
+ "@types/express": "^4.16.0",
+ "@types/mongodb": "^3.1.2",
+ "@types/mongoose": "^5.2.1",
+ "@types/node": "^10.12.18",
+ "@types/q": "^1.5.0",
+ "ts-node": "8.0.3",
+ "ts-node-dev": "^1.0.0-pre.32",
+ "typescript": "^3.7.2"
+ }
+}
diff --git a/email-verifier/src/api.ts b/email-verifier/src/api.ts
new file mode 100644
index 000000000..98d224d6e
--- /dev/null
+++ b/email-verifier/src/api.ts
@@ -0,0 +1,118 @@
+import * as EmailValidator from 'email-deep-validator';
+import { sendMessage } from './messageBroker';
+import { EMAIL_VALIDATION_STATUSES, Emails } from './models';
+import { debugBase, sendRequest } from './utils';
+
+const { TRUE_MAIL_API_KEY, EMAIL_VERIFICATION_TYPE = 'truemail' } = process.env;
+
+const sendSingleMessage = async (doc: { email: string; status: string }, isRest: boolean, create?: boolean) => {
+ if (create) {
+ await Emails.createEmail(doc);
+ }
+
+ if (isRest) {
+ return doc.status;
+ }
+
+ return sendMessage('emailVerifierNotification', { action: 'emailVerify', data: [doc] });
+};
+
+const singleTrueMail = async (email: string) => {
+ try {
+ const url = `https://truemail.io/api/v1/verify/single?access_token=${TRUE_MAIL_API_KEY}&email=${email}`;
+
+ const response = await sendRequest({
+ url,
+ method: 'GET',
+ });
+
+ return JSON.parse(response);
+ } catch (e) {
+ debugBase(`Error occured during single true mail validation ${e.message}`);
+ throw e;
+ }
+};
+
+const bulkTrueMail = async (unverifiedEmails: string[]) => {
+ const url = `https://truemail.io/api/v1/tasks/bulk?access_token=${TRUE_MAIL_API_KEY}`;
+
+ try {
+ const result = await sendRequest({
+ url,
+ method: 'POST',
+ body: {
+ file: unverifiedEmails,
+ },
+ });
+
+ sendMessage('emailVerifierBulkEmailNotification', { action: 'bulk', data: result });
+ } catch (e) {
+ sendMessage('emailVerifierBulkEmailNotification', { action: 'bulk', data: e.message });
+ }
+};
+
+export const single = async (email: string, isRest = false) => {
+ const emailOnDb = await Emails.findOne({ email });
+
+ if (emailOnDb) {
+ return sendSingleMessage({ email, status: emailOnDb.status }, isRest);
+ }
+
+ const emailValidator = new EmailValidator();
+ const { validDomain, validMailbox } = await emailValidator.verify(email);
+
+ if (validDomain && validMailbox) {
+ return sendSingleMessage({ email, status: EMAIL_VALIDATION_STATUSES.VALID }, isRest, true);
+ }
+
+ let response: { status?: string; result?: string } = {};
+
+ if (EMAIL_VERIFICATION_TYPE === 'truemail') {
+ try {
+ response = await singleTrueMail(email);
+ } catch (_e) {
+ return sendSingleMessage({ email, status: EMAIL_VALIDATION_STATUSES.UNKNOWN }, isRest);
+ }
+ }
+
+ if (response.status === 'success') {
+ return sendSingleMessage({ email, status: response.result }, isRest, true);
+ }
+
+ // if status is not success
+ return sendSingleMessage({ email, status: EMAIL_VALIDATION_STATUSES.INVALID }, isRest);
+};
+
+export const bulk = async (emails: string[]) => {
+ const unverifiedEmails: any[] = [];
+ const verifiedEmails: any[] = [];
+
+ for (const email of emails) {
+ const found = await Emails.findOne({ email });
+
+ if (found) {
+ verifiedEmails.push({ email: found.email, status: found.status });
+ } else {
+ unverifiedEmails.push({ email });
+ }
+ }
+
+ if (verifiedEmails.length > 0) {
+ sendMessage('emailVerifierNotification', { action: 'emailVerify', data: verifiedEmails });
+ }
+
+ if (unverifiedEmails.length > 0) {
+ switch (EMAIL_VERIFICATION_TYPE) {
+ case 'truemail': {
+ await bulkTrueMail(unverifiedEmails);
+
+ break;
+ }
+ }
+ } else {
+ sendMessage('emailVerifierBulkNotification', {
+ action: 'bulk',
+ data: 'There are no emails to verify on the email verification system',
+ });
+ }
+};
diff --git a/email-verifier/src/commands/checkAndGetBulkEmails.ts b/email-verifier/src/commands/checkAndGetBulkEmails.ts
new file mode 100644
index 000000000..020b7409b
--- /dev/null
+++ b/email-verifier/src/commands/checkAndGetBulkEmails.ts
@@ -0,0 +1,110 @@
+import * as amqplib from 'amqplib';
+import { connect, disconnect } from '../connection';
+import { Emails } from '../models';
+import { sendRequest } from '../utils';
+
+console.log('Instruction: yarn checkAndGetBulkEmails taskId');
+
+const { RABBITMQ_HOST = 'amqp://localhost', TRUE_MAIL_API_KEY, EMAIL_VERIFICATION_TYPE = 'truemail' } = process.env;
+
+if (!TRUE_MAIL_API_KEY) {
+ console.log('Please configure TRUEMAIL API KEY');
+
+ disconnect();
+ process.exit();
+}
+
+connect().then(async () => {
+ const getTrueMailBulk = async (taskId: string) => {
+ const connection = await amqplib.connect(RABBITMQ_HOST);
+ const channel = await connection.createChannel();
+
+ const url = `https://truemail.io/api/v1/tasks/${taskId}/download?access_token=${TRUE_MAIL_API_KEY}&timeout=30000`;
+
+ const response = await sendRequest({
+ url,
+ method: 'GET',
+ });
+
+ const rows = response.split('\n');
+ const emails: Array<{ email: string; status: string }> = [];
+
+ for (const row of rows) {
+ const rowArray = row.split(',');
+
+ if (rowArray.length > 2) {
+ const email = rowArray[0];
+ const status = rowArray[2];
+
+ emails.push({
+ email,
+ status,
+ });
+
+ const found = await Emails.findOne({ email });
+
+ if (!found) {
+ const doc = {
+ email,
+ status,
+ created: new Date(),
+ };
+
+ await Emails.create(doc);
+ }
+ }
+ }
+
+ const args = { action: 'emailVerify', data: emails };
+
+ await channel.assertQueue('emailVerifierNotification');
+ await channel.sendToQueue('emailVerifierNotification', Buffer.from(JSON.stringify(args)));
+
+ console.log('Successfully get the following emails : \n', emails);
+
+ setTimeout(() => {
+ channel.connection.close();
+
+ disconnect();
+ process.exit();
+ }, 500);
+ };
+
+ const check = async () => {
+ const argv = process.argv;
+
+ if (argv.length < 3) {
+ console.log('Please put taskId after yarn checkAndGetBulkEmails');
+
+ disconnect();
+ process.exit();
+ }
+
+ const taskId = argv[2];
+
+ switch (EMAIL_VERIFICATION_TYPE) {
+ case 'truemail': {
+ const url = `https://truemail.io/api/v1/tasks/${taskId}/status?access_token=${TRUE_MAIL_API_KEY}`;
+
+ const response = await sendRequest({
+ url,
+ method: 'GET',
+ });
+
+ const data = JSON.parse(response).data;
+ console.log(data);
+
+ if (data.status === 'finished') {
+ await getTrueMailBulk(taskId);
+ } else {
+ disconnect();
+ process.exit();
+ }
+
+ break;
+ }
+ }
+ };
+
+ await check();
+});
diff --git a/email-verifier/src/connection.ts b/email-verifier/src/connection.ts
new file mode 100644
index 000000000..29e744ea0
--- /dev/null
+++ b/email-verifier/src/connection.ts
@@ -0,0 +1,29 @@
+import * as dotenv from 'dotenv';
+import mongoose = require('mongoose');
+import { debugBase } from './utils';
+
+dotenv.config();
+
+mongoose.Promise = global.Promise;
+mongoose.set('useFindAndModify', false);
+
+const { MONGO_URL } = process.env;
+
+mongoose.connection
+ .on('connected', () => {
+ debugBase(`Connected to the database: ${MONGO_URL}`);
+ })
+ .on('disconnected', () => {
+ debugBase(`Disconnected from the database: ${MONGO_URL}`);
+ })
+ .on('error', error => {
+ debugBase(`Database connection error: ${MONGO_URL}`, error);
+ });
+
+export const connect = (URL?: string) => {
+ return mongoose.connect(URL || MONGO_URL, { useNewUrlParser: true, useCreateIndex: true });
+};
+
+export function disconnect() {
+ return mongoose.connection.close();
+}
diff --git a/email-verifier/src/index.ts b/email-verifier/src/index.ts
new file mode 100644
index 000000000..9936b2454
--- /dev/null
+++ b/email-verifier/src/index.ts
@@ -0,0 +1,47 @@
+import * as bodyParser from 'body-parser';
+import * as dotenv from 'dotenv';
+import * as express from 'express';
+import { filterXSS } from 'xss';
+import { single } from './api';
+import { connect } from './connection';
+import { initConsumer } from './messageBroker';
+import { debugBase, debugRequest } from './utils';
+
+// load environment variables
+dotenv.config();
+
+const app = express();
+
+app.use(bodyParser.json());
+app.use(bodyParser.urlencoded({ extended: true }));
+
+app.post('/verify-single', async (req, res, next) => {
+ debugRequest(debugBase, req);
+
+ const { email } = req.body;
+
+ try {
+ const status = await single(email, true);
+
+ return res.json({ status });
+ } catch (e) {
+ return next(new Error(e));
+ }
+});
+
+// Error handling middleware
+app.use((error, _req, res, _next) => {
+ const msg = filterXSS(error.message);
+
+ debugBase(`Error: `, msg);
+ res.status(500).send(msg);
+});
+
+const { PORT } = process.env;
+
+app.listen(PORT, async () => {
+ await initConsumer();
+ await connect();
+
+ debugBase(`Email verifier server is running on port ${PORT}`);
+});
diff --git a/email-verifier/src/messageBroker.ts b/email-verifier/src/messageBroker.ts
new file mode 100644
index 000000000..b49c60da5
--- /dev/null
+++ b/email-verifier/src/messageBroker.ts
@@ -0,0 +1,58 @@
+import * as amqplib from 'amqplib';
+import * as dotenv from 'dotenv';
+import { bulk, single } from './api';
+import { debugBase } from './utils';
+
+dotenv.config();
+
+const { NODE_ENV, RABBITMQ_HOST = 'amqp://localhost' } = process.env;
+
+let conn;
+let channel;
+
+export const initConsumer = async () => {
+ try {
+ conn = await amqplib.connect(RABBITMQ_HOST);
+ channel = await conn.createChannel();
+
+ // listen for erxes api ===========
+ await channel.assertQueue('erxes-api:email-verifier-notification');
+
+ channel.consume('erxes-api:email-verifier-notification', async msg => {
+ if (msg !== null) {
+ const { action, data } = JSON.parse(msg.content.toString());
+
+ debugBase(`Receiving queue data from erxes-api`, action, data);
+
+ if (action === 'emailVerify') {
+ const { emails, email } = data;
+ email ? single(email) : bulk(emails);
+ }
+
+ channel.ack(msg);
+ }
+ });
+ } catch (e) {
+ debugBase(e.message);
+ }
+};
+
+interface IQueueData {
+ action: string;
+ data: any;
+}
+
+export const sendMessage = async (queueName: string, data: IQueueData) => {
+ if (NODE_ENV === 'test') {
+ return;
+ }
+
+ debugBase(`Sending data from email verifier to ${queueName}`, data);
+
+ try {
+ await channel.assertQueue(queueName);
+ await channel.sendToQueue(queueName, Buffer.from(JSON.stringify(data || {})));
+ } catch (e) {
+ debugBase(e.message);
+ }
+};
diff --git a/email-verifier/src/models.ts b/email-verifier/src/models.ts
new file mode 100644
index 000000000..2ccb2aac6
--- /dev/null
+++ b/email-verifier/src/models.ts
@@ -0,0 +1,56 @@
+import { Document, Model, model, Schema } from 'mongoose';
+
+export const EMAIL_VALIDATION_STATUSES = {
+ VALID: 'valid',
+ INVALID: 'invalid',
+ ACCEPT_ALL_UNVERIFIABLE: 'accept_all_unverifiable',
+ UNKNOWN: 'unknown',
+ DISPOSABLE: 'disposable',
+ CATCHALL: 'catchall',
+ BAD_SYNTAX: 'badsyntax',
+ UNVERIFIABLE: 'unverifiable',
+ ALL: [
+ 'valid',
+ 'invalid',
+ 'accept_all_unverifiable',
+ 'unknown',
+ 'disposable',
+ 'catchall',
+ 'badsyntax',
+ 'unverifiable',
+ ],
+};
+
+interface IEmail {
+ email: string;
+ status: string;
+}
+
+interface IEmailDocument extends IEmail, Document {
+ _id: string;
+}
+
+const emailSchema = new Schema({
+ email: { type: String, unique: true },
+ status: { type: String, enum: EMAIL_VALIDATION_STATUSES.ALL },
+ created: { type: Date, default: Date.now() },
+});
+
+interface IEmailModel extends Model