Module : email

Module Overview

This module contains functions to perform email operations such as sending and reading emails using the SMTP, POP3, and IMAP4 protocols.

Client

This module supports the following three client types.

• email:SmtpClient - The client, which supports sending an email using the SMTP protocol.
• email:PopClient - The client, which supports receiving an email using the POP3 protocol.
• email:ImapClient - The client, which supports receiving an email using the IMAP4 protocol.

SMTP Client

To send an email using the SMTP protocol, you must first create an email:SmtpClient object. The code for creating an email:SmtpClient can be found below.

Creating a client

The following code creates an SMTP client, which connects to the default port(465) and enables SSL.

email:SmtpClient smtpClient = new ("smtp.email.com",
                                   "sender@email.com",
                                   "pass123");

The port number of the server and/or the SSL support can also be configured by passing the following configurations.

email:SmtpConfig smtpConfig = {
    port: 465, // Can use ports, 465, 587 or 25
    enableSsl: true // Set true to enable SSL (SMTPS connections)
};

email:SmtpClient smtpClient = new ("smtp.email.com",
                                   "sender@email.com",
                                   "pass123",
                                    smtpConfig);

Sending an email

Once the email:SmtpClient is created, an email can be sent using the SMTP protocol through that client. Samples for this operation can be found below.

email:Email email = {
    to: ["receiver1@email.com", "receiver2@email.com"],
    cc: ["receiver3@email.com", "receiver4@email.com"],
    bcc: ["receiver5@email.com"],
    subject: "Sample Email",
    body: "This is a sample email.",
    'from: "author@email.com",
    sender: "sender@email.com",
    replyTo: ["replyTo1@email.com", "replyTo2@email.com"]
};

email:Error? response = smtpClient->send(email);

POP3 Client

To receive an email using the POP3 protocol, you must first create an email:PopClient object. The code for creating an email:PopClient can be found below.

Creating a client

The following code creates a POP3 client, which connects to the default port(995) and enables SSL.

email:PopClient|email:Error popClient = new ("pop.email.com",
                                             "reader@email.com",
                                             "pass456");

The port number of the server and/or the SSL support can also be configured by passing the following configurations.

email:PopConfig popConfig = {
    port: 995,
    enableSsl: true
};

email:PopClient|email:Error popClient = new ("pop.email.com",
                                             "reader@email.com",
                                             "pass456",
                                              popConfig);

Receiving an email

Once the email:PopClient is created, emails can be received using the POP3 protocol through that client. Samples for this operation can be found below.

email:Email|email:Error? emailResponse = popClient->read();

IMAP4 Client

To receive an email using the IMAP4 protocol, you must first create an email:ImapClient object. The code for creating an email:ImapClient can be found below.

Creating a client

The following code creates an IMAP4 client, which connects to the default port(993) and enables SSL.

email:ImapClient|email:Error imapClient = new ("imap.email.com",
                                               "reader@email.com",
                                               "pass456");

The port number of the server and/or the SSL support can also be configured by passing the following configurations.

email:ImapConfig imapConfig = {
    port: 993,
    enableSsl: true
};

email:ImapClient|email:Error imapClient = new ("imap.email.com",
                                               "reader@email.com",
                                               "pass456",
                                                imapConfig);

Receiving an email

Once the email:ImapClient is created, emails can be received using the IMAP4 protocol through that client. Samples for this operation can be found below.

email:Email|email:Error emailResponse = imapClient->read();

For information on the operations, which you can perform with this module, see the below Functions. For examples on the usage of the operation, see the Send and Receive Emails Example.

Records

Detail	The details of an error.
Email	Email message properties.
ImapConfig	Configuration of the IMAP Endpoint.
PopConfig	Configuration of the POP Endpoint.
SmtpConfig	Configuration of the SMTP Endpoint.

Clients

ImapClient	Represents an IMAP Client, which interacts with an IMAP Server.
PopClient	Represents a POP Client, which interacts with a POP Server.
SmtpClient	Represents an SMTP Client, which interacts with an SMTP Server.

Constants

DEFAULT_FOLDER	Default folder to read emails.
SEND_ERROR	Represents the reason for the email sending related errors.
READ_CLIENT_INIT_ERROR	Represents the reason for the server access failure errors.
READ_ERROR	Represents the reason for the email receipt related errors.

Types

Error

Represents email related errors.

Errors

ReadClientInitError	Represents an error that occurs when the email store access fails.
ReadError	Represents an error that occurs an email read operation fails.
SendError	Represents an error that occurs when sending an email fails.