Note that directive names are case-sensitive.
Name |
Values |
Description |
PDFXv3 |
|---|---|---|---|
Enabled |
Boolean |
Specifies if the PDF document should be emailed after creation. If the value of this property is False, none of the other properties in this section are used. Default = True. |
(new) |
Method |
1 - 6 |
Specifies which of three different types of email operation will be performed. See the discussion in the separate topic Email Methods. |
Type |
From |
String |
Specifies the email account to use for the From email property. This field is required, and has no default value. Without a valid entry here, the sending of the email message will fail. It will fail not due to PDFX but rather to requirements of the SMTP mail server (outgoing) or the service receiving the message. |
(same) |
To |
Specifies various recipient(s) of the email. If more than one recipient is specified, they should be separated by the semicolon (;) character. Each recipient can be specified as an email address (for example, john@server.com); or as a combination of name and address: John Smith <john@server.com>. Default values for "cc" and "bcc" are empty strings. There is no default value for "To," and it must be set to a valid email address. |
(same) |
|
CC |
(same) |
||
BCC |
(same) |
||
Subject |
Defines the subject string for the email. Default = empty string |
(same) |
|
Defines content of the email. Default = empty string |
(same) |
||
ZIP |
Boolean |
Specifies whether to send the generated document as a PDF file or to create and then archive as a ZIP file containing one PDF file. No 3rd party ZIP library required |
(same) |
Server |
String |
Specifies the name of the SMTP server for sending email. This property is used only when the Method property has the valueSendViaSMTP. The SMTP server must be defined using AddSMPTServer method. Default = empty string |
(new) |
The following apply only if Email.Method = 4. |
PDFXv3 |
||
SMTP.Address |
Quoted string |
Specifies the name/IP address of the SMTP server through which to send email, e.g. smtp.yourisp.net |
(same) |
SMTP.UserName |
Specifies username/login for SMTP Authentication, if required. |
(same) |
|
SMTP.Password |
Specifies the account password for SMTP server, if required. See SMTP authentication. |
(same) |
|
SMTP.Port |
1 - 65535 |
Specifies the port number to be used for the SMTP server (usually 25 for standard SMTP, or 465 for encrypted). |
(same) |
SMTP.UseSSL |
0, 1 |
Specifies whether to use a Secure Connection (SSL/TLS) for the SMTP server. |
(same) |
2 |
Invokes the StartTLS protocol. The port should be set to 25 or another non-encrypted port; the connection starts out in un-encrypted mode and then negotiates a change to TLS encrypted mode. See History. |
(same) |
|
ID |
String |
Attaches an arbitrary idstring (up to 32 chars) to the message. The only purpose of this is to identify the message in the log. Conceptually, applications that send a lot of messages may want to assign unique identifiers to them for tracking and follow-up purposes. (Methods 4+ only; A-Shell build 1124+) |
(same) |
String |
Changes the name of the log file that A-Shell maintains of the sent SMTP messages. The default is OPR:SMTP.LOG. To deactivate logging, set logfile to "". (Methods 4+ only; A-Shell build 1124+) |
(same) |
|
Header, Header Value |
Allows arbitrary headers to be attached to the email message. (Methods 4+ only; A-Shell build 1124+) |
(same) |
|
AttachFile |
filespec |
Specifies additional files to be attached to the email message. filespec is a standard file specification, AMOS or native. A document will support up to fifteen AttachFile statements. (Methods 4+ only; A-Shell build 1383+) Note that in the ATE environment, the file to be attached must be visible to the ATE client, which may require the application to pre-transfer it from the server. |
(same) |
Examples
//PDFX,Email.Method,4
//PDFX,Email.To,potus@whitehouse.gov
See the Examples page to get a sense of how these commands may be used.
