inFORM Decisions Information Portal

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
<html>&#091;</html>[[start#imail | Up To iMail ]]<html>&#093;</html>

====== iMail Server Configuration ======

The main iMail menu appears below:

<html><pre>
 IMAIL                     iMail Menu  6.86 06.30.16
<font  color="#778899">                                                                                                                                                                
   iMail Administration                                                         
      1. Configure iMail                                 CFGMAIL                
      2. Work with Log                                   WRKMAILLOG             
      3. Work with Users                                 WRKMAILDST             
      4. Work with Groups                                WRKMAILGRP             
      5. Work with Administration                        WRKMAILADM             

   iMail Functions                                                              
     10. Work with Spooled Files                         WRKSPLINF              
     11. Send Database File                              SNDDBF                 
     12. Send Email Message                              SNDMAIL                
</font> 
                                                                                
   Configure iMail Server                                                       
     21. Work with iMail Server                          WRKMAILSVR             
     22. Start iMail Server                              STRMAILSVR             
     23. End iMail Server                                ENDMAILSVR             
 <font  color="#778899">                                                                         More... 
 Selection                                                                      
                                                                         
                                                                                
 F1=Help   F3=Exit   F12=Cancel                                                 
</font>             
</pre></html>



The iMail server is the process that searches defined output queues for spool file and establishes the rules for automatically emailing spool files. In this way spool files can be sent transparently without any user intervention.

The way that the iMail Server works is that if a spool file hits an out queue and that spool file has the targeted attributes, be it a specific form type, user data or spool file name, the spool file then is processed and emailed. Otherwise, if the spool file not meet any of the required processing attributes, the spool file is ignored.




===== Work with iMail Server =====

The first step in setting up your forms for automatic email distribution is to define the iMail Server. The iMail server is really a data queue engine.  Selecting option 21, Work with iMail Server, subsequently displays the screen in below Work with Server Maintenance. Here you would define server entries.

**Option 1** to modify an existing entry, **Option 4** to delete an existing entry, or **F6** to add a new entry.\\
The server name should not have any embedded spaces.  Enter a meaningful description to identify the server.

<html><pre>
  7/07/16                                                             IM2100C1  
 09:42:22                      Server Maintenance                     QSECOFR   
                                                                                
 Type options, press Enter.                                                     
  1=Select  4=Delete                                                                     
                                                                                
                  Opt  Server      Description                                  
                       IMAIL       iMail OUTQ monitor                           
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                         Bottom 
 F3=Exit   F6=Add                                                                    
 Press enter to continue.                                                       
</pre></html>


From this point an existing email server application definition can be modified using an option one. Otherwise, choosing F6 can create a new definition.

The next screen, iMail Server Detail Maintenance, illustrates the screen that defines rules for processing a spool file. Here you would first define the **Archive** output queue to archive the original spool file, and the **Data Queue** to be used.  

Then define the monitored **Output Queue**(s), the trigger type (**Spooled File Attribute**), the trigger value (**Spooled File Value**), the attachment type (**Format**), and the desired **Email Address** or distribution group. Details are provided below.\\ 
The **F7** command key will provide any the Distribution List for prompting. \\
The **F11** command key allows you to add a email subject line to each entry.

<html><pre>
 7/07/16                                                             IM2100C3 
09:51:23                      Server Maintenance                     QSECOFR  
                                                                              
Server. . . . . . . . . . : IMAIL        Archive Out Queue. . . . : ARCOUTQ   
Description: iMail OUTQ monitor          Library. . . . . . . . . : IMAIL30   
Data Queue. . . . . . . . :              Library. . . . . .  .  . :                                                                                 
                                                                              
                                                                              
    Originating   Spool                                                            
Library    Out     Attr  Spool     Format  Email To Address                    
           Queue F4=List Value     F4=List F4=List F7=Distribution List                             
QGPL       DEMOOUTQ   F *STD      *PDF     you@yourdomain.com                 
Subject line using the F11=Toggle Mail Subject command key                                                                                
                                                                              
                                                                              
                                                                              
                                                                              
                                                                              
                                                                              
                                                                              
                                                                              
                                                                       More...
F3=Exit   F11=Toggle Mail Subject   F12=Previous 
Press enter to continue.                                                      
</pre></html>

