/*@jsxRuntime automatic @jsxImportSource react*/ const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; function _createMdxContent(props) { const _components = Object.assign({ p: "p", a: "a", strong: "strong", h2: "h2", ol: "ol", li: "li", pre: "pre", code: "code", span: "span", ul: "ul", blockquote: "blockquote", img: "img" }, _provideComponents(), props.components); return _jsxs(_Fragment, { children: [_jsx(_components.p, { children: "Automated email sequences are an incredible marketing tool for any startup. An email inbox is one of the few 1:1 marketing channels at your disposal. Use it well." }), "\n", _jsxs(_components.p, { children: ["The ", _jsx(_components.a, { href: "__GHOST_URL__/candymail", children: "Candymail NPM package" }), " allows you to send marketing email sequences directly from your Node.js server from a single JSON file. Think of it as a *", _jsx(_components.strong, { children: "*docker.yaml**" }), " but for email marketing."] }), "\n", _jsxs(_components.p, { children: ["Full docs — ", _jsx(_components.a, { href: "https://candymail.saasbase.dev/", children: "https://candymail.saasbase.dev" })] }), "\n", _jsxs(_components.p, { children: ["Let’s say we are building a brand new video editor for the web and looking to delight our new users. We can set up an *", _jsx(_components.strong, { children: "*Onboarding**" }), " email sequence that welcomes our users and slowly introduces them to the platform."] }), "\n", _jsx(_components.p, { children: "Let’s get started." }), "\n", _jsx(_components.h2, { children: "Step 1: Define the Onboarding Email Sequence" }), "\n", _jsx(_components.p, { children: "Here are 3 emails I would add to my sequence to onboard a new user:" }), "\n", _jsxs(_components.ol, { children: ["\n", _jsx(_components.li, { children: "Welcome the user immediately when they sign up" }), "\n"] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "hljs language-text", children: "Subject: Welcome to VideoMaker+\n\nThanks for joining! You’re officially a part of the VideoMaker+ family! Join 100’s of passionate filmmakers like you making a difference in everyday life by making the most wonderful content.\n" }) }), "\n", _jsxs(_components.ol, { start: "2", children: ["\n", _jsx(_components.li, { children: "1 day later — Show the user the most basic way to get started with the platform" }), "\n"] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "hljs language-text", children: "Subject: How to edit your first video?\n\nReady to get started? Here’s how you can add subtitles to your first video and add some flair:\n\n1. Record 1-min video of you talking into the camera\n2. Import the footage into VideoMaker+ app\n3. Click on Effects > Retro\n4. Turn on: Automatic Subtitles\n5. Export!\n And that’s it. You now have a retro-looking video with auto-generated subtitles ready to be shared with the world!\n" }) }), "\n", _jsxs(_components.ol, { start: "3", children: ["\n", _jsx(_components.li, { children: "3 days later — Check up on how they’re doing and gather feedback" }), "\n"] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "hljs language-text", children: "Subject: A friendly check-in from VideoMaker+\n\nLooks like you’ve been using VideoMaker+ in the last few days — and we love that! I just wanted to quickly check-in and how your experience has been with our service.\n\n1. How did you hear about VideoMaker+?\n2. What do you like/dislike about VideoMaker+?\n3. What can we do to improve your experience?\n\nNow that we know what the content is going to look like. Let’s create our automation file.\n" }) }), "\n", _jsx(_components.h2, { children: "Step 2: Create a new automation file" }), "\n", _jsxs(_components.p, { children: ["Candymail uses a single JSON file to describe the automation sequence. The above definition can be encoded into a ", _jsx(_components.code, { children: "candymail.automation.json" }), " like so,"] }), "\n", _jsx(_components.pre, { children: _jsxs(_components.code, { className: "hljs language-json", children: [_jsx(_components.span, { className: "hljs-punctuation", children: "{" }), "\n ", _jsx(_components.span, { className: "hljs-attr", children: "\"workflows\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: ":" }), " ", _jsx(_components.span, { className: "hljs-punctuation", children: "[" }), "\n ", _jsx(_components.span, { className: "hljs-punctuation", children: "{" }), "\n ", _jsx(_components.span, { className: "hljs-attr", children: "\"name\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: ":" }), " ", _jsx(_components.span, { className: "hljs-string", children: "\"onboarding\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: "," }), "\n ", _jsx(_components.span, { className: "hljs-attr", children: "\"description\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: ":" }), " ", _jsx(_components.span, { className: "hljs-string", children: "\"Onboard new VideoMaker+ users\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: "," }), "\n ", _jsx(_components.span, { className: "hljs-attr", children: "\"trigger_name\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: ":" }), " ", _jsx(_components.span, { className: "hljs-string", children: "\"onboarding\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: "," }), "\n ", _jsx(_components.span, { className: "hljs-attr", children: "\"emails\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: ":" }), " ", _jsx(_components.span, { className: "hljs-punctuation", children: "[" }), "\n ", _jsx(_components.span, { className: "hljs-punctuation", children: "{" }), "\n ", _jsx(_components.span, { className: "hljs-attr", children: "\"trigger\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: ":" }), " ", _jsx(_components.span, { className: "hljs-string", children: "\"time\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: "," }), "\n ", _jsx(_components.span, { className: "hljs-attr", children: "\"sendDelay\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: ":" }), " ", _jsx(_components.span, { className: "hljs-number", children: "1" }), _jsx(_components.span, { className: "hljs-punctuation", children: "," }), "\n ", _jsx(_components.span, { className: "hljs-attr", children: "\"subject\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: ":" }), " ", _jsx(_components.span, { className: "hljs-string", children: "\"Welcome to VideoMaker+\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: "," }), "\n ", _jsx(_components.span, { className: "hljs-attr", children: "\"body\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: ":" }), " ", _jsx(_components.span, { className: "hljs-string", children: "\"

Thanks for joining!

You're officially a part of the VideoMaker+ family! Join 100's of passionate film makers like you making a difference in everyday life by making the most wonderful content.

Ready to get started? Here's how you can add subtitles to your first video and add some flair:

1. Record 1-min video of you talking into the camera
2. Import the footage into VideoMaker+ app
3. Click on Effects > Retro
4. Turn on: Automatic Subtitles
5. Export!

And that's it. You now have a retro looking video with auto-generated subtitles ready to be shared with the world!

Looks like you've been using VideoMaker+ in the last few days - and we love that! I just wanted to quickly check-in and how your experience has been with the app.

1. How did you hear about VideoMaker+?
2. What do you like/dislike about VideoMaker+?
3. What can we do to improve your experience?

\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: "," }), "\n ", _jsx(_components.span, { className: "hljs-attr", children: "\"from\"" }), _jsx(_components.span, { className: "hljs-punctuation", children: ":" }), " ", _jsx(_components.span, { className: "hljs-string", children: "\"sender@gmail.com\"" }), "\n ", _jsx(_components.span, { className: "hljs-punctuation", children: "}" }), "\n ", _jsx(_components.span, { className: "hljs-punctuation", children: "]" }), "\n ", _jsx(_components.span, { className: "hljs-punctuation", children: "}" }), "\n ", _jsx(_components.span, { className: "hljs-punctuation", children: "]" }), "\n", _jsx(_components.span, { className: "hljs-punctuation", children: "}" }), "\n"] }) }), "\n", _jsxs(_components.p, { children: ["Note: Remember to change the ", _jsx(_components.code, { children: "sender@gmail.com" }), " to your own sender email address."] }), "\n", _jsx(_components.h2, { children: "Step 3: Set up a basic Express Server" }), "\n", _jsx(_components.p, { children: "Create a new folder." }), "\n", _jsxs(_components.p, { children: ["Let’s initialize our project by creating a ", _jsx(_components.code, { children: "package.json" })] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "hljs language-bash", children: "npm init -y\n" }) }), "\n", _jsx(_components.p, { children: "Install dependencies with a quick," }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "hljs language-bash", children: "npm install express\n" }) }), "\n", _jsxs(_components.p, { children: ["Add another file named ", _jsx(_components.code, { children: "app.js" })] }), "\n", _jsx(_components.pre, { children: _jsxs(_components.code, { className: "hljs language-js", children: [_jsx(_components.span, { className: "hljs-keyword", children: "const" }), " express = ", _jsx(_components.span, { className: "hljs-built_in", children: "require" }), "(", _jsx(_components.span, { className: "hljs-string", children: "'express'" }), ");\n", _jsx(_components.span, { className: "hljs-keyword", children: "const" }), " port = ", _jsx(_components.span, { className: "hljs-number", children: "3000" }), ";\n", _jsx(_components.span, { className: "hljs-keyword", children: "const" }), " app = ", _jsx(_components.span, { className: "hljs-title function_", children: "express" }), "();\napp.", _jsx(_components.span, { className: "hljs-title function_", children: "get" }), "(", _jsx(_components.span, { className: "hljs-string", children: "'/'" }), ", ", _jsx(_components.span, { className: "hljs-keyword", children: "async" }), " ", _jsx(_components.span, { className: "hljs-keyword", children: "function" }), "(", _jsx(_components.span, { className: "hljs-params", children: "req, res, next" }), ") {\n\tres.", _jsx(_components.span, { className: "hljs-title function_", children: "send" }), "(", _jsx(_components.span, { className: "hljs-string", children: "'Hello World!'" }), ")\n});\napp.", _jsx(_components.span, { className: "hljs-title function_", children: "listen" }), "(port, ", _jsx(_components.span, { className: "hljs-function", children: "() =>" }), " ", _jsx(_components.span, { className: "hljs-variable language_", children: "console" }), ".", _jsx(_components.span, { className: "hljs-title function_", children: "log" }), "(", _jsxs(_components.span, { className: "hljs-string", children: ["`Listening on port ", _jsx(_components.span, { className: "hljs-subst", children: "${port}" }), "!`"] }), ");)\n"] }) }), "\n", _jsx(_components.p, { children: "We can now run our simple server by running," }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "hljs language-bash", children: "npm start\n" }) }), "\n", _jsxs(_components.p, { children: ["Our application should be live at ", _jsx(_components.a, { href: "http://localhost:4242/", children: "http://localhost:4242" }), "."] }), "\n", _jsx(_components.h2, { children: "Step 4: Install Candymail" }), "\n", _jsxs(_components.p, { children: ["Import the ", _jsx(_components.code, { children: "candymail.automation.file" }), " to the root level of the project directory."] }), "\n", _jsx(_components.p, { children: "Let’s install Candymail by running," }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "hljs language-bash", children: "npm install --save candymail\n" }) }), "\n", _jsx(_components.p, { children: "In app.js," }), "\n", _jsx(_components.pre, { children: _jsxs(_components.code, { className: "hljs language-js", children: [_jsx(_components.span, { className: "hljs-built_in", children: "require" }), "(", _jsx(_components.span, { className: "hljs-string", children: "'dotenv'" }), ").", _jsx(_components.span, { className: "hljs-title function_", children: "config" }), "();\n", _jsx(_components.span, { className: "hljs-keyword", children: "const" }), " candymail = ", _jsx(_components.span, { className: "hljs-built_in", children: "require" }), "(", _jsx(_components.span, { className: "hljs-string", children: "'candymail'" }), ");\n", _jsx(_components.span, { className: "hljs-keyword", children: "const" }), " express = ", _jsx(_components.span, { className: "hljs-built_in", children: "require" }), "(", _jsx(_components.span, { className: "hljs-string", children: "'express'" }), ");\n", _jsx(_components.span, { className: "hljs-keyword", children: "const" }), " app = ", _jsx(_components.span, { className: "hljs-title function_", children: "express" }), "();\n", _jsx(_components.span, { className: "hljs-keyword", children: "const" }), " port = ", _jsx(_components.span, { className: "hljs-number", children: "3000" }), ";\n", _jsx(_components.span, { className: "hljs-keyword", children: "const" }), " automation = ", _jsx(_components.span, { className: "hljs-built_in", children: "require" }), "(", _jsx(_components.span, { className: "hljs-string", children: "'./candymail.automation.json'" }), ") candymail.", _jsx(_components.span, { className: "hljs-title function_", children: "init" }), "(automation.", _jsx(_components.span, { className: "hljs-property", children: "workflows" }), ", {\n\t", _jsx(_components.span, { className: "hljs-attr", children: "mail" }), ": {\n\t\t", _jsx(_components.span, { className: "hljs-attr", children: "host" }), ": ", _jsx(_components.span, { className: "hljs-string", children: "'smtp.gmail.com'" }), ",\n\t\t", _jsx(_components.span, { className: "hljs-attr", children: "port" }), ": ", _jsx(_components.span, { className: "hljs-number", children: "465" }), ",\n\t\t", _jsx(_components.span, { className: "hljs-attr", children: "secure" }), ": ", _jsx(_components.span, { className: "hljs-literal", children: "true" }), ",\n\t\t", _jsx(_components.span, { className: "hljs-attr", children: "auth" }), ": {\n\t\t\t", _jsx(_components.span, { className: "hljs-attr", children: "user" }), ": process.", _jsx(_components.span, { className: "hljs-property", children: "env" }), ".", _jsx(_components.span, { className: "hljs-property", children: "MAIL_USER" }), ",\n\t\t\t", _jsx(_components.span, { className: "hljs-attr", children: "pass" }), ": process.", _jsx(_components.span, { className: "hljs-property", children: "env" }), ".", _jsx(_components.span, { className: "hljs-property", children: "MAIL_PASSWORD" }), ",\n\t\t},\n\t\t", _jsx(_components.span, { className: "hljs-attr", children: "tls" }), ": {\n\t\t\t", _jsx(_components.span, { className: "hljs-attr", children: "rejectUnauthorized" }), ": ", _jsx(_components.span, { className: "hljs-literal", children: "true" }), ",\n\t\t},\n\t},\n\t", _jsx(_components.span, { className: "hljs-attr", children: "hosting" }), ": {\n\t\t", _jsx(_components.span, { className: "hljs-attr", children: "url" }), ": process.", _jsx(_components.span, { className: "hljs-property", children: "env" }), ".", _jsx(_components.span, { className: "hljs-property", children: "HOSTING_URL" }), "\n\t},\n\t", _jsx(_components.span, { className: "hljs-attr", children: "db" }), ": {\n\t\t", _jsx(_components.span, { className: "hljs-attr", children: "reset" }), ": ", _jsx(_components.span, { className: "hljs-literal", children: "true" }), "\n\t},\n\t", _jsx(_components.span, { className: "hljs-attr", children: "debug" }), ": {\n\t\t", _jsx(_components.span, { className: "hljs-attr", children: "trace" }), ": ", _jsx(_components.span, { className: "hljs-literal", children: "true" }), "\n\t},\n}).", _jsx(_components.span, { className: "hljs-title function_", children: "then" }), "(", _jsxs(_components.span, { className: "hljs-function", children: ["(", _jsx(_components.span, { className: "hljs-params", children: "e" }), ") =>"] }), " {\n\tcandymail.", _jsx(_components.span, { className: "hljs-title function_", children: "start" }), "();\n\tapp.", _jsx(_components.span, { className: "hljs-title function_", children: "get" }), "(", _jsx(_components.span, { className: "hljs-string", children: "'/'" }), ", ", _jsx(_components.span, { className: "hljs-keyword", children: "async" }), " (req, res) => {\n\t\tres.", _jsx(_components.span, { className: "hljs-title function_", children: "send" }), "(", _jsx(_components.span, { className: "hljs-string", children: "'Go to /start to trigger the first workflow'" }), ");\n\t});\n\tapp.", _jsx(_components.span, { className: "hljs-title function_", children: "listen" }), "(port, ", _jsx(_components.span, { className: "hljs-function", children: "() =>" }), " {\n\t\t", _jsx(_components.span, { className: "hljs-variable language_", children: "console" }), ".", _jsx(_components.span, { className: "hljs-title function_", children: "log" }), "(", _jsxs(_components.span, { className: "hljs-string", children: ["`Learn about our new features at http://localhost:", _jsx(_components.span, { className: "hljs-subst", children: "${port}" }), "`"] }), ")\n\t});\n})\n"] }) }), "\n", _jsx(_components.h2, { children: "Step 5: Add env vars" }), "\n", _jsxs(_components.p, { children: ["Create a file at root called ", _jsx(_components.code, { children: ".env" })] }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "hljs language-text", children: "MAIL_USER=email@gmail.com\nMAIL_PASSWORD=password\nRECIPIENT_EMAIL=user@gmail.com\nHOSTING_URL=http://localhost:3000\n" }) }), "\n", _jsxs(_components.ul, { children: ["\n", _jsxs(_components.li, { children: ["MAIL_USER and MAIL_PASSWORD: Credentials from your SMTP email service. ", _jsx(_components.a, { href: "https://candymail.saasbase.dev/mail-providers/send-emails-using-gmail", children: "You can use your Gmail to test it out." })] }), "\n"] }), "\n", _jsxs(_components.blockquote, { children: ["\n", _jsx(_components.p, { children: _jsxs(_components.strong, { children: ["Using Gmail to send emails in Production is not recommended. ", _jsx(_components.a, { href: "https://candymail.saasbase.dev/mail-providers/send-emails-using-mailgun", children: "Use a transactional email service like Mailgun." })] }) }), "\n"] }), "\n", _jsx(_components.h2, { children: "Step 6: Set up a \"Sign up\" endpoint" }), "\n", _jsxs(_components.p, { children: ["Let’s set up an ", _jsx(_components.code, { children: "/signup" }), " endpoint to capture when a user successfully signs up."] }), "\n", _jsx(_components.pre, { children: _jsxs(_components.code, { className: "hljs language-js", children: ["app.", _jsx(_components.span, { className: "hljs-title function_", children: "post" }), "(", _jsx(_components.span, { className: "hljs-string", children: "\"/signup\"" }), ", ", _jsxs(_components.span, { className: "hljs-function", children: ["(", _jsx(_components.span, { className: "hljs-params", children: "req, res" }), ") =>"] }), " {\n ", _jsx(_components.span, { className: "hljs-keyword", children: "const" }), " user = process.", _jsx(_components.span, { className: "hljs-property", children: "env" }), ".", _jsx(_components.span, { className: "hljs-property", children: "RECIPIENT_EMAIL" }), ";\n candymail.", _jsx(_components.span, { className: "hljs-title function_", children: "runWorkflow" }), "(", _jsx(_components.span, { className: "hljs-string", children: "\"onboarding\"" }), ", user);\n res.", _jsx(_components.span, { className: "hljs-title function_", children: "send" }), "(", _jsx(_components.span, { className: "hljs-string", children: "\"onboarding started\"" }), ");\n});\n"] }) }), "\n", _jsxs(_components.p, { children: ["Perfect! Now when the user ", _jsx(_components.code, { children: "abc@gmail.com" }), " signs up, they will receive a sequence of 3 emails as part of the onboarding process."] }), "\n", _jsxs(_components.p, { children: ["But what if the user doesn't want to not receive the emails anymore? Fear not, every email is sent out with an *", _jsx(_components.strong, { children: "*Unsubscribe**" }), " link in the footer that makes a GET request to the ", _jsx(_components.code, { children: "/unsubscribe" }), " endpoint on your hosting server."] }), "\n", _jsx(_components.h2, { children: "Step 7: Set up Unsubscribe" }), "\n", _jsx(_components.pre, { children: _jsxs(_components.code, { className: "hljs language-js", children: ["app.", _jsx(_components.span, { className: "hljs-title function_", children: "get" }), "(", _jsx(_components.span, { className: "hljs-string", children: "\"/unsubscribe\"" }), ", ", _jsxs(_components.span, { className: "hljs-function", children: ["(", _jsx(_components.span, { className: "hljs-params", children: "req, res" }), ") =>"] }), " {\n ", _jsx(_components.span, { className: "hljs-keyword", children: "const" }), " { email } = req.", _jsx(_components.span, { className: "hljs-property", children: "query" }), ";\n\n candymail.", _jsx(_components.span, { className: "hljs-title function_", children: "unsubscribeUser" }), "(email);\n res.", _jsx(_components.span, { className: "hljs-title function_", children: "send" }), "(", _jsxs(_components.span, { className: "hljs-string", children: ["`Sent an unsubscribe request for ", _jsx(_components.span, { className: "hljs-subst", children: "${email}" }), "`"] }), ");\n});\n"] }) }), "\n", _jsx(_components.h2, { children: "Step 8: Test it out" }), "\n", _jsx(_components.pre, { children: _jsx(_components.code, { className: "hljs language-bash", children: "npm start\n" }) }), "\n", _jsxs(_components.p, { children: ["Let’s fire up Postman and make a POST request to ", _jsx(_components.code, { children: "/signup" }), " . This will start the automation sequence - *", _jsx(_components.strong, { children: "*Onboarding**" }), ". We are also printing out the scheduled messages to be sent out at what time. Notice that the time listed is in UTC.\n", _jsx(_components.img, { src: "https://miro.medium.com/max/1400/1*aV636JoqNWaIZYMxrGw7TQ.png", alt: "" }), "\nWe should expect 3 emails to be sent — 1 at the top of the next hour, the next one in 24 hours, and the one after that in 72 hours."] }), "\n", _jsxs(_components.p, { children: ["Here’s the first email I received in my inbox.\n", _jsx(_components.img, { src: "https://miro.medium.com/max/1400/1*REaMB95riEFGAflZ0gqlAA.png", alt: "" }), "\nEvery email comes with an unsubscribe link that the user can click on and they will stop getting future communications."] })] }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = Object.assign({}, _provideComponents(), props.components); return MDXLayout ? _jsx(MDXLayout, Object.assign({}, props, { children: _jsx(_createMdxContent, props) })) : _createMdxContent(props); } return { default: MDXContent };

Email Marketing

.css-277wjy{position:static;color:var(--chakra-colors-gray-800);}.css-277wjy::before{content:'';cursor:inherit;display:block;position:absolute;top:0px;left:0px;z-index:0;width:100%;height:100%;}How to send automated email sequences using Node.js and Candymail

How to send automated email sequences using Node.js and Candymail