Please enable JavaScript to view this site.

A-Shell Consolidated Reference

Navigation: Subroutines > EMAILX

EMAILX Parameters

Scroll Prev Top Next More

Parameter

I/O

Description

Opflags

in

Operation flags

Cfgfile

in

Name of configuration file

To

in

Address of recipient(s)

Header

in

Header fields

Body

in

Text of message

Status

out

Return code

From

in

Email address of sender

Attachments

in

Attachments

signature

in

AMOS or native filespec to be appended to bottom of message body. Like body, signature can also contain the actual text rather than a filename. See note below.

errmsg

out

If present, will receive a (possibly) useful text string if STATUS # 0 (elaborating on the error condition.).

socket

in/out

Ignored on input unless you use opflags to avoid opening and closing the SMTP session for each message; in which case it receives the socket # of the session on the open call and must be passed to all the subsequent calls. Note that you must manually close the socket if you use the EMF_LEAVEOPEN option.

server

in

Name or IP address of the SMTP server. (append :<port> if not using port 25). See note below.

host

in

Name to identify your domain to the SMTP server in the initial protocol exchange with the SMTP server. See note below.

username

in

Overrides the username field in the configuration file to specify the user name needed to authenticate with the SMTP server. If username and password are both specified (and not blank) and no AUTH mode was specified, AUTH = AUTO is used automatically.

password

in

Overrides the password field in the configuration file to specify the password needed to authenticate with the SMTP server. If username and password are both specified (and not blank) and no AUTH mode was specified, AUTH = AUTO is used automatically. Note that the password may be specified in encrypted form (provided it was encrypted with MX_PWCRYPT). In the case of AUTH = XOAUTH2, the password should be the access token.

 

Note that if values for signature, server and host are not specified explicitly, the values for those parameters will be taken from the configuration file. If no host is provided, we use nothing, which may lead to your mail being rejected, or possibly sent with a warning that it comes from an unidentified source.