pub:imailapis
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
pub:imailapis [2018/06/06 11:34] – kkramer | pub:imailapis [2021/11/04 19:49] – [ESNDDBF] kkramer | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | < | ||
+ | |||
+ | |||
====== iMail Command APIs ====== | ====== iMail Command APIs ====== | ||
Line 5: | Line 8: | ||
Note that the commands mirror the menu options available from the menu group entitled Send Mail Commands. | Note that the commands mirror the menu options available from the menu group entitled Send Mail Commands. | ||
+ | **General note:** As of iDocs release 6.90, iMail supports blank, comma or semi-colon as address separators in the TO, CC and BC addresses fields for all API's listed below. | ||
+ | < | ||
+ | Examples below: | ||
+ | ken@informdecisions.com, | ||
+ | ken@informdecisions.com, | ||
+ | ken@informdecisions.com anh@informdecisions.com | ||
+ | </ | ||
===== ECVTDBF ===== | ===== ECVTDBF ===== | ||
Line 81: | Line 91: | ||
===== ESNDDTAQ ===== | ===== ESNDDTAQ ===== | ||
- | This command will send data to keyed data queue. It was added to iMail version 6.91 on 5/31/18. | + | This command will send data to keyed data queue. It's included in the IFDCLIENT module. See https://manual.informdecisions.com/doku.php?id=pub:ifdcinstructions |
- | + | ||
- | < | + | |
- | Send data to keyed data queue (ESNDDTAQ) | + | |
- | + | ||
- | Type choices, press Enter. | + | |
- | + | ||
- | Key value . . . . . . . . . . . | + | |
- | + | ||
- | Data value . . . . . . . . . . . | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | Data Queue . . . . . . . . . . . | + | |
- | | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | | + | |
- | F3=Exit | + | |
- | | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | The following describes the command qualifiers and their expected values: | + | |
- | + | ||
- | * **Key Value** – Enter the printer file name in this command qualifier | + | |
- | * **Data Value** – Enter the iSeries spool file attributes. | + | |
- | + | ||
- | + | ||
===== ESNDDBF ===== | ===== ESNDDBF ===== | ||
Line 169: | Line 144: | ||
| *SAVF| System i Save File | Requires that the source file already be a save file | | | *SAVF| System i Save File | Requires that the source file already be a save file | | ||
| *TXT | Text | Fixed format text file with no field delimitation | | *TXT | Text | Fixed format text file with no field delimitation | ||
- | | *XLS | Excel format | + | | *XLS | Excel format |
- | \\ | + | |
- | **NOTE:** Outlook 365 doesn' | + | |
- | \\ | + | |
- | \\ | + | |
- | * Prior to using *XLS to send a database in Excel format, the command IMAILIFS needs to first be issued to install the Java dependencies used to create the Excel file form the DB2 database. The syntax for the useing the command is: | + | |
\\ | \\ | ||
+ | * Prior to using *XLS to send a database in Excel format, the command IMAILIFS needs to first be issued to install the Java dependencies used to create the Excel file form the DB2 database. The syntax for the using the command is: | ||
\\ | \\ | ||
| | ||
+ | \\ | ||
+ | **NOTE:** Outlook 365 doesn' | ||
\\ | \\ | ||
== Thresholds and Limitations: | == Thresholds and Limitations: | ||
< | < | ||
- | - Limited to emailing a single database | + | - Limited to emailing a single database file. (For multiples use command ESNDDBFS) |
- | - Limited to 80 characters for the sender and receipient | + | - Limited to 80 characters for the sender and recipient |
- | - Limited to 300 direct | + | - Limited to 300 direct |
- | - Limited to 300 direct | + | - Limited to 300 direct |
- | - Limited to 300 blind copy receipients | + | - Limited to 300 blind copy recipients |
- Limited to 80 characters for the subject | - Limited to 80 characters for the subject | ||
- | - Limited to 2048 characters for the messsage | + | - Limited to 2048 characters for the message |
- Limited to converting the database file to the following types if the attribute is a | - Limited to converting the database file to the following types if the attribute is a | ||
- | source physical file. CSV, DIF, TXT, XLS | + | source physical file. CSV, DIF, TXT, XLS, XLSX |
- Limited to retaining the initial format if the database file to the following types if the attribute is a | - Limited to retaining the initial format if the database file to the following types if the attribute is a | ||
source save file. | source save file. | ||
- | - CSV - Maximum columns 255, Maximum column width 256 | + | - CSV - The maximum length of a database record is 32766 characters |
- | - DIF - Maximum columns 255, Maximum column width 256 | + | - DIF - The maximum length of a database record is 32766 characters |
- XLS - Maximum columns 255, Maximum column width 256 | - XLS - Maximum columns 255, Maximum column width 256 | ||
- TXT - Maximum columns 255, Maximum column width 256 | - TXT - Maximum columns 255, Maximum column width 256 | ||
- | </ | + | |
- | | + | Note: Your mail server can also limit the file size sent. Check with your Mail Server Administrator. |
+ | |||
+ | </ | ||
+ | **Release specific notes: ** | ||
+ | |||
+ | iMail 6.90 and above supports blank, comma or semi-colon as address separators in TO, CC and BC addresses.\\ | ||
+ | |||
+ | iMail 6.98 includes data area **DSCSVLEFT** used to control the method used to convert a database to CSV.\\ | ||
+ | DSCSVLEFT = ' | ||
+ | fields in database to 256 columns.\\ | ||
+ | DSCSVLEFT = ' | ||
+ | the data file, but it can negatively impact the format of numeric fields for some customers who will be better | ||
+ | served with the original SQL approach. | ||
| | ||
===== ESNDDBFS ===== | ===== ESNDDBFS ===== | ||
Line 258: | Line 243: | ||
| | ||
</ | </ | ||
- | | + | |
+ | ===== ESNDFILURL / ERCVFILURL===== | ||
+ | iDocs provides a utility to send a file from the IBM i to other system (ESNDFILURL) and receive files from other system to the IBM i (ERCVFILURL) via secured HTTP methods. With these commands, iDocs can facilitate the exchange of data with other systems via web services and a trust store. Since the integration is highly customized for each application, | ||
+ | |||
+ | Below is an example for ESNDFILURL: | ||
+ | < | ||
+ | Send IFS File to URL (HTTPS) (ESNDFILURL) | ||
+ | |||
+ | Type choices, press Enter. | ||
+ | |||
+ | HTTPS URL . . . . . . . . . . . > informdecisions.com | ||
+ | |||
+ | |||
+ | |||
+ | IFS Sending File . . . . . . . . > file | ||
+ | |||
+ | |||
+ | |||
+ | | ||
+ | |||
+ | |||
+ | |||
+ | | ||
+ | |||
+ | |||
+ | More... | ||
+ | |||
+ | Type choices, press Enter. | ||
+ | |||
+ | | ||
+ | |||
+ | |||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | | ||
+ | </ | ||
+ | Below is an example for ERCVFILURL: | ||
+ | < | ||
+ | | ||
+ | |||
+ | Type choices, press Enter. | ||
+ | |||
+ | HTTPS URL . . . . . . . . . . . '/ | ||
+ | |||
+ | |||
+ | |||
+ | | ||
+ | IFS Output Directory . . . . . . '/ | ||
+ | |||
+ | |||
+ | |||
+ | | ||
+ | |||
+ | | ||
+ | |||
+ | |||
+ | |||
+ | | ||
+ | | ||
+ | |||
+ | |||
+ | |||
+ | | ||
+ | |||
+ | |||
+ | </ | ||
===== ESNDMAIL ===== | ===== ESNDMAIL ===== | ||
Line 324: | Line 386: | ||
* **MSG** – Enter the message body in this parameter value. The message text can contain a macro substitution variable that will be used to insert an email message. This message will be derived from a text file identified with a '&' | * **MSG** – Enter the message body in this parameter value. The message text can contain a macro substitution variable that will be used to insert an email message. This message will be derived from a text file identified with a '&' | ||
* **CCADDR** - Enter the copied recipients email address in this parameter. | * **CCADDR** - Enter the copied recipients email address in this parameter. | ||
- | * **BCCADDR** - Enter the blind copied recipients email address in this parameter. | + | * **BCCADDR** - Enter the blind copied recipients email address in this parameter. |
* **FROMADDR** - Enter the from email address. | * **FROMADDR** - Enter the from email address. | ||
* **ATTACH** - Enter one or more IFS directory files. | * **ATTACH** - Enter one or more IFS directory files. | ||
Line 461: | Line 523: | ||
* **FROMADDR** – This parameter requires the senders email address. If ommitted, then the default from address from the iMail configuration will be used. | * **FROMADDR** – This parameter requires the senders email address. If ommitted, then the default from address from the iMail configuration will be used. | ||
* ** ATTACH** – This qualifier specifies a PC file from the IFS directory to be attached. | * ** ATTACH** – This qualifier specifies a PC file from the IFS directory to be attached. | ||
- | * **TYPE** – Enter the type of attachment here as either *FCFC, *HTML, *PCL, *PDF, *PRTCTL, *RTF, *TXT, *XLS, *XLSX, *TIF. | + | * **TYPE** – Enter the type of attachment here as either |
+ | * | ||
+ | * | ||
+ | * | ||
+ | * | ||
+ | * | ||
+ | * | ||
+ | * | ||
+ | * | ||
+ | * | ||
+ | * | ||
* **OUTPUTNAME** - (Added 6.90 12/15/17) The parameter overrides the iMail attachment name. If this parameter is blank, then the default name is used. User can use the following values: | * **OUTPUTNAME** - (Added 6.90 12/15/17) The parameter overrides the iMail attachment name. If this parameter is blank, then the default name is used. User can use the following values: | ||
* *SPLFNAME, *SPLNAME, *SPLNAM for spool file name | * *SPLFNAME, *SPLNAME, *SPLNAM for spool file name | ||
Line 476: | Line 548: | ||
* **RCPREAD** - This option deteremines if a read email receipt is sent back to the email senders' | * **RCPREAD** - This option deteremines if a read email receipt is sent back to the email senders' | ||
* **RCPDLVR** - This option deteremines if a deliveried email receipt is sent back to the email senders' | * **RCPDLVR** - This option deteremines if a deliveried email receipt is sent back to the email senders' | ||
- | |||
- | ===== ESNDDTAQ ===== | ||
- | |||
- | This command will send data to keyed data queue. It was added to iMail version 6.91 on 5/31/18. | ||
- | |||
- | < | ||
- | Send data to keyed data queue (ESNDDTAQ) | ||
- | | ||
- | Type choices, press Enter. | ||
- | | ||
- | Key value . . . . . . . . . . . | ||
- | | ||
- | Data value . . . . . . . . . . . | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | Data Queue . . . . . . . . . . . | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | |||
- | </ | ||
- | |||
- | The following describes the command qualifiers and their expected values: | ||
- | |||
- | * **Key Value** – Enter the printer file name in this command qualifier | ||
- | * **Data Value** – Enter the iSeries spool file attributes. | ||
| |
pub/imailapis.txt · Last modified: 2022/06/25 17:02 by 127.0.0.1