Differences

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

--- pub:imailserver [2016/07/07 12:05] – [Start iMail Server] ken
+++ pub:imailserver [2024/03/25 18:53] (current) – [Start iMail Server] kkramer
@@ Line 1: / Line 1: @@
+<html>&#091;</html>[[start#imail | Up To iMail ]]<html>&#093;</html>
 ====== iMail Server Configuration ======
@@ Line 23: / Line 25: @@
 . Start iMail Server                              STRMAILSVR
 . End iMail Server                                ENDMAILSVR
-                                                                        More...
+ <font  color="#778899">                                                                         More...
  Selection
  F1=Help   F3=Exit   F12=Cancel
+</font>
 </pre></html>
@@ Line 42: / Line 44: @@
 ===== 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. The server name should not have any embedded spaces.
+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>
@@ Line 74: / Line 79: @@
 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.
+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 queues, the trigger, the trigger value, the attachment type, and the desired email address or distribution group. \\
+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.
@@ Line 93: / Line 98: @@
            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
+Subject line using the F11=Toggle Mail Subject command key
@@ Line 107: / Line 112: @@
 </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. 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.
+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:
@@ Line 132: / Line 137: @@
 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, may also accept one special value. *USRPRFLNK. The 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.
+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 =====
@@ Line 144: / Line 154: @@
 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.
+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 =====
@@ Line 153: / Line 181: @@
+**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')