AngeliaMailTM - On-Line Help - Command Line Utility
When AngeliaMail is installed, a folder will be created (typically "C:\Program Files\AngeliaMail") that will
contain AngeliaMail.Exe and AngeliaConfig.Exe as well as any other files distributed with the application. To run
AngeliaMail, add "C:\Program Files\AngeliaMail\AngeliaMail.Exe [parameters]" to your batch file
at whatever point you wish an email to be dispatched. You may also test for "errorlevel" after AngeliaMail
executes, which will set ErrorLevel to zero when it completes normally or one if it fails.
AngeliaMail Command Line Parameters: command line parameters may be entered in any combination and in any
order unless otherwise indicated below. Each parameter may be specified only once. Values specified in the
command line will replace any corresponding values specified in an applicable AngeliaMail Command File unless the optional
"+" switch is available and specified, in which case the command line value will be appended to any value specified
in the applicable Command File. Parameters are as follows:
- SMTP Host Name – /H[*]hostname – where "hostname" is one of the SMTP Hosts
defined using the Configuration Utility. By specifying a hostname you are implicitly selecting SMTP Server
address, logon user-id and password if required, and "From" and "Reply-To" email addresses.
A host name must be specified, either as a command line parameter, or via an AngeliaMail Command File (see "Command
File Path" and "Command File Name" below). The optional "*" (asterisk) following the /H
is a switch to turn on the SMTP Trace function which provides detailed connection information in the log file and is
included to assist in troubleshooting. Example – select a Host name "KANDH" without SMTP Trace
"/HKANDH" or with SMTP Trace "/*KANDH".
- Addressees - /T[+]addressees – where "addressees" are either Email group names
defined via the Configuration Utility or Email addresses. If more than one address (or EMail Group Name) is specified
then use a semi-colon (";") between each email address or group name. We recommend that you avoid using Email
addresses in command lines to simplify maintenance. Any Email Groups specified will be expanded into the list of email
addresses that they represent before the email is sent. In addition, the email address list will be de-duped before
sending. At least one email address (or EMail Address Group) must be specified, either as a command line parameter, or
via an AngeliaMail Command File (see "Command File Path" and "Command File Name" below). The optional
"+" following the /T is a switch to signal that the addressees specified in the command line should be appended to any
addressees specified in an applicable Command File. Example – add the address "Bob@MyDomain.Net" to the addressees
specified in the Command File – "/T+Bob@MyDomain.Net".
- Subect Line – /S[+]subjectline – where "subjectline" contains whatever text you wish
to have appear in the subject line of the email when it is sent. If "subjectline" contains spaces, surround the entire
parameter with quotes ("). A subject line must be specified either as a command line parameter, or via an AngeliaMail
Command File (see "Command File Path" and "Command File Name" below). The optional "+" following
the /S is a switch to signal that the subject line text specified in the command line should be appended to any subject line text
specified in an applicable Command File. Example (note that because the subject line text contains spaces, the entire parameter,
including the /S, must be surrounded by quotes) – ""/SDaily Sales Report"".
- Attachment Paths - /A[+]attachments – where "attachments" contains one or more
pathnames specifying file(s) that you wish to attach to the email when sent. If more than one attachment path is specified,
then use a semi-colon (";") between each path name. If any of the path names include spaces then surround the entire
parameter with quotes ("). Attachments are optional. The optional "+" following the /A is a switch to
signal that the attachment(s) specified in the command line should be appended to any attachment paths specified in an applicable
AngeliaMail Command File. The file name in any attachment path specified must exist. Example (note that because the
attachment path contains spaces, the entire parameter, including the /A, must be surrounded by quotes) -
""/AC:\Reports\Daily Sales.pdf"".
- Message Text By Path - /Fmessagetextpath – where "messagetextpath" is the pathname of
a text file, the contents of which will be loaded into the email message body. The path must exist. The
"MessageTextPath" and "MessageText" (see below) parameters are mutually exclusive. If the path name
contains any spaces then surround the entire parameter with quotes ("). Example - ""/FC:\Reports\Daily
Sales.Txt"".
- Message Text - /M[+]messagetext – where "messagetext" contains whatever text you wish
to have appear in the message body of the email when it is sent. If "messagetext" contains any spaces, surround the
entire parameter with quotes ("). The "MessageText" and "MessageTextPath" (see above) parameters are
mutually exclusive. Message Text is optional. The optional "+" following the /M is a switch to signal that the
message text specified in the command line should be appended to any message text specified in an applicable Command File.
\Example – ""/MDaily Sales Report Aborted – See Attached Error Log"".
- Command File Path (/C) - /Ccommandfilepath – where "commandfilepath" is the complete
(or relative) pathname of an AngeliaMail Command File that was created using the "Command Wizard" in the Configuration
Utility (the normal extension is ".AMC"). Command Files contain collections of parameters and are used to reduce
command line clutter and simplify management of dynamic information such as addressee lists. The path specified must
exist. If the path name contains spaces then surround the entire parameter with quotes ("). If a file extension
is not specified then ".AMC" will automatically be appended. See Command Files for
a discussion of managing Command Files. Command File Path (/C), Command File Name (/D), and Command File Name (/N) are
mutually exclusive. Example – ""/CC:\AngeliaMail\Daily Sales Report.AMC"".
- Command File Name (/D) - /Dcommandfilename – where "commandfilename" is the file name
of an AngeliaMail Command File that was created using the “Command Wizard” in the Configuration Utility (the normal extension is
".AMC") and stored in the default (license and configuration) folder. Command Files contain collections of
parameters and are used to reduce command line clutter and simplify management of dynamic information such as addressee lists.
The name specified must exist in the default folder. If the file name contains spaces then surround the entire parameter with
quotes ("). If a file extension is not specified then ".AMC" will automatically be appended. See
Command Files for a discussion of managing Command Files. Command File Path (/C), Command File
Name (/D), and Command File Name (/N) are mutually exclusive. Example – ""/DDaily Sales
Report"".
- Command File Name (/N) - /Ncommandfilename – where "commandfilename" is the file name of
an AngeliaMail Command File that was created using the “Command Wizard” in the Configuration Utility (the normal extension is
".AMC") and stored in the configuration folder. Note that the configuration folder may be the same as the default
folder, or it may be a shared configuration folder with a relocated configuration file. Command Files contain collections of
parameters and are used to reduce command line clutter and simplify management of dynamic information such as addressee lists.
The name specified must exist in the configuration folder. If the file name contains spaces then surround the entire parameter
with quotes ("). If a file extension is not specified then ".AMC" will automatically be appended. See
Sharing Configurations for a discussion of managing shared configurations and
Command Files for a discussion of Command File Management. Command File Path (/C), Command File
Name (/D), and Command File Name (/N) are mutually exclusive. Example – ""/NDaily Sales
Report"".
- Logging And Log File Path - /L[*][logfilepath] – where "*" (asterisk) enables logging
and "logfilepath" specifies the pathname of the file where you want logging information to be written. If
"logfilepath" is omitted then a log file named "AngeliaMail.Log" will be written in the default folder.
If the log file path contains spaces then surround the entire parameter with quotes ("). This parameter is
optional. Example – "/L*" enables logging in the default location while ""/LC:\Some
Folder\Some File Name.Log"" specifies a location for logging (note that this parameter is meaningless since it
does not include the "*" switch to enable logging, unless logging is enabled in the applicable AngeliaMail Command
File).
- Wait On Error - /WY – Normally, AngeliaMail will continue without pausing in the event of an error
so as not to halt unattended execution of batch files with requests for console input. However, if you want it to wait for console
acknowledgement when it encounters an error, then use the "/WY" switch. This is particularly useful when trying to
diagnose command line parameter errors which may cause a failure before logging can be enabled. For this reason, the "Wait
on Error" parameter should be the first command line parameter specified when it is used.