Overview
Welcome to the Email integration guide for Julep! This integration allows you to send emails using SMTP, enabling you to build workflows that require email communication capabilities. Whether you’re sending notifications or managing email campaigns, this guide will walk you through the setup and usage.Prerequisites
To use the Email integration, you need SMTP server credentials, including the host, port, username, and password. Ensure you have access to an SMTP server before proceeding.
How to Use the Integration
To get started with the Email integration, follow these steps to configure and create a task:1
Configure Your SMTP Server
Add your SMTP server credentials to the tools section of your task. This will allow Julep to authenticate requests to your email server on your behalf.
2
Create Task Definition
Use the following YAML configuration to define your email sending task:
Email Example
YAML Explanation
Basic Configuration
Basic Configuration
- name: A descriptive name for the task, in this case, “Email Task”.
- tools: This section lists the tools or integrations being used. Here,
email_tool
is defined as an integration tool.
Tool Configuration
Tool Configuration
- type: Specifies the type of tool, which is
integration
in this context. - integration: Details the provider and setup for the integration.
- provider: Indicates the service provider, which is
email
for Email integration. - method: Specifies the method to be used. Default is
send
if not specified. If not specified, the method will besend
by default. - setup: Contains configuration details.
- host: (Required) The SMTP server host.
- port: (Required) The SMTP server port.
- user: (Required) The SMTP server username.
- password: (Required) The SMTP server password.
- provider: Indicates the service provider, which is
Workflow Configuration
Workflow Configuration
- main: Defines the main execution steps.
- tool: Refers to the tool defined earlier (
email_tool
). - arguments: Specifies the input parameters for the tool:
- to: The email address to send the email to.
- from: The email address to send the email from.
- subject: The subject of the email.
- body: The body of the email.
- tool: Refers to the tool defined earlier (
- Please note that the
to
andfrom
arguments can accept a single email address only. - Replace the
YOUR_USERNAME
andYOUR_PASSWORD
with your actual SMTP server credentials. - Remember to replace the SMTP server credentials and email addresses with your actual information. Ensure your SMTP server allows sending emails from the specified addresses.
Conclusion
With the Email integration, you can efficiently send emails using SMTP. This integration provides a robust solution for email communication, enhancing your workflow’s capabilities and user experience.For more information, please refer to the SMTP documentation.