Email - Send Message Conditionally
Send a message to anyone in the world using email, attaching one or more files.
To upload multiple files, use Regex Match Type.
Due to email file size constraints, when the the total file size >10MB, Shipyard will automatically zip the files under the name "Archive.zip".
Note: This Vessel cannot be used to access a local file from your computer.
- A Vessel built with this Blueprint should typically run after a Vessel that either downloads a file to Shipyard or generates a file with code.
|Send Method||EMAIL_SEND_METHOD||Select||✅||SSL: |
|Determines how you want to send the email. Options are TLS and SSL. We generally suggest using TLS when possible.|
|SMTP Host||EMAIL_SMTP_HOST||Alphanumeric||✅||-||-||The server where your email will be sent from. Usually formatted as smtp.domain.com|
|SMTP Port||EMAIL_SMTP_PORT||Alphanumeric||✅||-||-||The port from which your email will be sent. Commonly used ports are 25, 465, and 587. We generally suggest using 587 with TLS.|
|Username||EMAIL_USERNAME||Alphanumeric||✅||-||-||The username that your email provider uses to identify your access to send email.|
|Password||EMAIL_PASSWORD||Password||✅||-||-||The password associated with your username.|
|Sender Address||EMAIL_SENDER_ADDRESS||Alphanumeric||✅||-||-||The email address you want recipients to see when you send an email. We generally suggest keeping the sender address as your own email to ensure that you can appropriately receive replies.|
|Sender Name||EMAIL_SENDER_NAME||Alphanumeric||➖||-||-||The name you want users to see that the email is from. If left blank, the Sender Address will be used.|
|To||EMAIL_TO||Alphanumeric||➖||-||-||The email(s) that you want to send a message to. Can be comma-separated to include multiple email addresses.|
|CC||EMAIL_CC||Alphanumeric||➖||-||-||The email(s) that you want your message to be carbon copied (CCed) to. Can be comma-separated to include multiple email addresses.|
|BCC||EMAIL_BCC||Alphanumeric||➖||-||-||The email(s) that you want to be blind carbon copied (BCCed) to. Can be comma-separated to include multiple email addresses. Emails in this field will receive the email, but will not have their email exposed to all other recipients.|
|Subject||EMAIL_SUBJECT||Alphanumeric||➖||-||-||The subject of the email that you want to send.|
|Message||EMAIL_MESSAGE||Alphanumeric||✅||-||-||The body of the email, containing your main message. This field supports plain text as well as HTML.|
|Send Messages Only When||EMAIL_CONDITIONAL_SEND||Select||✅||File(s) Exist: |
File(s) Don't Exist:
|Determines what condition needs to be met for a message to send. File(s) Exist - Send the message only if a file can be found using the provided folder/filename.ext combination. File(s) Don't Exist - Send the message only if a file cannot found using the provided folder/filename.ext combination.|
|File Name Match Type||EMAIL_SOURCE_FILE_NAME_MATCH_TYPE||Select||✅||Regex: |
|Determines if the text in "File Name" will look for one file with exact match, or multiple files using regex.|
|File Name||EMAIL_SOURCE_FILE_NAME||Alphanumeric||➖||-||-||Name of the target file on Shipyard. Can be regex if "Match Type" is set accordingly|
|Folder Name||EMAIL_SOURCE_FOLDER_NAME||Alphanumeric||➖||-||-||Name of the local folder on Shipyard to upload the target file from. If left blank, will look in the home directory.|
|Include Shipyard Footer?||EMAIL_INCLUDE_SHIPYARD_FOOTER||Boolean||✅||-||Determines if a footer should be sent with the email that links back to the originating Vessel or Fleet.|
Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.
blueprint: Email - Send Message Conditionally
EMAIL_SEND_METHOD: tls ## REQUIRED
EMAIL_SMTP_HOST: null ## REQUIRED
EMAIL_SMTP_PORT: null ## REQUIRED
EMAIL_USERNAME: null ## REQUIRED
EMAIL_PASSWORD: null ## REQUIRED
EMAIL_SENDER_ADDRESS: null ## REQUIRED
EMAIL_MESSAGE: null ## REQUIRED
EMAIL_CONDITIONAL_SEND: file_exists ## REQUIRED
EMAIL_SOURCE_FILE_NAME_MATCH_TYPE: exact_match ## REQUIRED
EMAIL_INCLUDE_SHIPYARD_FOOTER: true ## REQUIRED