| |
OScript API/Built-in Package Index |
The built-in functions in the SMTPSession class provide the ability to connect to an SMTP server with a variety of methods and send email and SMTP commands.
The SMTPSession class offers the following functionality:
Login using clear text
Login using CRAM_MD5
The standard Secure SMTP port, 465
The standard SMTP port, 25
Returns a new SMTPSession instance, or undefined if an error occured.
Returns a new SMTPSession instance using a SSL socket, or undefined if an error occured.
Close a connection to an SMTP server.
Connect to an SMTP server.
Retrieve the a string for the last error code.
Returns the SMTP timeout in milliseconds.
Used to initialize a security context for SecureLogin().
Initiate a connection to an SMTP server.
Initiate a secure connection to an SMTP server.
Sends raw SMTP commands.
Sends a mail message.
Set SMTP timeout in milliseconds.
Login using clear text
Login using CRAM_MD5
The standard Secure SMTP port, 465
The standard SMTP port, 25
Returns a new SMTPSession object
IP address or domain name of SMTP host.
SMTP connection port
A new SMTPSession object or undefined if there was an error constructing the object.
Returns a new SMTPSession object using a SSL socket.
IP address or domain name of SMTP host.
SMTP connection port
SSL options
A new SMTPSession object using a SSL socket or undefined if there was an error constructing the object.
No parameters. Closes the session.
Returns 0 for success and -1 if an error occurred.
The host parameter is optional and if not specified, will connect to the host as specified in the New() function. Otherwise, this host parameter will override whatever host param was used in the New() function. Use this if you do not require authentication to connect to your smtp server.
IP address or domain name of SMTP server.
Returns 0 for success and -1 if an error occurred.
No parameters. Returns an error string for the last error that occured.
Returns an error string for the last error that occured.
Gets the timeout value for SMTP commands. The timeout is in milliseconds.
Returns the timeout in milliseconds, -1 if an error occured.
Sets the SSL options for a secure connection. You must call this before attempting to do a SecureLogin() call.
an instance of SSLOptions.
Returns 0 for success and -1 if an error occurred.
This function allows authenticated login to an smtp server, with two different methods available, LOGIN_CRAM_MD5 and LOGIN_CLEAR. The loginMethod param is optional and the default is LOGIN_CLEAR.
username used to login to SMTP server.
password used to login to SMTP server.
type of login authentication to use.
Returns 0 for success and -1 if an error occurred.
The username/password parameters are optional, use them if your server also requires authentication as well as TLS/SSL. You must have called InitContext() before this.
IP address or domain name of SMTP server.
user login on SMTP server
user password for SMTP server
Returns 0 for success and -1 if an error occurred.
Use this to send other raw SMTP commands. The arguments param is optional.
command to send
Returns 0 for success and -1 if an error occurred.
Sends a previously created MailMessage ( an email ).
MailMessage to send
Returns 0 for success and -1 if an error occurred.
Sets the timeout value for SMTP commands. The timeout is in milliseconds.
timeout in milliseconds.
Returns 0 for success and -1 if an error occurred.
| Copyright © 2019 OpenText Corporation. All rights reserved. |