inFORM Decisions Information Portal

User Tools

Site Tools

Trace:
pub:imailapis

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
pub:imailapis [2018/06/21 12:31] – [ESNDFILURL] kkramerpub:imailapis [2022/06/25 17:02] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +<html>&#091;</html>[[start#imail | Up To iMail ]]<html>&#093;</html>
 +
 +
 ====== 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.
 +<html><pre>
 +Examples below:
 +ken@informdecisions.com, anh@informdecisions.com
 +ken@informdecisions.com,anh@informdecisions.com
 +ken@informdecisions.com anh@informdecisions.com
 +</pre></html> 
 ===== ECVTDBF ===== ===== ECVTDBF =====
  
Line 134: 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             | Fully compatible Excel format*                         | +| *XLS | Excel format             | Fully compatible Excel format *                        |
-\\ +
-**NOTE:** Outlook 365 doesn't allow an override of the From Address and if entered on the API it will result in a send failure. +
-\\ +
-\\ +
-* 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:
 \\ \\
      IMAILIFS LIB([YourSourceLibrary])      IMAILIFS LIB([YourSourceLibrary])
 +\\
 +**NOTE:** Outlook 365 doesn't allow an override of the From Address and if entered on the API it will result in a send failure.
 \\ \\
 == Thresholds and Limitations: == == Thresholds and Limitations: ==
  <html><pre>  <html><pre>
  
-  - Limited to emailing a single database file file. +  - Limited to emailing a single database file. (For multiples use command ESNDDBFS)  
-  - Limited to 80 characters for the sender and receipient addresses +  - Limited to 80 characters for the sender and recipient addresses 
-  - Limited to 300 direct receipients in the To address +  - Limited to 300 direct recipients in the To address* 
-  - Limited to 300 direct receipients in the Cc address in addition to those in the To address +  - Limited to 300 direct recipients in the Cc address in addition to those in the To address* 
-  - Limited to 300 blind copy receipients in the Bc address+  - Limited to 300 blind copy recipients in the Bc address*
   - 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
-</pre></html>                             + 
-                                                                 +Note: Your mail server can also limit the file size sent. Check with your Mail Server Administrator. 
 +  
 +</pre></html> 
 +**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 = '**Y**': Uses the original approach of utilizing SQL to read the data: it will limit the number of  
 +fields in database to 256 columns.\\ 
 +DSCSVLEFT = '**N**': Uses the CPYTOIMPF command to convert a database to CSV and will not limit the columns in  
 +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 224: Line 244:
   </pre></html>                                                                                  </pre></html>                                                                               
  
-===== ESNDFILURL ===== +===== 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, and because it depends on the receiving system to issue a certificate which is able to document in general. please contact your customer service representative and IFD will assist in the necessary configuration.  The sample interface screen is shown below.  Sample steps and useful commands to create certificates for mutual authentication to a server and a cacerts file (a trust store which contains server and client-signed certificates) are described [[pub:esndfilurlcert|here]]. This is for example only and will not work for every interface.
-This command will send a IFS File to a URL. With this native IBM i command 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, and because it depends on the receiving system to issue a certificate which is able to document in general. please contact your customer service representative and IFD will assist in the necessary configuration.  The sample interface screen is shown below.  Sample steps to create certificates for mutual authentication to a server and a cacerts file (a trust store which contains server and client-signed certificates) are described [[pub:esndfilurlcert|here]].+
  
 +Below is an example for ESNDFILURL:
 <html><pre> <html><pre>
                     Send IFS File to URL (HTTPS) (ESNDFILURL)                                        Send IFS File to URL (HTTPS) (ESNDFILURL)                   
Line 269: Line 289:
                                                                                                                                                                  
                                                                          Bottom                                                                           Bottom 
 +</pre></html>
 +Below is an example for ERCVFILURL:
 +<html><pre>
 +                   Receive File from URL (HTTPS) (ERCVFILURL)                   
 +                                                                                
 + Type choices, press Enter.                                                     
 +                                                                                
 + HTTPS URL  . . . . . . . . . . .   '/idocs/receive'                            
 +                                                                                
 +                                                                                
 +                                                                                
 + LISTEN PORT  . . . . . . . . . .   443           Character value               
 + IFS Output Directory . . . . . .   '/home/receive'                             
 +                                                                                
 +                                                                                
 +                                                                                
 + Prefix name of receiving file  .   'receive.'                                  
 +                                                                                
 + Keystore File  . . . . . . . . .   '$USERDATA/JAVA400/EXT/.KEYSTORE'           
 +                                                                                
 +                                                                                
 +                                                                                
 + Keystore Password  . . . . . . .   'inform'                                    
 + TrustStore File  . . . . . . . .   '$JAVA_HOME/LIB/SECURITY/CACERTS'           
 +                                                                                
 +                                                                                
 +                                                                                
 + Truststore Password  . . . . . .   'changeit'                                  
 +
 +                                               
 </pre></html> </pre></html>
  
Line 336: 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 '&' located on the IFS iMail directory. i.e. MSG(’This text file verbiage will be inserted &MESSAGE.txt into the body’). In this example MESSAGE is a formatted text file on the imail directory of the IFS.   * **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 '&' located on the IFS iMail directory. i.e. MSG(’This text file verbiage will be inserted &MESSAGE.txt into the body’). In this example MESSAGE is a formatted text file on the imail directory of the IFS.
   * **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. Note that blind copy recipients addresses are not visible to the recipients specified in the parameter TOADDR
   * **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 473: 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 or F4 Prompt displays a list for you to choose from: 
 +    *  *FCFC   
 +    *  *HTML   
 +    *  *PCL    
 +    *  *PDF    
 +    *  *PRTCTL 
 +    *  *RTF    
 +    *  *TXT    
 +    *  *XLS    
 +    *  *XLSX   
 +    *  *TIF    
   * **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
pub/imailapis.1529609505.txt.gz · Last modified: 2022/06/25 17:02 (external edit)