Essentially, the email application definition will process, convert and subsequently email spool files that meet specific criteria. According the definition above any spool files that are sent to the out queue DEMOOUTQ and have a form type of *STD will be converted to *PDF format and sent to the email address associated with the spooled file’s user profile using the Subject specified. Once the conversion has been completed the spool file will remain in the originating out queue, or if an archive out queue has been specified that spool file will be moved to that archive out queue.

Within the colum entitled 'Spool Attr', a one character value may be placed here to designate the specific spooled file attribute. The character codes and corresponding spool attributes are listed in the table below:

| **Code** | **Spooled File Attribute** |
| F    | Spooled file Form Type |
| I    | Spooled file User Name |
| J    | Spooled file Job Name  |
| P    | Spooled file name      |
| U    | Spooled file User Data |

The majority of the values required for entries in the screen above are self explanatory, but for a few, while other prompts may receive special values, usually preceded with an asterisk, entered that are not intuitive. 

The prompt for the attachment type column may accept the following values as described in the table below:

  * ***HTML    ** Hyper Text Markup Language   
  * ***RTF     ** Rich Text Format            
  * ***PDF     ** Portable Document Format    
  * ***TXT     ** Text                        
  * ***FCFC    ** Ansi Forms Control          
  * ***PRTCTL  ** Print Control               
  * ***XLS     ** Microsoft Excel      

The last column, Email to Address, of course may accept a fully qualified email addresses. But that’s not all. Additionally, a distribution list may be entered in this prompt that will be interpreted as multiple email recipients. Distribution lists were described earlier in the manual

The same prompt, Email to Address, will also accept special values: 
  * ***USERNAME** - The *USERNAME key word here, as the name implies, retrieves the user profile from the spooled file. Once extracted the value is compared to a matching user record in the public distribution list sending the spooled file to the user profile’s email address.
  * ***USRPRF** - If 'I' for Spooled file User Name is selected, *USRPRF can be used instead of *USERNAME.
  * ***SMTPNAME** - Similarly, if *SMTPNAME is specified as the target, this would take the user profile of the spool file owner, retrieve the smtp address associated with that profile in the system directory (the SMTP name), and use that email address as the target address. 



===== Start iMail Server =====

Selecting this option will submit the program to run in batch through a specified batch queue. As shown below, the default job queue associated with the engine is QBATCH. Changing this default to another job queue will either run the job through another subsystem or class. 

<html><pre>
                        Start iMail Server (STRMAILSVR)           
                                                                  
Type choices, press Enter.                                        
                                                                  
iMail Server . . . . . . . . . .   IMAIL         Character value  
iMail Job Queue  . . . . . . . .   QBATCH        Character value
Re-process RDY spool file  . . .   N             Y, N 
</pre></html>

Enter the iMail server name and the iMail server job queue to route the server. \\
Revision iDOCS 8.0 03/03/24. Enter a Y to re-process RDY spool files. Default is N.

**Behavior when starting the iMail Server:**\\
When "Re-process RDY spool file" is set to 'Y'
  * Unordered List ItemSpool files in the monitored out queues that are in 'RDY' status will get processed.
  * Unordered List ItemSpool files in the monitored out queues that are in 'HLD' status will stay in the out queue and not be processed.
  * Unordered List ItemSpool files introduced and that have been refreshed (hold/release) to 'RDY' status will get processed.

When "Re-process RDY spool file" is set to 'N'
  * Unordered List ItemSpool files in the monitored out queues that are in 'RDY' and 'HLD' status will not be processed.
  * Unordered List ItemSpool files introduced and that have been refreshed (hold/release) to 'RDY' status will get processed.

When the iMail Engine is configured with no archive out queue, the processed spool file will stay in the originating out queue.
When the iMail Engine is configured with an archive out queue, the processed spool file will move to the configured archive out queue. 

**NOTE:** To utilize this function in a job scheduled entry use the following command to run:\\
 CALL PGM(iMail-library/IMC3100) PARM('iMail-server-name' ‘Job queue name’)  
===== End iMail Server =====

Selecting this item ends the email monitor.


**NOTE:** To utilize this function in a job scheduled entry use the following command to run:\\
 CALL PGM(iMail-library/IMR4100) PARM('iMail-server-name')