Big-Data-HPC-Platform/ecllibrary/std/system/Email.ecl

/*##############################################################################
## HPCC SYSTEMS software Copyright (C) 2012 HPCC Systems®.  All rights reserved.
############################################################################## */

import lib_fileservices;

RETURN MODULE

/*
 * Sends an email message using a mail server.
 *
 * @param to            A comma-delimited list of the addresses of the intended recipients.
 * @param subject       The subject line.
 * @param body          The text of the email to send.
 * @param mailServer    The name of the mail server. Defaults to GETENV(SMTPserver).
 * @param port          The port number on the server to connect to. Defaults to GETENV(SMTPport)
 * @param sender        The sender of the email. Defaults to GETENV(emailSenderAddress)
 * @param cc            Optional comma-delimited addresses of carbon-copy recipients. Defaults to an empty string (none).
 * @param bcc           Optional comma-delimited addresses of blind-carbon-copy recipients. Defaults to an empty string (none).
 * @param highPriority  Optional; if true, message is sent with high priority. Defaults to false (normal priority).
 */

EXPORT SendEmail(varstring to, varstring subject, varstring body, varstring mailServer=GETENV('SMTPserver'), unsigned4 port=(unsigned4) GETENV('SMTPport', '25'), varstring sender=GETENV('emailSenderAddress'), varstring cc='', varstring bcc='', boolean highPriority=false) :=
    lib_fileservices.FileServices.SendEmail(to, subject, body, mailServer, port, sender, cc, bcc, highPriority);

/*
 * Sends an email message with a text attachment using a mail server.
 *
 * @param to            A comma-delimited list of the addresses of the intended recipients.
 * @param subject       The subject line.
 * @param body          The text of the email to send.
 * @param attachment    The text of the attachment to send.  Must be a valid string with no embedded nulls.
 * @param mailServer    The name of the mail server. Defaults to GETENV(SMTPserver).
 * @param port          The port number on the server to connect to. Defaults to GETENV(SMTPport)
 * @param sender        The sender of the email. Defaults to GETENV(emailSenderAddress)
 * @param cc            Optional comma-delimited addresses of carbon-copy recipients. Defaults to an empty string (none).
 * @param bcc           Optional comma-delimited addresses of blind-carbon-copy recipients. Defaults to an empty string (none).
 * @param highPriority  Optional; if true, message is sent with high priority. Defaults to false (normal priority).
 */

EXPORT SendEmailAttachText(varstring to, varstring subject, varstring body, varstring attachment, varstring mimeType, varstring attachmentName, varstring mailServer=GETENV('SMTPserver'), unsigned4 port=(unsigned4) GETENV('SMTPport', '25'), varstring sender=GETENV('emailSenderAddress'), varstring cc='', varstring bcc='', boolean highPriority=false) :=
    lib_fileservices.FileServices.SendEmailAttachText(to, subject, body, attachment, mimeType, attachmentName, mailServer, port, sender, cc, bcc, highPriority);

/*
 * Sends an email message with an arbitrary attachment using a mail server.
 *
 * @param to                A comma-delimited list of the addresses of the intended recipients.
 * @param subject           The subject line.
 * @param body              The text of the email to send.
 * @param attachment        The attachment to send.
 * @param mimeType          The mime type of the attachment.  E.g. 'text/plain; charset=ISO-8859-3'
 * @param attachmentName    The name of the attachement - often a filename.
 * @param mailServer        The name of the mail server. Defaults to GETENV(SMTPserver).
 * @param port              The port number on the server to connect to. Defaults to GETENV(SMTPport)
 * @param sender            The sender of the email. Defaults to GETENV(emailSenderAddress)
 * @param cc                Optional comma-delimited addresses of carbon-copy recipients. Defaults to an empty string (none).
 * @param bcc               Optional comma-delimited addresses of blind-carbon-copy recipients. Defaults to an empty string (none).
 * @param highPriority  Optional; if true, message is sent with high priority. Defaults to false (normal priority).
 */

EXPORT SendEmailAttachData(varstring to, varstring subject, varstring body, data attachment, varstring mimeType, varstring attachmentName, varstring mailServer=GETENV('SMTPserver'), unsigned4 port=(unsigned4) GETENV('SMTPport', '25'), varstring sender=GETENV('emailSenderAddress'), varstring cc='', varstring bcc='', boolean highPriority=false) :=
    lib_fileservices.FileServices.SendEmailAttachData(to, subject, body, attachment, mimeType, attachmentName, mailServer, port, sender, cc, bcc, highPriority);

END;