Note: There is a newer version (2.12.0) of this package available. Click here to view docs for the latest version.
Module email
ballerina/email Ballerina library
2.11.0
Clients
email: ImapClient
Isolated
Represents an IMAP Client, which interacts with an IMAP Server.
Constructor
Gets invoked during the email:ImapClient initialization.
init (string host, string username, string password, *ImapConfiguration clientConfig)- host string - Host of the IMAP Client
- username string - Username of the IMAP Client
- password string - Password of the IMAP Client
- clientConfig *ImapConfiguration - Configurations for the IMAP Client
receiveMessage
Isolated FunctionRemote Function
Reads a message.
email:Message|email:Error emailResponse = imapClient->receiveMessage();
Parameters
- folder string (default DEFAULT_FOLDER) - Folder to read emails. The default value is
INBOX
- timeout decimal (default 30) - Polling timeout period in seconds.
Return Type
close
Isolated FunctionRemote Function
function close() returns Error?Close the client.
email:Error? closeResponse = imapClient->close();
Return Type
- Error? - An
email:Errorif the recipient failed to close the client or else()
email: PopClient
Isolated
Represents a POP Client, which interacts with a POP Server.
Constructor
Gets invoked during the email:PopClient initialization.
init (string host, string username, string password, *PopConfiguration clientConfig)- host string - Host of the POP Client
- username string - Username of the POP Client
- password string - Password of the POP Client
- clientConfig *PopConfiguration - Configurations for the POP Client
receiveMessage
Isolated FunctionRemote Function
Reads a message.
email:Message|email:Error? emailResponse = popClient->receiveMessage();
Parameters
- folder string (default DEFAULT_FOLDER) - Folder to read the emails. The default value is
INBOX
- timeout decimal (default 30) - Polling timeout period in seconds
Return Type
close
Isolated FunctionRemote Function
function close() returns Error?Close the client.
email:Error? closeResponse = popClient->close();
Return Type
- Error? - An
email:Errorif the recipient failed to close the client or else()
email: SmtpClient
Isolated
Represents an SMTP Client, which interacts with an SMTP Server.
Constructor
Gets invoked during the email:SmtpClient initialization.
init (string host, string username, string password, *SmtpConfiguration clientConfig)- host string - Host of the SMTP Client
- username string - Username of the SMTP Client
- password string - Password of the SMTP Client
- clientConfig *SmtpConfiguration - Configurations for SMTP Client
sendMessage
Isolated FunctionRemote Function
Sends an email message.
email:Error? response = smtpClient->sendMessage(email);
Parameters
- email Message - An
email:Messagemessage, which needs to be sent to the recipient
Return Type
- Error? - An
email:Errorif failed to send the message to the recipient or else()
send
Isolated FunctionRemote Function
function send(string|string[] to, string subject, string 'from, string body, *Options options) returns Error?Sends an email message with optional parameters.
email:Error? response = smtpClient->send(toAddress, subject, fromAddress, emailBody, sender="eve@abc.com");
Parameters
- subject string - Subject of email
- 'from string -
- body string - Text body of the email
- options *Options - Optional parameters of the email
Return Type
- Error? - An
email:Errorif failed to send the message to the recipient or else()
Service types
email: Service
Distinct
Represents a Email service.
Constants
email: DEFAULT_FOLDER
Default folder to read emails.
Enums
email: Protocol
Represents protocol options.
Members
TLS
email: Security
Security type.
Members
START_TLS_AUTO - If STARTTLS exists use it else use plaintext
START_TLS_ALWAYS - Use STARTTLS if not available throw error
START_TLS_NEVER - Use plaintext
SSL - Use SSL
Listeners
email: ImapListener
Represents a service listener that monitors the email server location.
Constructor
Gets invoked during the email:ImapListener initialization.
init (ImapListenerConfiguration listenerConfig)- listenerConfig ImapListenerConfiguration -
attach
Isolated Function
Binds a service to the email:ImapListener.
email:Error? result = emailListener.attach(helloService, hello);
Parameters
- s Service - Type descriptor of the service
Return Type
- error? -
()or else aemail:Errorupon failure to register the listener
'start
Isolated Function
function 'start() returns error?Starts the email:ImapListener.
email:Error? result = emailListener.start();
Return Type
- error? - () or else error upon failure to start the listener
detach
Isolated Function
Stops consuming messages and detaches the service from the email:ImapListener.
email:Error? result = emailListener.detach(helloService);
Parameters
- s Service - Type descriptor of the service
Return Type
- error? -
()or else aemail:Errorupon failure to detach the service
immediateStop
Isolated Function
function immediateStop() returns error?Stops the email:ImapListener forcefully.
email:Error? result = emailListener.immediateStop();
Return Type
- error? -
()or else aemail:Errorupon failure to stop the listener
gracefulStop
Isolated Function
function gracefulStop() returns error?Stops the email:ImapListener gracefully.
email:Error? result = emailListener.gracefulStop();
Return Type
- error? - () or else error upon failure to stop the listener
register
Isolated Function
Registers for the Email service.
emailListener.register(helloService, hello);
email: PopListener
Represents a service listener that monitors the email server location.
Constructor
Gets invoked during the email:PopListener initialization.
init (PopListenerConfiguration listenerConfig)- listenerConfig PopListenerConfiguration -
attach
Isolated Function
Binds a service to the email:PopListener.
email:Error? result = emailListener.attach(helloService, hello);
Parameters
- s Service - Type descriptor of the service
Return Type
- error? -
()or else aemail:Errorupon failure to register the listener
'start
Isolated Function
function 'start() returns error?Starts the email:PopListener.
email:Error? result = emailListener.start();
Return Type
- error? -
()or else anemail:Errorupon failure to start the listener
detach
Isolated Function
Stops consuming messages and detaches the service from the email:PopListener.
email:Error? result = emailListener.detach(helloService);
Parameters
- s Service - Type descriptor of the service
Return Type
- error? -
()or else aemail:Errorupon failure to detach the service
immediateStop
Isolated Function
function immediateStop() returns error?Stops the email:PopListener forcefully.
email:Error? result = emailListener.immediateStop();
Return Type
- error? -
()or else aemail:Errorupon failure to stop the listener
gracefulStop
Isolated Function
function gracefulStop() returns error?Stops the email:PopListener gracefully.
email:Error? result = emailListener.gracefulStop();
Return Type
- error? - () or else error upon failure to stop the listener
register
Isolated Function
Registers for the Email service.
emailListener.register(helloService, hello);
Records
email: Attachment
Closed record
Email attachment.
Fields
- filePath string - File path of the attachment
- contentType string - Content Type of the attachment
email: ImapConfiguration
Closed record
Configuration of the IMAP Endpoint.
Fields
- port int(default 993) - Port number of the IMAP server
- security Security(default SSL) - Type of security channel
- secureSocket? SecureSocket - Secure socket configuration
email: ImapListenerConfiguration
Closed record
Configuration for Email listener endpoint.
Fields
- host string - Email server host
- username string - Email server access username
- password string - Email server access password
- pollingInterval decimal(default 30) - Periodic time interval (in seconds) to check new update
- port int(default 993) - Port number of the IMAP server
- security Security(default SSL) - Type of security channel
- secureSocket? SecureSocket - Secure socket configuration
email: Message
Closed record
Email message properties.
Fields
- subject string - Subject of email
- 'from? string -
- body? string - Text typed body of the email message
- htmlBody? string - HTML typed body of the email message
- contentType? string - Content Type of the Body
- sender? string - Sender's address
- attachments? Entity|Attachment|(Entity|Attachment)[] - Email attachements
email: Options
Closed record
Optional parameters for an Email message.
Fields
- htmlBody? string - HTML typed body of the email message
- contentType? string - Content Type of the Body
- sender? string - Sender's address
- attachments? Entity|Attachment|(Entity|Attachment)[] - Email attachements
email: PopConfiguration
Closed record
Configuration of the POP Endpoint.
Fields
- port int(default 995) - Port number of the POP server
- security Security(default SSL) - Type of security channel
- secureSocket? SecureSocket - Secure socket configuration
email: PopListenerConfiguration
Closed record
Configuration for Email listener endpoint.
Fields
- host string - Email server host
- username string - Email server access username
- password string - Email server access password
- pollingInterval decimal(default 30) - Periodic time interval (in seconds) to check new update
- port int(default 995) - Port number of the POP server
- security Security(default SSL) - Type of security channel
- secureSocket? SecureSocket - Secure socket configuration
email: SecureSocket
Closed record
Secure Socket configuration.
Fields
- cert string - Server certificate path
- ciphers? string[] - Ciper used
- verifyHostName boolean(default true) - Enable hostname verification
email: SmtpConfiguration
Closed record
Configuration of the SMTP Endpoint.
Fields
- port int(default 465) - Port number of the SMTP server
- security Security(default SSL) - Type of security channel
- secureSocket? SecureSocket - Secure socket configuration
Errors
email: Error
Distinct
Defines the common error type for the module.