Comment on page
Send Mail

Send Mail Documentation
The Send Mail node in AugeLab Studio allows you to send emails using the Gmail SMTP server. It enables you to send email messages with specified subject, content, sender address, receiver address, and optional attachment file.
Node Overview
The Send Mail node sends an email message using the Gmail SMTP server. It requires a sender's Gmail address and the associated Gmail API password. The node allows you to specify the subject, content, and receiver address of the email. Additionally, you can attach a file to the email if needed.
Node Properties
Node Title: Send Mail
Node ID: OP_NODE_SEND_MAIL
Inputs
The Send Mail node has the following input sockets:
Subject: The subject of the email. Connect a string to this socket.
Content: The content or body of the email. Connect a string to this socket.
Sender Address: The sender's email address. This should be a Gmail address. Connect a string to this socket.
Mail API Password: The Gmail API password for the sender's email address. Connect a string to this socket.
Receiver Address: The receiver's email address. This can be any valid email address. Connect a string to this socket.
Attachment File Path: The file path of an optional attachment to include in the email. Connect a string containing the file path to this socket. This input is optional and can be left unconnected or set to None.
Trigger: A boolean trigger to initiate the email sending process. Set this input to True to send the email.
Outputs
The Send Mail node has the following output socket:
Success: A boolean value indicating whether the email was sent successfully. It will output True if the email was sent successfully, and False otherwise.
Node Configuration
The Send Mail node requires a Gmail address and its associated Gmail API password to send emails. Make sure to provide valid credentials for successful email sending. Ensure that you have enabled the Gmail API for the sender's Gmail address.
Usage
1.Drag and drop the Send Mail node from the node library onto the canvas in AugeLab Studio.
2.Connect the necessary input values to the respective input sockets of the Send Mail node:
Connect the email subject to the Subject input socket.
Connect the email content to the Content input socket.
Connect the sender's Gmail address to the Sender Address input socket.
Connect the Gmail API password for the sender's Gmail address to the Mail API Password input socket.
Connect the receiver's email address to the Receiver Address input socket.
Optionally, connect the file path of an attachment file to the Attachment File Path input socket. Leave this socket unconnected or set it to None if no attachment is required.
Set the Trigger input socket to True to initiate the email sending process.
3.Run the pipeline to send the email when the trigger is activated.
4.The Send Mail node will send an email using the provided information.
5.The Success output socket will indicate whether the email was sent successfully (True) or encountered an error (False).
Notes
The Send Mail node utilizes the smtplib library in Python to send emails using the Gmail SMTP server.
This node currently supports sending emails only from Gmail addresses.
The sender's Gmail address should be activated via the Gmail API to allow sending emails programmatically.
The receiver's email address can be any valid email address, not limited to Gmail.
An attachment file can be included in the email by providing the file path to the Attachment File Path input socket. Ensure that the specified file exists and is accessible.
The email sending process is triggered by setting the Trigger input socket to True. This allows you to control when the email should be sent within your pipeline.
The Success output socket indicates whether the email was sent successfully (True) or encountered an error (False).
If the SMTP session encounters an error, the node will automatically close the session to release resources.
It is recommended to provide valid and secure credentials for the sender's Gmail address to ensure successful email sending.
That concludes the documentation for the Send Mail node in AugeLab Studio. This node enables you to send emails using the Gmail SMTP server, providing a convenient way to incorporate email notifications and communications into your data processing pipelines.
Function Blocks - Outputs - Previous
Scope
Next - Function Blocks - Outputs
Show Image
Last modified 4mo ago