Home

Email User Guide

1. Page 57 HIGH High priority When the message arrives the client email software will mark it as high priority LOW Low priority When the message arrives the client email software will mark it as low priority METHOD Method The method by which the email is delivered The default is the single option MSF Use Mail Server Framework This method sends emails by building a MIME message in a temporary stream file which is then passed to MSF for processing by means of the QtmmSendMail API MSF then passes the message to SMTP for delivery If you experience problems with this method you can try an alternative method which communicates directly with the SMTP server of the target MSF or SMTP Options are SMTP Selects the alternative method which communicates directly with SMTP on the target by passing MSF and SMTP on the system i Refer to the section How CoolSpools Email Works above for details of the different methods you can choose for delivering emails SMTP port number The port number to use when communicating with SMTP on the target platform Options are DFT The well known port number for SMTP 25 port_number Specify the port number to use Please note that this option is currently made available on an is as unsupported basis CoolSpools Email User Guide V6R1 Page 58 www ariadnesoftware co uk Timeout Seconds The timeout in seconds to enforce when communicating with SMTP on the target
2. MS Q Here s a demonstration of a message with HTML controls lt br gt lt b gt This line is in bold lt b gt lt br gt lt u gt While this line is underlined lt u gt When this message is received it will show as Here s a demonstration of a message with HTML controls This line is in bold While this line is underlined ATTACH Attachments The ATTACH Attachments parameter allows you to attach or embed up to 32 files to your email message There are 5 elements to this parameter File name Method Content type Code page and Attachment name in email File name This is where you enter the full path name of the file you wish to attach The path name must be entered in IFS format In other words documents stored in shared folders must be referenced in the QDLS file system and database file members must be reference in the QSYS LIB file system Method This is where you specify the method by which the file is sent Options are ATTACH Default The file is sent as an attachment It will appear as an attached file separate from the text of the email EMBED The contents of the file are embedded in the text of the email and will follow the text of any message entered on the MSG parameter Please note that your client email software is likely only to support the embedding CoolSpools Email User Guide V6R1 Page 53 www ariadnesoftware co uk of certain types of file e g text HTML and images Content type
3. The content type tells CoolSpools Email and the receiving email software what type of data the attachment represents It is important that the content type is specified accurately as CoolSpools Email will process the attachment differently depending on the value you specify here For example if you specify the attachment type as TEST or HTML it will be handled using a technique appropriate to textual data and may be converted from EBCDIC to ASCIl whereas any other content type will cause the attachment to be handled as binary data and sent unaltered Moreover the receiving software may not handle the attachment appropriately if the content type is specified incorrectly For example if you send a PDF file attachment but specify a content type of HTML the receiving email software may attempt to display the PDF file as HTML which will cause unwanted results Options are FILE Default The content type will be inferred from the extension part of the file name You can control which file extensions are identified as which content types by listing file extensions in the second level text of CoolSpools Database messages CMQ5000 CMQ5004 Each file extension must be from 1 5 characters long padded with trailing blanks if less than 5 characters long For example message CMQ5001 controls which file extensions identify image files This message is supplied with the value JPG JPEG GIF BMP PNG TIF TIFF You may change the tex
4. ee o o BINARY Count of key value pairs that follow 5 bh CHAR Array of key value pairs in the format specified below Format of each ES pair in CM_O0200 Offset cc re pa o 0000 BINARY 2 Length of key 0023 BINARY 2 Length of value Miscellaneous options keys currently defined are as follows Key Description Possible values METHOD Specifies the method by which the SMTP CoolSpools SMTP email should be sent MSF IBM MSF ENV Use environment variable setting SMTPPORT Port to use for SMTP Port number SMTPTIMEOUT Timeout for SMTP Timeout in seconds CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Page 129 CCSID CCSID to use for the message 1 Use environment variable CS_EMAIL_DFT_CHARSET if set or derive from job CCSID 2 Derive from job CCSID Valid CCSID HARMONIZE Whether to harmonize encodings WARN Warning message if of a multipart email advisable YES Yes NO No DIAGNOSTIC Run in diagnostic mode only use YES Yes when advised by support staff NO No lt variable gt A CoolSpools Email variable The value to substitute for the Wherever the string lt variable gt where variable is the variable marker text occurs in the message text it will be replaced with the specified value variable at run time CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Page 130 Pa
5. Email User Guide Version V6R1MO 2010 Table of Contents NA OCC HONN WE 10 Why Choose CoolSpools Email cccceceeeeeeeeeeeeneeeeeeeeeeeeeeeeceaeeeeeeeeeeeeeeeeeeaaees 11 EEN eebe 12 Upgrade e 13 License Keys cosis a a EA 13 CEO ve HR EE 14 Minimum OS 400 Release Level 15 Product LIDGANY E 15 Memo to USCIS cca cetecectecteasNsdimedisdeecadh oil icts adhaiibeednd de ceac es Mesa cddesthesdieai sites 15 What s new in this releaSe eceeeeeeeee seen seen ee ee ee eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeees 16 Important Note about POP settmgsl 18 Address LNCS erotic cans eaagecd setmocied E tneyad seeeeebananaed eeeneaded 19 Address RI 20 MPSS WN EE 21 erte 22 CT EE 23 How Keeseren eet erter eEeEe Eeer 23 1 Mail Server Framework MESSE 23 Ze CoolSpools SIT Pipes escanscecoe ts cdennncepievoct esa veeadetiee ned ndce cudesueeeedsteeeaedncecerns 24 Telling CoolSpools Email which method to use 24 Configuring CoolSpools Email to use Mail Server Framework aaasna000a0000000en 26 Configuring CoolSpools Email to use CoolSpools GMT 26 CFGSMTPSVR Configure SMTP Server Commande 27 Autostart servers AUTTOSTART aa 27 Number of initial servers NBRSVR ee 28 Run as user profile USER ENEE 28 Data queue library EE EE 28 Wiite log records LOG EE 29 Report errors to message queue ERHRHMSOO 29 Report errors to email address ERREMAIL cceeeeeeeeeeeeeeeeeeeeeeeeeeeenae
6. platform Options are 60 The default timeout is one minute timeout_seconds Specify the timeout in seconds CFMDEL Confirm delivery Options are NO YES Default No confirmation of delivery if requested The message is sent with an indication that you have requested that the recipient return confirmation of delivery When the message is opened if you have not switched off this feature the client software will either send a confirmation message back to the sender of the email or ask you whether you wish to send such a confirmation If YES is specified you may specify up to 32 email address name pairs to receive the confirmation messages The default is the single value SENDER which indicates that confirmation of delivery should be notified just to the email address specified as the sender on the FROM parameter SNDMLTMSG Send multiple messages Options are NO YES CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Default If you are sending an email to more than one recipient a single message will be created with multiple recipients When the message is received the reader will be able to see the names of all people to whom the message was sent If you are sending an email to more than one recipient multiple separate messages will be sent one to each recipient When the message is received the reader Page 59 SAVE Save options will see only their own name and
7. 2 2 CHARB 2 Stream file path Optional Parameter Group 5 Number of email addresses for confirmation emails INPUT BINARY 4 The number of confirmation recipient structures that follow Format of Confirmation Recipient Structures INPUT CHAR 8 The format of the Confirmation Recipient structures that follow CoolSpools Email User Guide V6R1 Page 124 www ariadnesoftware co uk Currently only one value is permitted CM_C0100 Confirmation Recipient Structures INPUT ARRAY 1 1024 of CHAR An array of from 1 to 1 1024 structures identifying email addresses to which the confirmation of delivery messages should be sent when confirmation of delivery is requested The default is to send the confirmation of delivery emails to the sender email address Each element in the array is a structure in the following format o o BINARY Length of recipient email address 7 2 JoHaRa 28 Recipient email address 130 82 Dans Length of recipient name 134 86 ua 28 Recipient name or ADRL Optional Parameter Group 6 Number of reply to email address structures INPUT BINARY 4 The number of reply to email address structures that follow Format of reply to email address structures INPUT CHAR 8 The format of the reply to email address structures that follow Currently only one value is permitted CM_Y0100 Reply to email address structures INPUT ARRAY 1 1024 of CHAR An array of from 1 to 1 1024 structures identifying email
8. but may no longer be valid For example if you re emailing a customer the person concerned might have left the company or changed their name e g got married or the company could have changed its name or been taken over All of these things can invalidate email addresses that worked at one time Options are SAME NONE CoolSpools Email User Guide V6R1 www ariadnesoftware co uk No change is made to the existing setting No message is sent Page 31 address Specify the email address to which information about non delivery should be sent Autostart in subsystem SBSD Specifies the name of the subsystem in which CoolSpools SMTP server jobs will autostart This is the subsystem to which CoolSpools will add two prestart job entries if AUTOSTART YES is specified It is still your responsibility to ensure that this subsystem is started when the system starts e g as part of the system startup program The default is the QUSRWRK subsystem This will be a convenient subsystem for most installations but if there is some reason why you cannot use QUSRWRK you can nominate a different subsystem here If you have CoolSpools Spool Admin installed you could choose to use the COOLSPOOLS subsystem supplied with that product option Single values SAME No change is made to the existing setting Other options are Qualifier 1 Autostart in subsystem QUSRWRK _ The default subsystem is QUSRWRK name Specify the name of the
9. user profile text description Else Sender name blanks no sender name will be used and the email address will show as the sender End If End If End If End If End If REPLYTO Send replies to The REPLYTO Send replies to parameter lets you specify the email address es to which replies to the email should be sent The default value is the single value SENDER which means that replies should be sent to the email address specified on the FROM parameter Up to 32 email addresses can be specified There are 2 elements to this parameter Email address and Name Email address Specify the email address to which replies should be directed or the name of an email address list or specify SELECT to select from email address directories Name Options are NONE Default No name is specified ADRL Address list If you wish to send to an address list this is the value that must be entered Name Specify the name of the recipient SUBJECT Subject The SUBJECT Subject parameter allows you to define a subject line for the message CoolSpools Email User Guide V6R1 Page 50 www ariadnesoftware co uk You can enter up to 256 characters of free format text Example SNDCMNMSG SUBJECT Example subject line When this message is received it will show as Subject Example subject line MSG Message text The MSG Message parameter allows you to enter the text of an email message directly on the command line Up to 4
10. 2 byte length In languages such as ILE RPG which support variable length character fields these fields can be defined as variable length For example the Subject parameter shown as a structure below can be defined in ILE RPG as 50A VARYING Format of Sender Structure INPUT CHAR 8 The format of the Sender parameter Currently only one value is permitted CM_F0100 Sender Structure INPUT CHAR A structure identifying the sender of the message Dec Hex Type 0 BINARY 2 Length of sender email address 7 CHAR 28 Gender email address 130 82 Bapu Length of sender name Number of recipients INPUT BINARY 4 The number of recipient structures that follow Format of Recipient Structures INPUT CHAR 8 The format of the Recipient structures that follow Currently only one value is permitted CM_T0100 CoolSpools Email User Guide V6R1 Page 118 www ariadnesoftware co uk Recipient Structures INPUT ARRAY 1 32 of CHAR An array of from 1 to 32 structures identifying recipients of the message Each element in the array is a structure in the following format 130 82 BINARY Length of recipient name 134 86 CHAR 128 Recipient name or ADRL 262 106 CHAR 10 Recipient type PRI CC BCC or ADRL Subject INPUT CHAR A structure defining the subject of the message Dec Hex Type o o BINARY Length of subject text 2 2 ung Subject tex Format of Message Structure INPUT CHAR
11. Communiqu or CoolSpools PLUS CoolSpools Email User Guide V6R1 Page 15 www ariadnesoftware co uk What s new in this release e SNDCMNMSG command enhancements New SAVE parameter allows the messages to be saved for re sending at a later time Saved messages can be encrypted and or compressed New LOG parameter lets you control whether a message is logged and whether the logged information is encrypted N B CoolSpools Email does not currently provide support for encrypted messages This encryption relates to information stored in the message log and saved messages New PWD parameter allows you to supply an encryption password which needs to be supplied before a previously saved encrypted password can be retrieved New EMAILID parameter allows you to retrieve a previously saved email message and send a new message based on the previous message Attachments are re attached and email parameters can be modified e New CRTCMNMSG command This new command provides a more user friendly interface for sending emails than the SNDCMNMSG command line interface e New DLTCMNMSG command This new command provides a way of deleting saved messages and message log contents based on the age of the message e New RSNCMNMSG command This new command lets you re send a saved message exactly as it was originally saved with the original attachments intact e New SNDCMNVCAL and SNDCMNICAL commands These new commands let you send calendar
12. Email User Guide V6R1 Page 35 www ariadnesoftware co uk Other options are Element 1 Number of attempts 1 99 Specify the number of third level retries to attempt Element 2 Retry interval hours 1 60 Specify the number of days to wait between retries Host name HOSTNAME Specifies the host name to use when identifying the local system to a target email server It is unlikely you will need to change this value unless the host name specified in the TCP IP attributes is invalid and cannot be corrected Options are SAME No change is made to the existing setting TCPATR The host name specified in the local system s TCP IP attributes is used CHGTCPDMN commana name Specify the host name to use Domain name DMNNAME Specifies the domain name to use when identifying the local system to a target email server It is unlikely you will need to change this value unless the host name specified in the TCP IP attributes is invalid and cannot be corrected Options are SAME No change is made to the existing setting TCPATR The domain name specified in the local system s TCP IP attributes is used CHGTCPDMN commana name Specify the domain name to use Mail server name or IP address MAILSERVER Specifies the name or IP address of a mail server via which emails should be sent CoolSpools Email User Guide V6R1 Page 36 www ariadnesoftware co uk Where it is not required or possible to send emails directly to the target email se
13. F3 Exit F5 Refresh F12 Cancel F17 Position CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Select this option to add a new address directory entry This option is available only on the first line of the display You can enter the new email address in the space available if desired This is equivalent to running the ADDADRDIRE Add Address Directory Entry command Select this option to change an existing address directory entry This is equivalent to running the CHGADRDIRE Change Address Directory Entry command Select this option to remove one or more address directory entries This is equivalent to running the RMVADRDIRE Remove Address Directory Entry command Select this option to display the details of an address directory entry Select this option to print an address directory entry Exit the application Refresh the list Return to the previous screen Display the positioner window to allow the list to be positioned to a specified address directory entry Page 97 Adding an address directory entry The ADDADRDIRE Add Address Directory Entry command allows you to add an entry to an address directory Command parameters are as follows ADRDIR The ADRDIR Address directory parameter allows you to specify the name of the address directory to which the entry is to be added EMAIL The EMAIL Email address parameter allows you to specify the email address to be added to the direct
14. No change is made to the existing setting YES Logging information is written for all emails successful or unsuccessful NO Only error information is logged Report errors to message queue ERRMSGQ Specifies the name of a message queue to which CoolSpools will send a message when an error occurs in the CoolSpools SMTP server jobs The default is the System Operator message queue QSYSOPR Single values SAME No change is made to the existing setting NONE No message is sent Other options are Qualifier 1 Report errors to message queue CoolSpools Email User Guide V6R1 Page 29 www ariadnesoftware co uk QSYSOPR The message is sent to the System Operator message queue name Specify the name of name of the message queue Qualifier 2 Library LIBL The message queue is located by means of the library list CURLIB The message queue is located in the current library of the job name Specify the name of library where the message queue is located Report errors to email address ERREMAIL Specifies an email address to which CoolSpools will send a message when an error occurs in the CoolSpools SMTP server jobs Options are SAME No change is made to the existing setting NONE No message is sent address Specify the email address to which information about errors should be sent Report non delivery to msgq DSNMSGQ Specifies the name of a message queue to which CoolSpools will send a message when an email cannot b
15. SNDCMNMSG command Address directory information is stored in file CM_ADRDIR If you wish to ensure that only a restricted number of people can maintain address directories you should set the authorities on this file appropriately for example by associating an authorization list with it CoolSpools Email Work with Address Directories System ARIADNE1 Type options press Enter 1 Creat 2 Chang 3 Copy 4 Delete 5 Display 6 Print entries 8 Work with directory entries Opt Address directory Text description SYSTEM System email address directory ACCOUNTS Accounts Department email address directory PETE Pete s personal directory SALES Sales Department email address directory Bottom F3 Exit F5 Refresh F12 Cancel F17 Position to Options that can be input against entries in the list are 1 Create Select this option to create a new address directory This option is available only on the first line of the display You can enter the name of the CoolSpools Email User Guide V6R1 Page 89 www ariadnesoftware co uk 2 Change 3 Copy 4 Delete 5 Display 6 Print entries 8 Work with entries Available command keys are F3 Exit F5 Refresh F12 Cancel F17 Position CoolSpools Email User Guide V6R1 www ariadnesoftware co uk new address directory in the space available if desired This is equivalent to running the CRTADRDIR Create Address Directory command Select this option to
16. The password to be None used when CS_EMAIL_SAVE_EN CRYPTED is YES Other possible values CONTINUE A warning message is issued but processing continues and any remaining files will be processed if they can be EMAIL email The email will be sent to the email address specified after the colon instead Processing then continues ADR let The email will be sent to the email address list specified after the colon instead Processing then continues SMTP The CoolSpools SMTP server is used This is now the recommended method 1 9999 YES The email is encrypted using the password specified o the CS_EMAIL_SAVE_PASSWO RD variable YES The email is saved The password to be used This must be specified in the form of a hex string as returned by the DSPENCPWD command CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Page 136
17. addresses to which replies CoolSpools Email User Guide V6R1 Page 125 www ariadnesoftware co uk to the email should be directed The default is to send the reply to the sender Each element in the array is a structure in the following format o o Panen Length of recipient email address 7 2 us 28 Recipient email address 130 82 BINARY 2 Length of recipient name 134 86 ua 28 Recipient name or ADRL Optional Parameter Group 7 Format of Save Options Structure INPUT CHAR 8 The format of the save option structure that follows Currently only one value is permitted CM_V0100 Save options Structure INPUT CHAR A structure in the following format Offset CHAR 1 Whether to save the email as a stream file so it can be resent at a later time Y Yes N No 1 1 CHARO Save encrypted Y Yes N No 2 2 Euann Save compressed Y Yes N No 3 3 BINARY Number of days to retain CoolSpools Email User Guide V6R1 Page 126 www ariadnesoftware co uk 7 7 BINARY Length of directory name CHAR 512 Name of the directory in which the email will be saved Optional Parameter Group 8 Format of Logging Options Structure INPUT CHAR 8 The format of the logging options structure that follows Currently only one value is permitted CM_L0100 Logging options Structure INPUT CHAR A structure in the following format Offset Dec Hex Type Field CHAR 1 Whether to log the sending of the
18. allows you to add an entry to an address list Command parameters are as follows ADRL The ADRL Address list parameter allows you to specify the name of the address list to which the entry is to be added EMAIL The EMAIL Email address parameter allows you to specify the email address to be added to the list This must be a valid i e well formed email address and must be unique within the address list NAME The NAME Name parameter enables you to enter the name of the person or organization the email address relates to TYPE The TYPE Type parameter defines the manner in which messages are sent to the email address being added to the list when the address list is used Options are PRI Default Primary recipient CC Carbon copy recipient An CC recipient receives a copy of the message and is identified to the primary recipient but is not the primary recipient BCC Blind carbon copy recipient An BCC recipient receives a copy of the message but is not identified to the primary recipient or CC recipients Example CoolSpools Email User Guide V6R1 Page 84 www ariadnesoftware co uk Adding an entry to the Sales Department address list ADDADRLE ADRL SALES EMAIL Joe Bloggs ariadnesoftware co uk NAME Joe Bloggs TYPE PRI CoolSpools Email User Guide V6R1 Page 85 www ariadnesoftware co uk Changing an address list entry The CHGADRLE Change Address List Entry command allows y
19. and is recommended for the system wide directory TEXT The TEXT Text Description parameter enables you to enter up to 50 characters of free format text to describe and further identify the address directory its contents and purpose Example Creating an address directory to store the email addresses used by members of the Sales Department CRTADRDIR ADRDIR SALES TEXT Sales Department directory CoolSpools Email User Guide V6R1 Page 91 www ariadnesoftware co uk Changing an address directory Option 12 from the CoolSpools Email menu runs the CHGADRDIR Change Address List command which allows you to change an existing address directory Command parameters are as follows ADRDIR The ADRDIR Address directory identifies the address directory you wish to change TEXT The TEXT Text Description parameter enables you to enter up to 50 characters of free format text to describe and further identify the address directory its contents and purpose Example Changing the text description on the Sales Department address directory CHGADRDIR ADRDIR SALES TEXT Sales Department address directory CoolSpools Email User Guide V6R1 Page 92 www ariadnesoftware co uk Copying an address directory Option 13 from the Coo lSpools Email menu runs the CPYADRDIR Copy Address List command which allows you to copy an existing address directory and create a new one Command parameters are as follo
20. delivered enter the name here The default value is NONE i e no name is provided and the email address will appear as the sender instead For example if you specify SNDCMNMSG FROM Sales ariadnesoftware co uk NONE when the message is received the From attribute will be shown as From Sales ariadnesoftware co uk However if you specify SNDCMNMSG FROM Sales ariadnesoftware co uk ariadne Sales when the message is received the From attribute will be shown as From ariadne Sales If CURRENT is specified the following method is used to determine the sender s name a The following fields are selected from the System Distribution Directory entry of the current user this can be changed using the WRKDIRE command gt first name FSTNAM last name LSTNAM preferred name PREFNAM user description USRD surname SURNAM Vv Vv V V WV given name GIVENNAM gt user address USRADDR b We then build a sender name using the following logic If preferred name is non blank Sender name preferred name Else CoolSpools Email User Guide V6R1 Page 49 www ariadnesoftware co uk If first name and last name are non blank Sender name FirstName LastName Else If given name and surname are non blank Sender name GivenName Surname Else If user description is non blank Sender name user description Else Retrieve user profile attributes If text description of user profile is non blank Sender name
21. email Y Yes N No Bi Log message in encrypted form Y Yes N No Optional Parameter Group 9 Format of Password Structure INPUT CHAR 8 The format of the password structure that follows Currently only one value is permitted CM_P0100 Password Structure INPUT CHAR CoolSpools Email User Guide V6R1 Page 127 www ariadnesoftware co uk A structure in the following format Offset CHAR 10 The password to use when saving the email in encrypted form when logging message details in encrypted form Optional Parameter Group 10 Format of Miscellaneous Options Structure INPUT CHAR 8 The format of the miscellaneous options structure that follows Two values are permitted CM_O0100 or CM_O0200 Note that the value CM_O0100 is permitted only for reasons of backwards compatibility and future features will be implemented using the CM_O0200 structure only Miscellaneous options structure A single structure defining various options Format for CM_O0100 Offset 0000 CHAR 5 Method by which to send the email MSF or SMTP 0005 BINARY 4 SMTP port number to use 0009 BINARY 4 SMTP timeout value seconds 000D BINARY 4 CCSID to use for the message CoolSpools Email User Guide V6R1 Page 128 www ariadnesoftware co uk 17 0011 CHAR 1 Whether or not to try to harmonize the encoding of a multipart message that uses multiple encodings Format for CM_O0200 Offset rics
22. enter is correct or that any reply sent to the message will be deliverable For example sales ariadnesoftware co uk is not a valid email address since it does not contain an sign and Coo Spools Email will reject it However sales ariadnesoftware org uk is a valid email address and Coo Spools Email will allow it but it is not ariadne s correct email address it should be sales ariadnesoftware co uk and any reply sent to this email address will not be received If CURRENT is specified the following method is used to obtain the sender s email address a The following fields are selected from the System Distribution Directory entry of the current user this can be changed using the WRKDIRE command gt user id USRID gt user address USRADDR gt SMTP user id SMTPUSRID gt SMTP domain SMTPDMN b We then build a sender email address using the following logic If SMTP user id and domain are non blank Email address SMTPUserId SMTPdomain Else If user id user address hostname and domain are all non blank Email address UserId UserAddress HostName Domain Else If host name and domain are non blank Email address UserProfile HostName Domain Else Error CMQ9105 Unable to identify email address for X EndIf EndIf EndIf CoolSpools Email User Guide V6R1 Page 48 www ariadnesoftware co uk Name If you would like you email message to display a sender s name rather than the sender email address when it is
23. entries appointments meeting invitations etc which can be received by any calendar application such as Outlook which supports vCalendar and iCalendar format messages e New API options CoolSpools Email User Guide V6R1 Page 16 www ariadnesoftware co uk Some of these options were added to V1 by PTF since the original release New alternative API format supports gt VV V VV V Message texts greater than 4096 bytes no practical imposed maximum length Up to 1024 attachments and recipients possible original maximum 32 Message text supplied in a stream file or database file member Confirmation of delivery sent to a different email address or addresses from the sender s email address Specification of options for saving email messages Specification of options for logging email messages Passwords for saved and or logged email messages when these are encrypted CoolSpools Email User Guide V6R1 Page 17 www ariadnesoftware co uk Important Note about POP settings Prior to OS 400 V5R3M0 the default for the POP MSGSPLIT attribute was set to a value which meant that large email attachments were split across multiple messages This often resulted in those email attachments becoming corrupted by the AS 400 email servers after they had been created by CoolSpools Email We recommend strongly that you set your MSGSPLIT level to NOMAX to prevent this happening e g CHGPOPA MSGSPLIT NOMAX If you are experiencin
24. further identify the new address list its contents and purpose CPYADRLE The CPYADRLE Copy address list entries allows you to indicate whether you want to copy the contents of the existing address list or just its description Options are YES Default Yes The contents of the address list are copied NO No The contents of the address list are not copied Example Copy the Sales Department address list to create a combined Sales and Marketing list CPYADRL FROMADRL SALES TOADRL SALES_AND_MARKETING TEXT Sales and Marketing address list CPYADRLE YES CoolSpools Email User Guide V6R1 Page 77 www ariadnesoftware co uk Deleting an address list The DLTADRL Delete Address List command allows you to delete an existing address list Command parameters are as follows ADRL The ADRL Address list identifies the address list you wish to delete Example Deleting the Sales Department address list DLTADRL ADRL SALES CoolSpools Email User Guide V6R1 Page 78 www ariadnesoftware co uk Converting a Distribution List to an Address List Option 11 from the CoolSpools Email menu runs the CVTDSTADRL Convert Distribution List to Address List command which allows you to convert a SNADS distribution list to an address list for use with CoolSpools Email If you were formerly a user of Office Vision 400 you may have SNADS distribution lists which are equivalent to CoolSpools Email address lists and which yo
25. idea for you do you have to support IBM System i batch jobs that run overnight or at weekends Why not put a call to CoolSpools Email in your program error handling routines That way when an error occurs you can receive an email at home or in the office Neat CoolSpools Email User Guide V6R1 Page 11 www ariadnesoftware co uk Prerequisites OS 400 V5R3M0 or higher 20 Mb of IBM System i disk space No PC is required CoolSpools Email User Guide V6R1 Page 12 www ariadnesoftware co uk Upgrade Notes Please read the following notes carefully before upgrading to CoolSpools Email V6R1MO from an earlier version of Communiqu or CoolSpools PLUS CoolSpools Email was previously available as both a standalone module called Communiqu and also as part of the complete CoolSpools PLUS suite Now CoolSpools Email is packaged as a product option option 2 of CoolSpools VG MO To determine which version of CoolSpools PLUS or Communiqu you are running check the name of the library in which the SNDCMNMSG command object you are using resides e g DSPOBJD OBJ SNDCMNMSG OBJTYPE CMD The library name corresponds to the product and version of CoolSpools as shown in the table below Product Licensed Version Library Name Program Id CMNQUEV1R1 1CMNQUE Communiqu Version 1 COOLSPV5R1 5COOLSP CoolSpools PLUS V5R1M0 If your command is in a library other than those shown you are either running an
26. items and will allow the recipient to perform calendar functions against them You can use this facility to have the IBM System i schedule meetings events etc Command parameters are as follows SUMMARY Specify summary text for the item This text appears in the subject line of calendar items received by Outlook STATUS The status of the item Options are TENTATIVE Tentative CONFIRMED Confirmed CANCELLED Cancelled START The start date and time of the item Options for the date are TOMORROW Default Tomorrow s date is automatically supplied TODAY Today s date is automatically supplied Start_date Specify the start date CoolSpools Email User Guide V6R1 Page 103 www ariadnesoftware co uk DURATION The duration of the item specified in terms of a number of units and a unit code Options for the unit code are HOUR Default Hours MINUTE Minutes DAY Days WEEK Weeks MONTH Months YEAR Years LOCATION The location of the event meeting etc specified as free form text ORGANIZER The organizer of the meeting There are 2 elements to this parameter Email address and Name Email address The email address of the sender of the message and organizer of the event The default is CURRENT which tells CoolSpools Email to retrieve the email address of the user running the command from the system distribution direction See the TO parameter of the SNDCMNMSG command for further details
27. must have sufficient authority to all required objects in particular USE authority to library COOLSPV6R1 and the programs and files it contains The default is QUSER There is no need to change this unless QUSER does not have sufficient authority to play this role Options are SAME No change is made to the existing setting JOBD The user profile specified in the job description is used The job description is CM_SNDSVRR for the Send Server and CM_RTYSVRR for the Retry Server name Specify the name of the user profile Data queue library DTAQLIB Specifies the name of the library in which the data queue used to communicate between the sending application and the CoolSpools SMTP server jobs will be created The default is PRDLIB which means that the data queue will be created in the product library COOLSPV6R1 There is no need to change this default unless there is some CoolSpools Email User Guide V6R1 Page 28 www ariadnesoftware co uk reason why that library is inappropriate Options are SAME No change is made to the existing setting PRDLIB The data queue is created in the product library COOLSPVE6R1 name Specify the name of the library where the data queue will be created Write log records LOG Specifies whether or not log records should be written for all emails It is recommended that this option be left as the default YES unless the volume of data being written becomes a problem Options are SAME
28. screen Exit the application Reset the screen Insert a line in the message text area Select email addresses from an address directory Send the message Show the second screen which provides further email options and attachment functionality Return to the previous screen Delete a line in the message text area Pressing F11 from this first screen displays the second screen which looks like this CoolSpools Email Create Email Message ARIADNE1 essage format BOTH Priority s amp 6 s e N Confirm delivery N Send multiple msg N Encryption password Log message Y Log encrypted N Save for resending N Save encrypted N Save compressed Y Retention period 9999 days Save in directory CURDIR Message stream fil A s S45 Se Attachments ee EES 1 File name Method ATTACH Content FILE Codepage STMF 2 File name CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Page 67 Method ee a ATTACH Content FILE Codepage STMF F3 Exit F5 Refresh F10 Send The various fields are Message format Priority Confirm delivery Send multiple msgs Encryption password Log message Log encrypted Save for resending Save encrypted CoolSpools Email User Guide V6R1 www ariadnesoftware co uk More Fll Screen 1 The format in which the message is sent TEXT HTML or BOTH The mes
29. set up such as email address lists and email address directories as well as historical information such as message logs The data imported includes e Email address lists e Email address directories e Logged messages e Next email identifier Restrictions The files in the from and to libraries must not be in use at the time when this command is run Command parameters are as follows FROMLIB Specifies the library from which the data is to be imported Options are CMV1R1 The Communiqu V1R1M0 product library CMNQUEV1R 1 CPV5R1 The CoolSpools PLUS V5R1M0 product library COOLSPV5R1 name Specify the name of the library where the Communiqu files are held REPLACE Specifies whether data in the target files will be replaced if they are not empty Options are CoolSpools Email User Guide V6R1 Page 113 www ariadnesoftware co uk NO The data is not replaced The command will fail if the target files already contain data YES Any data in the target files will be overwritten CoolSpools Email User Guide V6R1 Page 114 www ariadnesoftware co uk Using the CoolSpools Email Send AP CM_SNDAPIR As an alternative to using the SNDCMNMSG command you can also call the CoolSpools Email API to send an email message If you want to send an email from a program written in a language such as RPG or COBOL this may be easier than using SNDCMNMSG In addition the length of the free format message text that can be def
30. specified maximum number of second level retries waiting the specified number of hours between retries e Finally retry sending the email the specified maximum number of third level retries waiting the specified number of days between retries Where the email could not be sent due to a temporary outage it is possible a subsequent retry will succeed Single values CoolSpools Email User Guide V6R1 Page 34 www ariadnesoftware co uk SAME No change is made to the existing setting NONE No first level retries will be made Other options are Element 1 Number of attempts 1 99 Specify the number of first level retries to attempt Element 2 Retry interval minutes 1 60 Specify the number of minutes to wait between retries Second level retries LVL2RETRY Specifies the number of second level retries to be made and the interval in hours between second level retries Single values SAME No change is made to the existing setting NONE No second level retries will be made Other options are Element 1 Number of attempts 1 99 Specify the number of second level retries to attempt Element 2 Retry interval hours 1 60 Specify the number of hours to wait between retries Third level retries LVL3RETRY Specifies the number of third level retries to be made and the interval in days between third level retries Single values SAME No change is made to the existing setting NONE No third level retries will be made CoolSpools
31. to running the CHGADRL Change Address List command Select this option to copy an existing address list and create a new address list This is equivalent to running the CPYADRL Copy Address List command Select this option to delete one or more address lists This is equivalent to running the DLTADRL Delete Address List command Select this option to display the details of an address list Select this option to print the details of an address list and the entries it contains Select this option to work with the entries contained in an address list This is equivalent to Page 73 Available command keys are F3 Exit F5 Refresh F12 Cancel F17 Position CoolSpools Email User Guide V6R1 www ariadnesoftware co uk running the WRKADRLE Work with Address List Entries command Exit the application Refresh the list Return to the previous screen Display the positioner window to allow the list to be positioned to a specified address list Page 74 Creating an address list The CRTADRL Create Address List command allows you to create an address list Command parameters are as follows ADRL The ADRL Address list parameter allows you to specify the name which will be used to identify the address list The name must be unique and must conform to the normal rules for IBM System i object names except that it may be up to 20 characters in length TEXT The TEXT Text Description parameter enables
32. to copy TOADRDIR The TOADRDIR To address directory identifies the address directory to which you wish to copy the address directory entries Example Copy the contents of the Sales Department address directory to a new combined Sales and Marketing directory CPYADRDIRE FROMADRDIR SALES TOADRDIR SALES_AND_MARKETING CoolSpools Email User Guide V6R1 Page 101 www ariadnesoftware co uk Removing an address directory entry The RMVADRDIRE Remove Address Directory Entry command allows you to remove an entry from an address directory Command parameters are as follows ADRDIR The ADRDIR Address directory parameter identifies the address directory in which the entry you wish to remove can be found EMAIL The EMAIL Email address parameter identifies the address directory entry you wish to remove Example Removing Joe Bloggs from the Sales Department address directory RMVADRDIRE ADRDIR SALES EMAIL Joe Bloggs ariadnesoftware co uk CoolSpools Email User Guide V6R1 Page 102 www ariadnesoftware co uk SNDCMNICAL command Option 31 Send calendar item iCalendar format prompts the SNDCMNICAL Send iCalendar Item command which allows you to send a calendar item in iCalendar format Calendar items sent using SNDCMNICAL can be received by email client software which support the iCalendar format such as Outlook but NOT Outlook Express Outlook will display items sent by SNDCMNICAL as calendar
33. used This requires a user ID and password to be provided to the server Transport Layer Security TLS is used to encrypt traffic between the sending system and the receiving system making this mechanism significantly more secure than PLAIN The AUTH CRAM MD5 mechanism is used This requires a user ID and password to be provided to the server The password is never itself sent across the connection and the level of encryption used is strong Transport Layer Security TLS is used to encrypt traffic between the sending system and the receiving system Page 38 making this mechanism significantly more secure than CRAM MD5 alone Server login SVRLOGIN Specifies the user ID and password that are used for authentication purposes Single values SAME The information is unchanged NONE No user ID or password is provided Element 1 User char value Specify the user ID Element 2 Password char value Specify the user password CoolSpools Email User Guide V6R1 Page 39 www ariadnesoftware co uk Managing the CoolSpools SMTP servers When you run the Configure SMTP Server command if you specified YES for the Autostart servers options CoolSpools will attempt to set up your environment ready for using this method of delivering emails Assuming no problems occurred e g no authority issues arose it will have added the necessary prestart job entries to the subsystem you chose If that subsystem is active the CoolSpools SMT
34. you to enter up to 50 characters of free format text to describe and further identify the address list its contents and purpose Example Creating an address list to store the email addresses of members of the Sales Department CRTADRL ADRL SALES TEXT Sales Department CoolSpools Email User Guide V6R1 Page 75 www ariadnesoftware co uk Changing an address list The CHGADRL Change Address List command allows you to change an existing address list Command parameters are as follows ADRL The ADRL Address list identifies the address list you wish to change TEXT The TEXT Text Description parameter enables you to enter up to 50 characters of free format text to describe and further identify the address list its contents and purpose Example Changing the text description on the Sales Department address list CHGADRL ADRL SALES TEXT Sales Department address list CoolSpools Email User Guide V6R1 Page 76 www ariadnesoftware co uk Copying an address list The CPYADRL Copy Address List command allows you to copy an existing address list and create a new one Command parameters are as follows FROMADRL The FROMADRL From address list identifies the address list you wish to copy TOADRL The TOADRL To address list identifies the address list you wish to create TEXT The TEXT Text Description parameter enables you to enter up to 50 characters of free format text to describe and
35. 096 characters of free format text can be entered here However due to limitations of the OS 400 command prompter only 512 characters can be entered when the command is prompted with F4 If you need to send more than 4096 characters of text then your options are gt Use MSG STMF and specify a stream file containing the text of the message to be sent on the MSGSTMF parameter gt Use an embedded text or HTML file see the ATTACH parameter below gt Use the CoolSpools Email API which allows virtually unlimited text if the CM_SNDMSG2 form is used The message can be sent in either plain text HTML or alternative plain text HTML formats There are 2 elements to this parameter Message text and Message format Message text You can enter the text of a short message here Up to 512 characters can be entered When received the message will be displayed exactly as it is entered with the following exceptions gt If you want to force a line break enter lt br gt Even if the message is sent in plain text format this HTML control will be interpreted and converted to a hard line break carriage return line feed sequence gt Other HTML controls may be entered but will only be interpreted as CoolSpools Email User Guide V6R1 Page 51 www ariadnesoftware co uk HTML controls if the message is sent and delivered in HTML format Longer messages up to 4096 bytes can be sent using the CoolSpools Email API CM_SNDAPIR Alter
36. 8 The format of the Message structure that follows Two values are permitted with this parameter definition CM_M0100 and CM_M0200 CoolSpools Email User Guide V6R1 Page 119 www ariadnesoftware co uk Message Structure INPUT CHAR A structure defining the message to be sent if any in one of the following formats Format for CM_0100 o o Panen Length of message text 2 2 CHAR 4096 Message text Specify STMF to tell CoolSpools Email to take the text of the message from a stream file defined on optional parameter group 4 4098 1002 CHAR S Message type BOTH TEXT or HTML Format for CM_0200 Offset aE A pointer to the message text 16 10 BINARY 4 The length of the message text pointed to by the previous element mu 14 Bann The CCSID of the message text 24 me ua 0 Message type BOTH TEST or HTML Number of attachments INPUT BINARY 4 The number of attachment structures that follow CoolSpools Email User Guide V6R1 Page 120 www ariadnesoftware co uk Format of Attachment Structures INPUT CHAR 8 The format of the Attachment structures that follow Two values are permitted CM_A0100 or CM_A0200 Attachment Structures INPUT ARRAY 1 32 of CHAR An array of from 1 to 32 structures identifying attachments to the message Each element in the array is a structure in one of the following formats Format for CM_A0100 Dec Hex Type Field 514 ap CHAR 7 Attachment me
37. ADRDIR SALES CoolSpools Email User Guide V6R1 Page 95 www ariadnesoftware co uk Working with Address Directory Entries Address Directory entry information is stored in file CM_DIRENT If you wish to ensure that only a restricted number of people can maintain address directories you should set the authorities on this file appropriately for example by associating an authorization list with it The WRKADRDIRE Work with Address Directory Entries command allows you to add and manage address directory entries There is a single command parameter ADRDIR The ADRDIR Address Directory identifies the address directory whose entries you wish to work with Alternatively use the WRKADRDIR Work with address directories command and enter option 8 Work with Address directory entries against the address directory in which you are interested CoolSpools Email Work with Address Directory Entries System ARIADNE1 Address directory ACCOUNTS Text description Accounts Department email address directory Type options press Enter 1 Add 2 Chang 4 Remov 5 Display Opt Email address joe bloggs customer com john doe customer com Bottom F3 Exit F5 Refresh F12 Cancel F17 Position CoolSpools Email User Guide V6R1 Page 96 www ariadnesoftware co uk Options that can be input against entries in the list are 1 Add 2 Change 4 Remove 5 Display 6 Print Available command keys are
38. BSD parameter above in which case you should specify the name of a suitable job queue which has a job queue entry in the nominated subsystem here It is your responsibility to ensure that the job queue specified has a suitable job queue entry in the subsystem description of the subsystem in which you wish these jobs to run The job queue entry must allow at least the required number of send server jobs plus the one retry server job to run simultaneously CoolSpools Email User Guide V6R1 Page 33 www ariadnesoftware co uk Single values SAME No change is made to the existing setting Other options are Qualifier 1 Submit to job queue QUSRNOMAX The system supplied job queue QUSRNOMAX is used As supplied by IBM this has a job queue entry in subsystem QUSRWRK which allows an unlimited number of jobs to run concurrently JOBD The job queue specified in the job description CM_SNDSVRR Send Server or CM_RTYSVRR Retry Server is used name Specify the name of the job queue Qualifier 2 Library LIBL The job queue is located through the library list CURLIB The job queue is located in the current library name Specify the name of the library in which the job queue is located First level retries LVL1RETRY When an email cannot be sent CoolSpools will e First retry sending the email the specified maximum number of first level retries waiting the specified number of minutes between retries e Then retry sending the email the
39. METHOD Meet 58 CFMDEL Confirm El 59 SNDMLTMSG Send multiple messages 59 SAVE Save optons neresen renne 60 LOG Logging Options EEN 61 PWD Encryption password EE 61 CHARSET Character set encoding cccceeeeeeeeeeeeeeneeeeeeeeeeeteeeeeneeeeeeeees 62 OPTIONS Miscellaneous Options ENEE 64 CRICMNMS Gi COmmanG E 66 PONGMNMSG COMM ANG EE 70 EMAIHID EE 70 DLTCMNMSG command BEE 71 DLTCMNMSG command EE 71 DE TSAVM EE 71 Eug Klee KE 71 Working with Email Address Uets 72 EECHER ENEE ee eege 75 ee 75 EE ee 75 Changing anraGoress EE 76 EE Ee 76 Eeer EE 76 lune 76 Copying an address EH 77 ROMA DR a e Ee ER Eae EAEE ERE AAE EEEa ea rae aoa 77 TOADR i EE AEE ee E ES 77 MEXT e a aa a N 77 CPYADRLE spe i insist ientotitelieted sonst letat tonsa tedionttsensmliens 77 Deleting an address lists Sao ala haa ao A alan Sara aaa sta 78 510 3 Aere Seer ert Srey rer er mr tty Wr Wr Wnt Seer enter Wr Urey Sr er Ure Wr er ere Wwe Srv Wr Wr Ort er 78 Converting a Distribution List to an Address Ust aaeeea 79 DST BEE 79 LR EE 79 NEE 79 HOSTNAME zsa a a E a 80 Els EE 80 Working with Address List Entries ccceceeeeeeeeeeeeeneeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee 82 EI EE 82 Adding an address list entry EE 84 ADRE E E E dca E E E 84 EMAI ee 84 NAME anan a ee eege 84 Ee 86 EMAIL te 86 DEE 86 DEE 86 Copying address listentriesS acs canadian Maa aa 87 FROMA DR ere EE EE EEN 87 TOAD EE 87 Removing an ad
40. MTP application You can use IBM s Digital Certificate Manager software to associate a certificate with an application The name of the application that requires the certificate associated with it is ARRIADNE_SMTP_SERVER Single values CoolSpools Email User Guide V6R1 Page 37 www ariadnesoftware co uk SAME NONE Element 1 Mechanism LOGIN PLAIN CRAMMD5 TLSLOGIN TLSPLAIN TLSCRAM CoolSpools Email User Guide V6R1 www ariadnesoftware co uk The authentication mechanism is not changed No authentication is used The AUTH LOGIN mechanism is used This requires a user ID and password to be provided to the server The user ID and password are not sent as plain text but the level of encryption used is very weak The AUTH PLAIN mechanism is used This requires a user ID and password to be provided to the server The user ID and password are not sent as plain text but the level of encryption used is very weak The AUTH CRAM MD5 mechanism is used This requires a user ID and password to be provided to the server The password is never itself sent across the connection and the level of encryption used is strong The AUTH LOGIN mechanism is used This requires a user ID and password to be provided to the server Transport Layer Security TLS is used to encrypt traffic between the sending system and the receiving system making this mechanism significantly more secure than LOGIN The AUTH PLAIN mechanism is
41. NMSG you will need to supply the encryption password N B CoolSpools Email does not currently provide support for encrypted messages This password simply relates to the encryption of information stored in the message log and saved messages CHARSET Character set encoding Specifies the character set to be used to encode the message body part of the email Note that other character sets may be used to encode parts of the message such as attachments where necessary or as requested Character set encoding Options are ENVVAR CALC UTF8 WINDOWS WINDOWSCE WINDOWSCYRILLIC WINDOWSGREEK CoolSpools Email User Guide V6R1 www ariadnesoftware co uk CoolSpools uses the value of environment variable CS_EMAIL_DFT_CHARSET which can be set to any of the values listed below or to a CCSID number If the environment variable does not exist or is set to an invalid value CALC will be assumed CoolSpools Email calculates an appropriate character set in which to encode the message If the CCSID of the job is a single byte Latin 1 encoding ISO 5589 1 Latin 1 CCSID 819 is used otherwise UTF 8 is used UTF 8 CCSID 1208 Windows CCSID 1252 Windows CE CCSID 1250 Windows Cyrillic CCSID 1251 Windows Greek CCSID 1253 Page 62 WINDOWSTURKISH WINDOWSHEBREW WINDOWSARABIC WINDOWSBALTIC WINDOWSVIET ISOLATIN1 ISOLATIN2 ISOCYRILLIC ISOARABIC ISOGREEK ISOHEBREW ISOTURKISH Harmo
42. Name The name of the sender of the message and organizer of the event DESCRIPT A free format description of the event If the special value DESCRIPT STMF is specified the text can be taken from a stream file specified on the DSCSTMF parameter CoolSpools Email User Guide V6R1 Page 104 www ariadnesoftware co uk DSCSTMF Specifies the path to a stream file containing the free format description of the event DESCRIPT STMF must be specified to use this option ATTENDEES The ATTENDEES parameter allows you to specify the email addresses to which the email message should be sent and thereby the people to be invited to participate in the event There are 5 elements to this parameter Email address The email address of the attendee Name The name of the attendee Role The attendee s role in the event Options are REQUIRED The person is required to attend OPTIONAL The person s attendance is optional INFORMATION The message is for information only CHAIR The person will chair the event Status Specifies the participation status for the calendar user specified by the property Options are ACTION Default Action is required ACCEPTED The invitation has been accepted TENTATIVE The invitation has been tentatively accepted CoolSpools Email User Guide V6R1 Page 105 www ariadnesoftware co uk DELCLINED The invitation has been declined DELEGATED The invitation has been delegated RSVP Whether a res
43. P server jobs should automatically start to run To check do WRKSBSJOB SBS QUSRWRk or WRKSBSJOB SBS subsystem_name_here if you nominated a different subsystem and see if you can find jobs called CM_SNDSVRR and CM_RTYSVRR If they are there then CoolSpools was able to add and start the prestart job entries and you re ready to send emails this way If at any time you need to start or end the CoolSpools SMTP servers manually you can use the STRSMTPSVR Start SMTP Servers and ENDSMTPSVR End SMTP Server commands to do so STRSMTPSVR Start SMTP Server command The Start CoolSpools SMTP Server STRSMTPSVR command starts the specified number of CoolSpools SMTP server jobs used to send emails via the CoolSpools SMTP server method It is available as option 11 of the SMTPEMAIL menu Restrictions e You must have JOBCTL special authority to run this command e The jobs will be submitted to the job queue specified on the JOBQ option of the CoolSpools SMTP server attributes CFGSMTPSVR command is started e You must ensure that this job queue has a job queue entry in an active subsystem and that at least the number of send server jobs specified can run concurrently plus the retry server job CoolSpools Email User Guide V6R1 Page 40 www ariadnesoftware co uk Number of server jobs to start NBRJOBS Specifies the number of jobs used for sending emails that will be started Options are SVRATR The number of server jobs s
44. ages 22 Format of confirmation email addresses Input CHAR 8 23 Email addresses for confirmation messages Input CHAR Optional Parameter Group 6 24 Number of reply to email address structures Input BIN ARY 4 25 Format of reply to structures Input CHAR 8 26 Reply to email address structures Input CHAR Omissible parameter group 7 27 Format of save options structure Input CHAR 8 28 Save options structure Input CHAR Omissible parameter group 8 29 Format of logging options structure Input CHAR 8 30 Logging options structure Input CHAR Omissible parameter group 9 31 Format of password structure Input CHAR 8 32 Password structure Input CHAR CoolSpools Email User Guide V6R1 Page 132 www ariadnesoftware co uk Required Parameter Group As above except Array of Recipient Structures INPUT CHAR A buffer containing an array of from 1 to 1024 structures identifying recipients of the message Attachment Structures INPUT CHAR A buffer containing an array of from 1 to 1024 structures identifying attachments to the message CoolSpools Email User Guide V6R1 Page 133 www ariadnesoftware co uk The CoolSpools Email Database CoolSpools Email includes a number of database tables which you may find useful These are listed and explained below Message Log CM_MSGLOG Message Log file CM_MSGLOG logs each email message that is sent Each message is identified by a 30 byte message identifier This is the mes
45. alue Example CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Diagnostic mode Run the command in diagnostic mode Default NO Options YES NO This option should only be used if instructed to do so by ariadne Defines a variable called var_name the value of which is specified on the next element The variable can be specified in the form lt var_name gt wherever CoolSpools variables are supported on this command e g message text and subject line If the message text or subject contains this variable marker it will be replaced at run time with the value specified on the next element Specify the option value corresponding to the option key Page 64 SNDCMNMSG SUBJECT Order number lt ORDER_NUMBER gt confirmed OPTIONS lt ORDER_NUMBER gt 12345 Sends a message with the subject line Order number 12345 confirmed The value 12345 could be supplied by a variable in a CL program CoolSpools Email User Guide V6R1 Page 65 www ariadnesoftware co uk CRICMNMSG command Option 2 from the CoolSpools Email menu runs the CRTCMNMSG Create CoolSpools Email Message command which allows you to send an email message The same functionality is available from the SNDCMNMSG Send CoolSpools Email Message command and the CoolSpools Email Send Message API Application Program Interface which are described in a later section of this document CRTCMNMSG provides a
46. arameter Group 2 17 Number of messages created Output BINARY 4 Optional Parameter Group 3 18 Size of email id buffer next parameter Input BINARY 4 19 Email id buffer Output CHAR Optional Parameter Group 4 20 Stream file containing message text Input VARCHAR 512 Optional Parameter Group 5 21 Number of email addresses for confirmation Input BIN ARY 4 messages 22 Format of confirmation email addresses Input CHAR 8 23 Email addresses for confirmation messages Input CHAR Optional Parameter Group 6 CoolSpools Email User Guide V6R1 Page 116 www ariadnesoftware co uk 24 Number of reply to email address structures Input 25 Format of reply to structures Input 26 Reply to email address structures Input Omissible parameter group 7 27 Format of save options structure Input 28 Save options structure Input Omissible parameter group 8 29 Format of logging options structure Input 30 Logging options structure Input Omissible parameter group 9 31 Format of password structure Input 32 Password structure Input Omissible parameter group 10 33 Format of miscellaneous options structure Input 34 Miscellaneous options structure Input CoolSpools Email User Guide V6R1 www ariadnesoftware co uk BIN ARY 4 CHAR 8 CHAR CHAR 8 CHAR CHAR 8 CHAR CHAR 8 CHAR CHAR 8 CHAR Page 117 Required Parameter Group Note that many of the structures shown below include text fields preceded by a
47. ble called CS_EMAIL_METHOD If you set this at system level to either MSF or SMTP the Mail Server Framework or CoolSpools SMTP method becomes the default system wide respectively If the environment variable does not exist or if it has a value other than MSF or SMTP Mail Server Framework is currently the default as before fix pack 122 To set this environment variable you can either run one of these commands ADDENVVAR ENVVAR CS_EMAIL_METHOD VALUE MSF LEVEL SYS ADDENVVAR ENVVAR CS_EMAIL_METHOD VALUE SMTP LEVEL SYS or take one of the new options from the EMAIL menu 43 Change default email delivery method to IBM MSF 44 Change default email delivery method to CoolSpools SMTP which do the same thing This will change the default method used for sending emails but only in respect of emails sent by CoolSpools Version 6 this doesn t affect any other AS 400 applications that send email including earlier versions of CoolSpools Communiqu If for some reason you want to use a different method for a particular email perhaps to test the new SMTP method while continuing to use MSF as the default you can specify the method explicitly on the appropriate command parameter also METHOD parameter of SNDCMNMSG or EMAILOPT parameter of CVTSPLxxx or CVTDBFxxx The options are MSF Mail Server Framework or SMTP CoolSpools SMTP CoolSpools Email User Guide V6R1 Page 25 www ariadnesoftware co uk Configuring Co
48. calendar items and will allow the recipient to perform calendar functions against them You can use this facility to have the IBM System i schedule meetings events etc Please note that we recommend the use of iCalendar items created using SNDCMNICAL rather than vCalendar items created using SNDCMNVCAL with MS Outlook as iCalendar provides better functionality Command parameters are as per SNDCMNVCAL with the following exceptions ATTENDEES Role Options are ATTENDEE Indicates an attendee at the event ORGANIZER Indicates organizer of the event but not owner OWNER Indicates owner of the event DELEGATE Indicates a delegate of another attendee Status Specifies the participation status for the calendar user specified by the property Options are ACTION Event requires action by attendee SENT Event was sent out to attendee TENTATIVE Event is tentatively accepted by attendee CONFIRMED Attendee has confirmed their attendance at the CoolSpools Email User Guide V6R1 Page 111 www ariadnesoftware co uk event DECLINED Event has been rejected by attendee DELEGATED Event has been delegated by the attendee to another CoolSpools Email User Guide V6R1 Page 112 www ariadnesoftware co uk IMPEMLDTA command You can use the IMPEMLDTA Import Email Data command supplied with CoolSpools Email VG MO to migrate Communiqu user setup data from Communiqu or CoolSpools PLUS This provides a means of preserving data that you have
49. carbon copy recipient An BCC recipient receives a copy of the message but is not identified to the primary recipient or CC recipients ADRL Address list If you wish to send to an address list this is the value that must be entered Example Sending to ariadne Sales as a primary recipient with a copy to ariadne Marketing SNDCMNMSG TO Sales ariadnesoftware co uk Sales PRI Marketing ariadnesoftware co uk Marketing CC Example Sending to an email address list called Sales SNDCMNMSG TO Sales ADRL ADRL FROM Sender The FROM Sender parameter allows you to specify the sender of the email The default value is CURRENT which means that Coo Spools Email will try to retrieve the email address of the user sending the email from the System Distribution Directory If CoolSpools Email User Guide V6R1 Page 47 www ariadnesoftware co uk no email address can be determined for the user from the System Distribution Directory you will need to enter the values you wish to use manually There are 2 elements to this parameter Email address and Name Email address This is where you enter the email address of the sender which will also be the address to which by default a reply to this email should be directed Note that while CoolSpools Email will check that the email address that you enter conforms to the rules for valid email addresses it is not possible to validate that the email address that you
50. change the details of an existing address directory This is equivalent to running the CHGADRDIR Change Address Directory command Select this option to copy an existing address directory and create a new address directory This is equivalent to running the CPYADRDIR Copy Address Directory command Select this option to delete one or more address directories This is equivalent to running the DLTADRDIR Delete Address Directory command Select this option to display the details of an address directory Select this option to print the details of an address directory and the entries it contains Select this option to work with the entries contained in an address directory This is equivalent to running the WRKADRDIRE Work with Address Directory Entries command Exit the application Refresh the list Return to the previous screen Display the positioner window to allow the list to be positioned to a specified address directory Page 90 Creating an address directory The CRTADRDIR Create Address Directory command which allows you to create an address directory Command parameters are as follows ADRDIR The ADRDIR Address directory parameter allows you to specify the name which will be used to identify the address directory The name must be unique and must conform to the normal rules for IBM System i object names except that it may be up to 20 characters in length The special value SYSTEM is also allowed
51. cify AUTOSTART YES CoolSpools will add two prestart job entries to the subsystem nominated below e Program CM_SNDSVRR Send Server this does the sending e Program CM_RTYSVRR Retry Server this manages retries When the nominated subsystem starts these prestart job entries will cause the required jobs to start Options are SAME No change is made to the existing setting YES The server jobs will start automatically NO The server jobs will not start automatically You will need to start them manually with the STRSMTPSVR command CoolSpools Email User Guide V6R1 Page 27 www ariadnesoftware co uk Number of initial servers NBRSVR Specifies how many SMTP server jobs should be started initially when the servers are set to AUTOSTART YES The number of servers that should be started will depend on the volume of emails being generated If a large volume of emails is being sent and a backlog is developing because the number of server jobs available to process those emails cannot cope with that volume starting additional server jobs will probably improve throughput The default is 3 which will be a reasonable number for most environments Additional servers can be started with the STRSMTPSVR command Options are SAME No change is made to the existing setting 1 99 Specify the number of server jobs to autostart Run as user profile USER Specifies the user profile under which the SMTP server jobs will The user profile
52. dress list entry un 87 LTE EE 87 Eelere 88 Working with Email Address Directories Aen 89 Creating an address EEN 91 Eege 91 TEA eege deed 91 Changing an address directory EE 92 ADRDIR E 92 RE 92 Copying an address directory E 93 tele ET 93 TOAD eege 93 EE 93 GPCA DED IIE ss EE 93 Deleting an address directory EEN 95 EE 95 Working with Address Directory Entree 96 ADRDIR E 96 Adding an address directory entry cccceeceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeceeeneeeeeeeeeeeeeees 98 EE 98 WIPE EE 98 enn LEE 98 SEENEN 98 PREFIX n ere EE 98 MDDLENAME rren a a E r a E eE E OE E EEEE 98 SUFFIX e e A E E EE 98 EISE 99 len 99 EMAIE NAM E tirean aana ee a toca tad aln cs tos ninai a e e AA A 99 Changing an address directory entry EE 100 Ee 100 Elle eet 100 Copying address directory entries EEN 101 GT LEET 101 TOADRDIR ee 101 ADRDIR ee 102 El 102 SNDGMNIGAL COMMANG EE 103 SUMMARY E 103 E OR 103 SAM RE E 103 DURATION EE 104 OG AON EN 104 ORGANIZER E 104 OE SO E 104 Nee eebe eegene eeben 105 ATTENDEE E 105 ATTACH RE 106 POUR GE 109 EE 109 EE 109 SNDCMNVGAL command HE 111 PAST TNE Se EE E E 111 IMPEMLDTA command ssssnnneeeeeeeeesenrrnrrrersserrrrrnnnrtesstrrrrrnnnntneserrrnnnnnnnnnseennne 113 Restrictions EE 113 re ET 113 REPLACE EE 113 Using the CoolSpools Email Send API CM_SNDAPIR seeen 115 Required Parameter Group icrctecccanetadereesdederibebedyathebetetihataduiubalaetube bebuerbebenes 118 Optional Para
53. e delivered Single values SAME No change is made to the existing setting NONE No message is sent Other options are Qualifier 1 Report non delivery to msgq CoolSpools Email User Guide V6R1 Page 30 www ariadnesoftware co uk QSYSOPR name Qualifier 2 Library LIBL CURLIB name The message is sent to the System Operator message queue Specify the name of name of the message queue The message queue is located by means of the library list The message queue is located in the current library of the job Specify the name of library where the message queue is located Report non delivery to email DSNEMAIL Specifies an email address to which CoolSpools will send a message when an email cannot be delivered It is strongly recommended you supply an email address on this parameter and that someone in your organization is given the task of monitoring this email address regularly This will then ensure that any emails which cannot be sent for whatever reason can be corrected in the appropriate fashion You must always anticipate that some emails that you send will not be delivered because for example e tis very easy to mis key an email address as you enter it Although CoolSpools email validates email addresses what you have entered may be well formed i e look like a valid email address but still not be usable e The email address you re sending to may have been valid at some point in the past
54. eated Nbr_of_days Specify the minimum number of days ago that the message must have been saved for it to be eligible for deletion DLTLOGDTA The DLTLOGDTA Delete Log Entries parameter lets you specify whether logged information for messages should be deleted and if so for which messages The default is the single value NO which indicates that logged information for messages should not be deleted Alternatively specify a value for the following parameter elements CoolSpools Email User Guide V6R1 Page 71 www ariadnesoftware co uk Delete message log entries YES Information logged for emails when SNDCMNMSG LOG YES was specified will be considered for deletion Delete if older than days 365 Log information over 365 days old will be eligible for deletion Nbr_of_days Specify the minimum number of days ago that the message must have been logged for the information to be eligible for deletion Reorganize physical files NO CoolSpools Email will not attempt to reorganize the log files YES CoolSpools Email will attempt to reorganize the log files Working with Email Address Lists Option 10 from the CoolSpools Email menu runs the WRKADRL Work with Address Lists command which allows you to create and manage address lists Email address lists provide a means of grouping email addresses so that you can conveniently send messages to groups of people e g departments customers who have bought a particula
55. ees 30 Report non delivery to msgq DSNMSGQ AAA 30 Report non delivery to email DGNEMAIL 31 Autostart in subsystem SBSD iissisesccccecetcccsdsee cca ceteneidienisded aiiecesereonisdceianandies 32 E EE 33 Submit to job queue JOBQ ssssssnesesnnrsertrtrsettttrnettttnttettnnnneernnnnernnn nnee e nnne 33 First level retries LN UE 34 Second level retries d WEEK eebe bere 35 Third level retries LVL 2RETRY aa 35 Host name HOSTNAMB eee cece eeeeeeeeee cere eee eeeeeeeeaaeeeeeeeeeeeeeeeeeaeeeeeeeeeeeeeeees 36 Domain name UMNNAME AEN 36 Mail server name or IP address MAILSERVER ssssssssssseseessesssessrrrrnrnnssssrenne 36 Server authentication GVRAUTTH 37 le lebt ee EE 39 Managing the CoolSpools SMTP servers sssssssssseeneeesseeserrrrrreeserrrnnrnnnenseerrnne 40 STRSMTPSVR Start SMTP Server commande 40 Number of server jobs to start NDRIOBG 41 Start retry server if inactive DIV 41 ENDSMTPSVR End SMTP Server Commande 41 WRKSMTPMSG Work with SMTP Messages commande 42 Option OPTION EE 42 Using CoolSpools Email iccci niciaca aa evasauauacavaawaauaauana ies 44 The CoolSpools Email Menu WEE 44 SNDCMNMSG commande 45 EMAILID Email id to E 45 TO Recipe EE 45 EROMAS eNd E 47 REPLYTO Send replies fo 50 SUBJECT le EEN 50 MSG Message TEN EE 51 ATTACH Attachments E 53 MSGSTMF Stream file containing message cccceeeeeeeeeeeeeteeeeeeeeeeeeeeeees 56 PRIORITY Priority EE EE 57
56. efault No previously saved email message is retrieved Email_id The identifier of the previously saved email to be retrieved as the basis for the new message If the email that is to be retrieved was encrypted when it was saved you must supply the encryption password on the second element Encryption password TO Recipient s The TO Recipients parameter allows you to specify the email addresses to which the email message should be sent You can define up to 32 recipients for the message on this command parameter If you need to send the same email address to more than 32 recipients simultaneously you can do this by defining an address list and specifying the address list name on this parameter CoolSpools Email User Guide V6R1 Page 45 www ariadnesoftware co uk The default is the single value SELECT CoolSpools Email will prompt you to enter the email address es to which the message should be sent or select the address es from an email address directory There are 3 elements to this parameter Email address Name and Type Email address This is where you enter the email address to which the message is to be sent Note that while CoolSpools Email will check that the email address that you enter conforms to the rules for valid email addresses it is not possible to validate that the email address that you enter is correct or that the message will be deliverable For example sales ariadnesoftware co uk is not a valid
57. email address since it does not contain an sign and Coo Spools Email will reject it However sales ariadnesoftware org uk is a valid email address and Coo Spools Email will allow it but it is not ariadne s correct email address it should be sales ariadnesoftware co uk and the message will not be received Name If you would like your email message to display the recipient s name rather than the email address when it is delivered enter the name here The default value is NONE i e no name is provided and the email address will appear as the recipient instead For example if you specify SNDCMNMSG TO Sales ariadnesoftware co uk NONE when the message is received the To attribute will be shown as To Sales ariadnesoftware co uk However if you specify SNDCMNMSG TO Sales ariadnesoftware co uk ariadne Sales when the message is received the To attribute will be shown as To ariadne Sales Options are CoolSpools Email User Guide V6R1 Page 46 www ariadnesoftware co uk NONE Default No name is specified ADRL Address list If you wish to send to an address list this is the value that must be entered Name Specify the name of the recipient Type Specify the type of recipient here Options are PRI Default Primary recipient CC Carbon copy recipient An CC recipient receives a copy of the message and is identified to the primary recipient but is not the primary recipient BCC Blind
58. extend the trial period If you require additional temporary license keys to assist with testing CoolSpools Email V6R1Mo0 or if you run into any problems during your testing please do not hesitate to contact us at support ariadnesoftware co uk Warning Disclaimer We recommend strongly that all production applications are re tested thoroughly using the new version in your development environment before you switch over to running the new version in your production environment All CoolSpools versions are packaged as separate licensed programs and install into different libraries This means that all versions of CoolSpools can coexist and run alongside one another on the same machine You can switch an application from using one version to using another simply by changing the library list of the job to include the appropriate version library or by specifying a different library name when you run the command Hence it is quite a simple matter to test your applications using the new version while continuing to run the older version in production Please note that while ariadne makes every effort to ensure that CoolSpools functions in the same way with the same parameters from one version to the next it is not possible to guarantee this This is why you should re test your applications against a new version before going live with it as it is possible that in some cases different parameter settings will be necessary to obtain the same results as bef
59. g added to the directory relates to as it should appear when an email sent to that person is delivered The default is GEN which means that CoolSpools Email should generate a name from the FIRSTNAME and LASTNAME parameters Example Adding an entry to the Sales Department address directory ADDADRDIRE ADRDIR SALES EMAIL Joe Bloggs ariadnesoftware co uk FIRSTNAME Joe LASTNAME Bloggs COMPANY ariadne software Itd POSITION Programmer CoolSpools Email User Guide V6R1 Page 99 www ariadnesoftware co uk Changing an address directory entry The CHGADRDIRE Change Address Directory Entry command allows you to change an address directory entry Command parameters are as follows ADRDIR The ADRDIR Address directory parameter identifies the address directory in which the entry you wish to change can be found EMAIL The EMAIL Email address parameter identifies the address directory entry you wish to change See the ADDADRDIRE command above for details of the use of the other parameters CoolSpools Email User Guide V6R1 Page 100 www ariadnesoftware co uk Copying address directory entries The CPYADRDIRE Copy Address Directory Entries command allows you to copy the contents of an existing address directory to another address directory Command parameters are as follows FROMADRDIR The FROMADRDIR From address directory identifies the address directory whose contents you wish
60. g problems with large attachments getting corrupted this is almost certainly the solution CoolSpools Email User Guide V6R1 Page 18 www ariadnesoftware co uk Address Lists CoolSpools Email implements the concept of a named Email Address List Address lists can be extremely useful when you need to send messages to groups of people ona regular basis For example you might create an address list for each department within your organization e g SALES MARKETING IT etc Then when you need to send a message to everyone in the Sales Dept you just specify the SALES address list as a recipient for the message CoolSpools Email provides a set of tools for creating and managing address lists and their contents CoolSpools Email User Guide V6R1 Page 19 www ariadnesoftware co uk Address Directories CoolSpools Email also implements the concept of a named Email Address Directory Address directories store frequently used email addresses You can search them and select email addresses from them when you specify TO SELECT on the SNDCMNMSG command Different directories can be used to keep email addresses relevant to different users or groups of users separate from one another for ease of searching and selection For example you might create an address directory for each department within your organization e g SALES MARKETING IT etc Then when a member of the Sales Department needs to select an email address s he can simply look
61. gle place where you can e track what has happened to the emails you have sent in terms of their current status and diagnostic information about any errors that occurred e resolve issues such as invalid email address and trigger re sending of the email or create new emails based on old ones It is available as option 21 23 of the SMTPEMAIL menu 21 Work with CoolSpools SMTP emails unprocessed 22 Work with CoolSpools SMTP emails in error 23 Work with CoolSpools SMTP emails all statuses Restrictions e Unless you are a system administrator you can only work with emails that you sent In order to be considered a system administrator you must either gt Have SECADM special authority or gt Be authorized to registered function ARIADNE_SYS_ADMIN Use the CHGFCNUSG or WRKREGFNC commands to manage authority to registered functions e System administrators are permitted to view and work with e g re send emails sent by any user Option OPTION Specifies the status that messages must have to be displayed Options are CoolSpools Email User Guide V6R1 Page 42 www ariadnesoftware co uk UNPRC ERROR ALL Displays unprocessed messages The list will include all messages that could not be delivered due to an error as well as those for which delivery has not yet been attempted and which are waiting to be processed Displays messages in error The list will include just those messages for which deli
62. he CoolSpools suite enabling CoolSpools Spool Converter to email spooled files as PDFs XML etc and CoolSpools Database to email database and query output as Excel spreadsheets CSVs etc CoolSpools Email User Guide V6R1 Page 10 www ariadnesoftware co uk Why Choose CoolSpools Email There are many PC packages which enable you to send email There are also packages that let you to send email from your IBM System i using a GUI So why choose CoolSpools Email CoolSpools Email provides a means of sending email from an IBM System i command That may not be as pretty as a GUI but it s a darn sight easier to integrate with your existing applications Just think about it How is a GUI going to help you convert your billing application to let you send invoices out to customers by email With CoolSpools Spool Converter and CoolSpools Email it can take little more than adding a few command calls to your CL program to convert your invoice spooled files to PDF format and email them To take another example what if you want to email your internal users their sales report in Excel format each morning rather than printing it and distributing it on paper A GUI is not much help there With CoolSpools Database and CoolSpools Email you can run your query and save the output as an Excel file rather than a spooled file and then email the file as an attachment all with a couple of simple program changes to call the appropriate commands One final
63. he home directory of the user running the command PRDDIR The email is saved in the product directory CoolSpools Email di_name Specify the name of the directory where the email should be saved LOG Logging options The LOG Logging options parameter specifies whether the message should be logged in the CoolSpools Email log file There is a single value option NO which indicates that the message will not be logged Alternatively specify a value for the following parameter elements Log message YES The message will be logged in the CoolSpools Email log files Encrypt information NO The logged information is not encrypted YES The logged information is encrypted A password must be entered on the PWD parameter PWD Encryption password The PWD Encryption password parameter lets you supply a password which is used to encrypt saved emails and logged information when encryption is requested for those items Saved emails and logged information is encrypted using the MD5 hash algorithm and the RC4 encryption algorithm with the password as the key There is a single value option NONE which indicates that no password will be supplied This value is invalid if encryption has been requested CoolSpools Email User Guide V6R1 Page 61 www ariadnesoftware co uk The password is case sensitive If you wish to retrieve a message using SNDCMNMSG and the EMAILID parameter or if you wish to resend a message with RSNCM
64. ined when the API is employed is 4 096 bytes as opposed to 512 bytes when SNDCMNMSG is used When CoolSpools Email is installed a source file call CM_SRCEFILE is included in library COOLSPV6R1 or COOLSPV5R2 if you have installed CoolSpools Plus This contains two members 1 An ILE RPG copybook called CM_SNDAPIP which contains the definitions you need to call the CM_SNDAPIR API 2 A program called EXAMPLE which gives an example of how to call the API There are two possible forms in which parameters can be passed CoolSpools Email Send Email Message CM_SNDAPIR API Parameter List 1 see source file CM_SRCFILE member CM_SNDAPIP prototype definition CM_SndMsg Required Parameter Group 1 Format of sender structure Input CHAR 8 2 Sender Input CHAR 3 Number of recipients Input BINARY 4 4 Format of recipient structures Input CHAR 8 5 Recipient structures Input Array 1 32 of CHAR 6 Subject Input VARCHAR 256 7 Format of message structure Input CHAR 8 CoolSpools Email User Guide V6R1 Page 115 www ariadnesoftware co uk 8 Message structure Input CHAR 9 Number of attachments Input BINARY 4 10 Format of attachment structure Input CHAR 8 11 Attachment structures Input Array 1 32 of CHAR 12 Priority Input CHAR 1 13 Confirm delivery Input CHAR 1 14 Email message identifier Output CHAR 30 15 Error Code UC CHAR Optional Parameter Group 1 16 Send multiple messages Input CHAR 1 Optional P
65. it up in the departmental directory CoolSpools Email provides a set of tools for creating and managing address directories and their contents CoolSpools Email User Guide V6R1 Page 20 www ariadnesoftware co uk Installation Refer to the Installation Guide for instructions CoolSpools Email User Guide V6R1 Page 21 www ariadnesoftware co uk Maintenance Refer to the Maintenance Guide for instructions CoolSpools Email User Guide V6R1 Page 22 www ariadnesoftware co uk Setup CoolSpools Email provides a means of creating email messages in MIME Multipurpose Internet Mail Extensions format on the AS 400 iSeries or IBM System i There is some setup work which must be carried out in order for these emails to be delivered successfully How CoolSpools Email works If you have fix pack 122 or later installed CoolSpools Email offers two ways of sending emails from your system If you do not yet have fix pack 122 you will only be able to use the first of these methods 1 Mail Server Framework MSF The original release of CoolSpools V6 Email as well as the earlier Communiqu product used the IBM QtmmSendMail API to create emails QtmmSendMail sends email via two IBM provided services for processing i Mail Server Framework MSF ii IBM s Simple Mail Transport Protocol SMTP servers For email sent this way to work both these services need to be configured and active There is a section on configuring and ma
66. ity When the message arrives the client email software will mark it as low priority CLASS When the SNDCMNMSG command is prompted using F4 the CLASS Class parameter only appears if you then also press F10 to display additional parameters The access classification for the calendar event Implementation of the feature will vary from one receiving software program to another Options are PUBLIC Default The item is marked as publicly viewable PRIVATE The item is marked as private CONFIDENTIAL The item is marked as confidential CATEGORIES When the SNDCMNMSG command is prompted using F4 the CATEGORIES Categories parameter only appears if you then also press F10 to display additional parameters Free format text defining categories to which the item should be assigned Separate each category with a comma CoolSpools Email User Guide V6R1 Page 109 www ariadnesoftware co uk Implementation of the feature will vary from one receiving software program to another CoolSpools Email User Guide V6R1 Page 110 www ariadnesoftware co uk SNDCMNVCAL command Option 32 Send calendar item vCalendar format prompts the SNDCMNIVAL Send vCalendar Item command which allows you to send a calendar item in vCalendar format Calendar items sent using SNDCMNVCAL can be received by email client software which supports the vCalendar format such as Outlook but NOT Outlook Express Outlook will display items sent by SNDCMNVCAL as
67. meter Group TEE 123 Optional Parameter Group EE 123 Optional Parameter Group 3 123 Optional Parameter Group 4 EE 124 Optional Parameter Group 5 teste 124 Optional Parameter Group E EE 125 Optional Parameter Group 7 cccccceeeeeeeeeeeeceeeeeeeeeeeeeeeeaeeeeeeeeeeeeeeeennneeeeeeees 126 Optional Parameter Group 8 127 Optional Parameter Group 9 EE 127 Optional Parameter Group 10 128 Required Parameter E 133 The CoolSpools Email Database cc cccceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeenneeeeeeeeeeeeeee 134 Message Log CM_MSGLOG E 134 Message Recipients CM MGGbRCh Message Attachments CM MSCGATC Environment variables Introduction CoolSpools Email formerly called Communiqu provides IBM System i users and applications with easy to use but fully functioned facilities for sending email messages in MIME format With CoolSpools Email you can send email to Internet email users as well as email users on the same IBM System i or another IBM System i send email messages in simple text or HTML or alternative text HTML formats attach or embed text HTML image video audio or application binary files for example PDF files and Excel spreadsheets use a simple command interface or an API create and manage named email address lists send to multiple email addresses or to named email address lists convert SNADS distribution lists to email address lists CoolSpools Email also dovetails with the rest of t
68. more user friendly interface for creating email messages There are no command parameters The user is presented with the following screen CoolSpools Email Create Email Message ARIADNE1 From Email addr support ARIADNESOFTWARE CO UK Name ariadne software To 1 Email addr Name er TYPES ie s p x PRI 2 Email addi s ame Type s i a PRI More Subject ae e e e SSS SS SS eS Se SS Site MSS SBC Ce i ete itr et Ste titi More F3 Exit F5 Refresh F6 Insert F8 Select F10 Send Fll Screen 2 F12 Cancel F14 Delete lin The various areas of the screen are From Defines the email address and name of the sender By default the current user s email address details are retrieved from the system distribution directory To A scrolling area allowing the email address es and name s of the recipient s of the email to be entered as well as a code indicating whether the recipient is a primary recipient a cc recipient or CoolSpools Email User Guide V6R1 Page 66 www ariadnesoftware co uk Subject Message Available command keys are F3 Exit F5 Refresh F6 Insert F8 Select F10 Send F11 Screen 2 F12 Cancel F14 Delete line a bcc recipient The subject line of the email A scrolling area allowing the text of the message to be input Enter the special value STMF to indicate that the text of the message will be supplied in a stream file specified on the second
69. mpt this command or do GO COOLSPV6R1 EMAIL to display the Email menu and take option 42 Manage CoolSpools email sent CoolSpools SMTP The CFGSMTPSVR command is described in detail below Most users will need to change no more than one or two parameters from the defaults supplied and this step only needs to be carried out once unless there is a need to adjust the configuration subsequently CoolSpools Email User Guide V6R1 Page 26 www ariadnesoftware co uk CFGSMTPSVR Configure SMTP Server command This command configures the CoolSpools SMTP Server jobs which manage the process of sending emails when the SMTP method is selected See above It is available as option 1 of the SMTPEMAIL menu Restrictions e You must have SECADM and IOSYSCFG special authority to run this command e You must have CHANGE authority to the objects referenced e g the subsystem job queue and user profile specified as well as to the CoolSpools SMTP Server and Retry Server job descriptions objects CM_SNDSVRR and CM_RTYSVRR JOBD in library COOLSPV6R 1 Command parameters are as follows Autostart servers AUTOSTART Specifies whether the CoolSpools SMTP server jobs should start automatically or not Emails sent using the CoolSpools SMTP method will not be processed unless the CoolSpools SMTP server jobs are started If you intend to use this method to deliver emails it is therefore recommended that you specify AUTOSTART YES If you spe
70. n converting distribution list entries to email addresses Options are SYS Default The currently defined local domain name as specified by the CHGTCPDMN Change TCP IP Domain command is retrieved and used Domain name Enter a valid TCP IP domain name of your own choosing Example Converting the old SNADS Sales Department distribution list to an address list CVTDSTADRL DSTL ARIADNE SALES ADRL DSTL HOSTNAME SYS DOMAIN SYS CoolSpools Email retrieves the contents of the SNADS distribution list and creates a new address list using the value of the ADRL parameter For each entry in the address list Coo Spoo ls Email then looks at the System Distribution Directory for the user concerned and constructs an email address according to the following rules CoolSpools Email User Guide V6R1 Page 80 www ariadnesoftware co uk 1 If the Preferred Address type is set to SMTP and an SMTP user id and SMTP domain are defined for the user the email address will be in the form SMTPUserld SMTPDomain 2 If the Preferred Address type is set to USRID the two parts of the user id are concatenated with an intervening period and these are added to the specified host and domain names to form the email address e g Usrld1 Usrld2 hostname domainname 3 If neither of the above rules can be used the user profile will be added to the host name and domain name specified to give an email address in the form U
71. naging MSF and the IBM SMTP servers below which links to a document which also includes some tips on how to obtain diagnostic information and trace problems Option 41 from the EMAIL menu Manage CoolSpools email sent via IBM s MSF provides access to a number of functions for setting up and managing this method of delivering emails You can also access that menu by entering the command GO COOLSPV6R1 MSFEMAIL While this is the method of sending emails that many customers have used very successfully for years this method of sending emails from the system i has a number of drawbacks which IBM seems disinclined to address a It can be complex to set up and manage b Diagnostic and logging information can be hard to obtain and interpret CoolSpools Email User Guide V6R1 Page 23 www ariadnesoftware co uk c Tracing an email from the point at which it is created through to the point at which it is hopefully delivered or Sometimes rejected can be tough or even impossible In consequence starting with fix pack 122 CoolSpools Email now also fully supports an alternative method of sending emails from your system i and we have made it very easy to switch over to this alternative method without having to alter your applications in any way 2 CoolSpools SMTP The new CoolSpools SMTP method doesn t use either of the IBM services described above to send emails Instead it uses CoolSpools own implementation of the Simple Mail Trans
72. natively specify STMF for the message text and provide the name of a stream file on the MSGSTMF parameter CoolSpools Email will take the text of the message from the stream file specified Message format This is where you specify the format in which the message is sent Options are BOTH Default The message is sent in alternative plain text HTML format This means that two copies of the message text will be sent a plain text copy and an HTML copy If the email client software used to receive the message can handle HTML messages the HTML copy will be used otherwise the plain text copy will be used TEXT The message is sent in plain text format The only HTML control which is interpreted is lt br gt which CoolSpools Email will convert to a hard line break HTML The message is sent in HTML format You can include HTML formatting e g lt b gt lt b gt or lt u gt lt u gt to control bold text and underlining Coo Spools Email will take the text that you enter and wrap it with some basic HTML header and footer controls lt HTML gt lt HEAD gt lt BODY gt These controls should not therefore be included in the text of the message Example SNDCMNMSG MSG Here s a message lt br gt with lt br gt line lt br gt breaks TEXT When this message is received it will show as Here s a message with line CoolSpools Email User Guide V6R1 Page 52 www ariadnesoftware co uk breaks Example SNDCMNMSG
73. nize encoding of msg parts Determines what action CoolSpools Email takes if it detects a situation where the different parts of a multipart email have different encodings for example where the value specified for the character set above is UTF 8 but an embedded HTML attachment has a CCSID of 1252 Windows This situation is not well handled by some popular email client systems e g Windows Mail which will probably display the embedded HTML assuming the character set of the message part despite the inline attachment having its own character set declaration Windows Turkish CCSID 1254 Windows Hebrew CCSID 1255 Windows Arabic CCSID 1256 Windows Baltic CCSID 1257 Windows Viet CCSID 1258 ISO Latin 1 CCSID 819 ISO Latin 2 CCSID 912 ISO Cyrillic CCSID 915 ISO Arabic CCSID 1089 ISO Greek CCSID 813 ISO Hebrew CCSID 916 ISO Turkish CCSID 923 Options are WARN A warning message is issued to alert the user to the situation YES CoolSpools changes the encoding of embedded attachments to match that of the message part NO No action is taken CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Page 63 OPTIONS Miscellaneous options Specifies miscellaneous options for the command Single values NONE No miscellaneous options are specified Other values up to 100 repetitions Option key Options are DIAGNOSTIC lt var_name gt Option value Options are character v
74. ntifies the attachment as XML identifies the attachment as an image identifies the attachment as a video file identifies the attachment as an audio file Page 107 Code page This element allows you to identify the code page of the data in the attachment file This value is used if the content type is indicated as TEXT or HTML to convert the data to ASCII format so it can be displayed by the client email software Options are STMF Default The code page attribute of the file in the IFS is used 1 65534 The code page to use Attachment name in email This element allows you to specify the name of the attachment as it should appear in the email Options are FILE Default The name of the attachment is the same as that of the file being attached Attachment_name The name to give the attachment in the email CoolSpools Email User Guide V6R1 Page 108 www ariadnesoftware co uk PRIORITY When the SNDCMNMSG command is prompted using F4 the PRIORITY Priority parameter only appears if you then also press F10 to display additional parameters Implementation of the feature will vary from one receiving software program to another Options are NORMAL Default The message is sent specifying normal priority When the message arrives the client email software will not mark it as high or low priority HIGH High priority When the message arrives the client email software will mark it as high priority LOW Low prior
75. nts you wish to copy TOADRL The TOADRL To address list identifies the address list to which you wish to copy the address list entries Example Copy the contents of the Sales Department address list to a new combined Sales and Marketing list CPYADRLE FROMADRL SALES TOADRL SALES_AND_MARKETING Removing an address list entry The RMVADRLE Remove Address List Entry command allows you to remove an entry from an address list Command parameters are as follows ADRL The ADRL Address list parameter identifies the address list in which the entry you wish to remove can be found CoolSpools Email User Guide V6R1 Page 87 www ariadnesoftware co uk EMAIL The EMAIL Email address parameter identifies the address list entry you wish to remove Example Removing Joe Bloggs from the Sales Department address list RMVADRLE ADRL SALES EMAIL Joe Bloggs ariadnesoftware co uk CoolSpools Email User Guide V6R1 Page 88 www ariadnesoftware co uk Working with Email Address Directories Option 20 from the CoolSpools Email menu runs the WRKADRDIR Work with Email Address Directories command which allows you to create and manage email address directories Email address directories provide a means of storing the email addresses of people to whom you might wish to send emails Coo Spools Email allows you to search and select email addresses from email address directories when you specify TO SELECT on the
76. olSpools Email to use Mail Server Framework See the Email Setup guide http www ariadnesoftware co uk docs EmailSetup pdf For further information on how to set up your IBM System i for email consult the following IBM links http publib boulder iobm com infocenter iseries v7r1 mO topic rzair rzairconfigem htm http www 912 iobm com s_dir SLKBase nsf Sff1161e61e6c7468625661300765a3f 3487 9f5e413aa5cd8625697b0053f36a Configuring CoolSpools Email to use CoolSpools SMTP Before selecting CoolSpools SMTP as the method to be used to deliver your emails see above you will need to do a small amount of simple setup work so CoolSpools SMTP knows how to run on your system By default emails sent via the SMTP method are processed asynchronously by a number of server jobs that run in batch mode In other words when you run the SNDCMNMSG command or one of the CVTSPLxxx or CVTDBFxxx commands those commands just pass the email to the CoolSpools SMTP server jobs for sending and the actual process of sending the email is done independently This has several advantages e The sending job doesn t block while the email is being delivered to the target email server e lf there s a problem sending the email e g a communications outage or the target email server being down temporarily CoolSpools SMTP can automatically retry sending the email later To set up these CoolSpools SMTP server jobs run CFGSMTPSVR Configure SMTP Server to pro
77. ools Email User Guide V6R1 Page 106 www ariadnesoftware co uk FILE BINARY TEXT HTML CSV PDF XML IMAGE VIDEO AUDIO CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Default The content type will be inferred from the extension part of the file name You can control which file extensions are identified as which content types by listing file extensions in the second level text of CoolSpools Database messages CMQ5000 CMQ5004 Each file extension must be 1 5 characters long padded with trailing blanks if less than 5 characters long For example message CMQ5001 controls which file extensions identify image files This message is supplied with the value JPG JPEG GIF BMP PNG TIF TIFF You may change the text of this message to add or remove extensions so long as you ensure that each extension is exactly 5 characters long including any trailing blanks and remembering that installing PTFs or a new release will overwrite your changes Any file extension not listed in one of these messages will be treated as application binary data Application binary This is the default MIME content type used for data types other than those which have distinct content types of their own image audio video etc Identifies the attachment as plain ASCII text Identifies the attachment as HTML identifies the attachment as a CSV or other delimited text file identifies the attachment as a PDF ide
78. ore ariadne software accepts no responsibility for any damage expense or loss of income incurred as a result of unforeseen and unwanted effects resulting from installing new versions of its software or applying PTFs CoolSpools Email User Guide V6R1 Page 14 www ariadnesoftware co uk Minimum OS 400 Release Level The minimum OS 400 release level required to run V6R1MO of CoolSpools Spool Converter is OS 400 V5R3M0 If you are running OS 400 V5R2M0 or an earlier version of OS400 you will not be able to install V6R1MO of CoolSpools Email Product Library All product options of CoolSpools V6R1M0 install into the single product library COOLSPV6R1 This means that you no longer have to manage multiple product libraries for the separate modules that made up CoolSpools PLUS V5R1MO0 CoolSpools Database Communiqu CoolSpools etc You will probably need to change library lists in job descriptions and other system objects in order to pick up the new version of the code rather than the old This change of library name has the advantage that it allows you to run both V6R1M0 and the earlier versions on the same machine You are therefore able to test V6R1MO before swapping your production applications over to the new version as we strongly advise you to do Memo to Users Please refer to the Memo to Users for important information about changes you need to take account of before migrating to CoolSpools Email from an earlier version of
79. ory The path to a stream file containing the message to be sent You must enter STMF in the message text area of the first screen to use this facility A scrolling area allowing you to enter the path to one or more files to be attached to the email the method of attachment the type of file contents and the codepage See the ATTACH parameter of the SNDCMNMSG command for details Exit the application Reset the screen Send the message Show the first screen again Return to the previous screen Page 69 RSNCMNMSG command Option 4 from the CoolSpools Email menu Resend email message prompts the RSNCMNMSG Resend CoolSpools Email Message command which allows you to resend a previously saved email message The difference between CoolSpools Email menu option 3 Retrieve email message and 4 Resend email message is that option 3 uses a previously logged email message as the basis for creating a new email message If you use option 3 equivalent to SNDCMNMSG with an email identifier specified on the EMAILID parameter before sending the new message you can change details the message text recipients etc the message will be sent with a new email identifier and any files specified as attachments will be re imported before the message is created so that the current version of those attachments will be sent On the other hand using option 4 equivalent to the RSNCMNMSG command the original message is resent exactly a
80. ory This must be a valid i e well formed email address and must be unique within the address directory FIRSTNAME The FIRSTNAME First Name parameter enables you to enter the first name of the person the email address relates to LASTNAME The LASTNAME Last Name parameter enables you to enter the last name of the person the email address relates to PREFIX The PREFIX Prefix parameter enables you to enter any part of the name of the person the email address relates to that should precede the first name such as a title e g Mrs Dr Professor etc MIDDLENAME The MIDDLENAME Middle name or initials parameter enables you to enter a middle name or set of initials for the person the email address relates to SUFFIX The SUFFIX Suffix parameter enables you to enter any part of the name of the person the email address relates to that should follow the last name e g PhD Esq etc CoolSpools Email User Guide V6R1 Page 98 www ariadnesoftware co uk COMPANY The COMPANY Company or organization parameter enables you to enter the name of the company or organization to which the person the email address relates to belongs POSITION The POSITION Position or job title parameter enables you to enter the position job title or other role of the person the email address relates to in the company or organization EMAILNAME The EMAILNAME Email Name parameter defines the name of the person the email address bein
81. ou to change an address list entry Command parameters are as follows ADRL The ADRL Address list parameter identifies the address list in which the entry you wish to change can be found EMAIL The EMAIL Email address parameter identifies the address list entry you wish to change NAME The NAME Name parameter enables you to enter the name of the person or organization the email address relates to TYPE The TYPE Type parameter defines the manner in which messages are sent to the email address being added to the list when the address list is used Options are PRI Default Primary recipient CC Carbon copy recipient An CC recipient receives a copy of the message and is identified to the primary recipient but is not the primary recipient BCC Blind carbon copy recipient An BCC recipient receives a copy of the message but is not identified to the primary recipient or CC recipients Example Changing an entry in the Sales Department address list CHGADRLE CoolSpools Email User Guide V6R1 Page 86 www ariadnesoftware co uk ADRL SALES EMAIL Joe Bloggs ariadnesoftware co uk NAME Joseph Bloggs TYPE CC Copying address list entries The CPYADRLE Copy Address List Entries command allows you to copy the contents of an existing address list to another address list Command parameters are as follows FROMADRL The FROMADRL From address list identifies the address list whose conte
82. oup 1 Format of Sender Structure INPUT CHAR 1 When sending an email to more than one recipient whether a single message should be sent to a list of recipients or multiple messages generated one per recipient N The default No A single message is generated with a list of recipients Y Yes Multiple messages one per recipient are generated Optional Parameter Group 2 Number of messages created OUTPUT BINARY 4 The number of messages created by CoolSpools Email in response to the request Optional Parameter Group 3 Size of email id buffer INPUT BINARY 4 CoolSpools Email User Guide V6R1 Page 123 www ariadnesoftware co uk The size in bytes of the buffer specified on the following parameter Email id buffer OUTPUT CHAR A buffer into which CoolSpools Email will place an array of CHAR 30 email identifiers in order to provide the caller with a list of the ids of the email messages generated Optional Parameter Group 4 Name of stream file containing message text INPUT VARCHAR 512 If the message text specified for the message structure is STMF CoolSpools Email will read the message text from the file specified here There is no limit on the length of the data in the file which could be an ASCII text file an HTML file or a database member specify database files in IFS format i e QSYS LIB library_name LIB file_name FILE member_name MBR Dec Hex Type Field o o BINARY Length of the stream file path
83. page Alternative message stream file path Allows you to specify a different file that will supply the plain text version of the message If a value is specified for both path names on the MSGSTMF parameter the first path is interpreted as supplying the HTML version of a multipart alternative message and the second path is interpreted as supplying the plain text version A multipart alternative message with both HTML and plain text parts will be sent irrespective of the message type specified on the MSG parameter which is ignored Options are NONE path name Code page No alternative plain text version of the message is supplied If BOTH was specified for message type on the MSG parameter both parts of the multipart alternative message will be created from the file specified on the first element of the MSGSTMF parameter Text is converted to or from HTML as required Specify the path name of the file containing the plain text version of the message The codepage of the data in the stream file specified on the previous element Options are STMF 1 65534 PRIORITY Priority Options are NORMAL CoolSpools Email User Guide V6R1 www ariadnesoftware co uk The CCSID attribute of the stream file is used to determine the code page Specify the codepage Default The message is sent specifying normal priority When the message arrives the client email software will not mark it as high or low priority
84. pecified on the CFGSMTPSVR NBRSVR Number of initial servers option of the CoolSpools SMTP server attributes CFGSMTPSVR command is started 1 999 Specify the number of send server jobs to start Start retry server if inactive RTYSVR Specifies whether or not to start a retry server job if one is not currently active The retry server job manages the retrying of emails that could not be sent due to an error Options are YES A retry server job is started if one is not already active NO No retry server job is started ENDSMTPSVR End SMTP Server command The End CoolSpools SMTP Server ENDSMTPSVR command instructs the CoolSpools SMTP server jobs and the Retry Server to end A control message is placed on the data queue and will be detected as soon as the jobs have finished whatever work they are currently performing There could therefore be a slight delay before the jobs actually end It is available as option 12 of the SMTPEMAIL menu Restrictions e You must have JOBCTL special authority to run this command There are no parameters CoolSpools Email User Guide V6R1 Page 41 www ariadnesoftware co uk WRKSMTPMSG Work with SMTP Messages command The Work with SMTP Messages WRKSMTPMSG command lets you work with email messages sent via the CoolSpools SMTP server This option demonstrates some of the advantages of the CoolSpools SMTP method of sending emails over the Mail Server Framework method It provides a sin
85. ponse is requested Options are YES A response is requested NO No response is requested ATTACH The ATTACH Attachments parameter allows you to attach or embed up to 32 files to your email message There are 4 elements to this parameter File name This is where you enter the full path name of the file you wish to attach The path name must be entered in IFS format In other words documents stored in shared folders must be referenced in the QDLS file system and database file members must be referenced in the QSYS LIB file system Content type The content type tells CoolSpools Email and the receiving email software what type of data the attachment represents It is important that the content type is specified accurately as CoolSpools Email will process the attachment differently depending on the value you specify here For example if you specify the attachment type as TEXT or HTML it will be handled using a technique appropriate to textual data and may be converted from EBCDIC to ASCIl whereas any other content type will cause the attachment to be handled as binary data and sent unaltered Moreover the receiving software may not handle the attachment appropriately if the content type is specified incorrectly For example if you send a PDF file attachment but specify a content type of HTML the receiving email software may attempt to display the PDF file as HTML which will cause unwanted results Options are CoolSp
86. port Protocol SMTP to communicate directly with the target email system to deliver emails This has allowed us to address the issues described above namely a We think it s easier to set up and manage b We believe the diagnostic and logging information provided is much improved c We can now take charge of the entire process of sending an email from beginning to end and give you the ability to tell very easily whether a particular email has been successfully sent or not and if not why not Option 42 from the EMAIL menu Manage CoolSpools email sent via CoolSpools SMTP provides access to a number of functions for setting up and managing this method of delivering emails You can also access that menu by entering the command GO COOLSPV6R1 SMTPEMAIL Telling CoolSpools Email which method to use This is very simple Assuming fix pack 122 is installed there is a new option controlling the method which is used on the following commands e CoolSpools Email SNDCMNMSG gt METHOD parameter gt MSF or SMTP element e CoolSpools Spool Converter CVTSPLPDF CVTSPLTXT etc CoolSpools Email User Guide V6R1 Page 24 www ariadnesoftware co uk gt EMAIL OPT parameter gt MSF or SMTP element e CoolSpools Database CVTDBFXL CVTDBFTXT etc gt EMAILOPT parameter gt MSF or SMTP element In each case the default is ENVVAR which means that by default the system will use the method identified by an environment varia
87. r product etc Selecting option 10 or entering the WRKADRL command displays the address lists that have been defined so far Address list information is stored in file CM_ADRLST If you wish to ensure that only a restricted number of people can maintain address lists you should set the authorities on this file appropriately for example by associating an authorization list with it Work with Address Lists System YOURSYS Type options press Enter 1 Creat 2 Chang 3 Copy 4 Delete 5 Display 6 Print list entries 8 Work with list entries Opt Address List Text description CoolSpools Email User Guide V6R1 Page 72 www ariadnesoftware co uk FINANCE Finance Department LT I T Department MARKETING Marketing Department PRODUCTION Production Department SALES Sales Department Bottom F3 Exit F5 Refresh F12 Cancel F17 Position to Options that can be input against entries in the list are 1 Create 2 Change 3 Copy 4 Delete 5 Display 6 Print list entries 8 Work with list entries CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Select this option to create a new address list This option is available only on the first line of the display You can enter the name of the new address list in the space available if desired This is equivalent to running the CRTADRL Create Address List command Select this option to change the details of an existing address list This is equivalent
88. rameter List 2 see source file CM_SRCFILE member CM_SNDAPIP prototype definition CM_SndMsg2 This parameter list is identical to Parameter List 1 with the exception that it allows a larger number of recipients and attachments 1024 instead of 32 and some additional items to be defined e g save and logging options Required Parameter Group 1 Format of sender structure Input CHAR 8 2 Sender Input CHAR 3 Number of recipients Input BINARY 4 4 Format of recipient structures Input CHAR 8 5 Array of recipient structures Input CHAR 6 Subject Input VARCHAR 50 7 Format of message structure Input CHAR 8 8 Message structure Input CHAR 9 Number of attachments Input BINARY 4 10 Format of attachment structure Input CHAR 8 11 Array of attachment structures Input CHAR 12 Priority Input CHAR 1 13 Confirm delivery Input CHAR 1 14 Email message identifier Output CHAR 30 15 Error Code UC CHAR Optional Parameter Group 1 16 Send multiple messages Input CHAR 1 Optional Parameter Group 2 CoolSpools Email User Guide Ven Page 131 www ariadnesoftware co uk 17 Number of messages created Output BINARY 4 Optional Parameter Group 3 18 Size of email id buffer next parameter Input BINARY 4 19 Email id buffer Output CHAR Optional Parameter Group 4 20 Stream file containing message text Input VARCHAR 512 Optional Parameter Group 5 21 Number of email addresses for confirmation Input BIN ARY 4 mess
89. rvers and emails are to be routed via a mail server or router specify the name or IP address of that mail server or router here You must ensure that the mail server or router has been configured to allow emails from the local system to be relayed through it Where a mail server name is specified you must ensure that the local system can translate that name into an IP address either by means of a Domain Name Server DNS server or a local host table entry CFGTCP option 10 Options are SAME No change is made to the existing setting NONE No mail server or router is to be used Emails will be delivered by communicating directly with the target email server name Specify the name or IP address of the mail server or router Server authentication SVRAUTH Specifies the authentication method to be used when communicating when the mail server Note about the use of TLS Transport Layer Security Some of the authentication methods listed below those with names starting TLS require the use of Transport Layer Security TLS The use of TLS to encrypt the interactions between the sending system and receiving system significantly improves the security of your communications However please note the following prerequisites for using TLS e The mail server must support the STARTTLS verb Contact the administrator of your mail server to verify this e Your system must have a valid SSL certificate associated with the CoolSpools S
90. s it was saved when first created The recipient list will be the same as will the message text Importantly any attachments will be sent in the form in which they existed at the time the message was created not in the current form Command parameters are as follows EMAILID The EMAILD Email id to resend parameter allows you to specify the identifier of a previously saved email to be resent in its original form If the email that is to be resent was encrypted when it was saved you must supply the encryption password on the second element Encryption password CoolSpools Email User Guide V6R1 Page 70 www ariadnesoftware co uk DLTCMNMSG command The DLTCMNMSG Delete CoolSpools Email Messages command provides a purge facility for saved emails and logged email information Command parameters are as follows DLTSAVMSG The DLTSAVMSG Delete Saved Messages parameter lets you specify whether saved messages should be deleted and if so which messages The default is the single value NO which indicates that saved messages should not be deleted Alternatively specify a value for the following parameter elements Delete saved messages YES Emails saved when SNDCMNMSG SAVE YES was specified will be considered for deletion Delete if older than days MSG Emails will be considered for deletion based on the number of days that was specified on the SAVE parameter of the SNDCMNMSG command when the email was cr
91. sage identifier which is displayed in the completion message sent by the SNDCMNMSG command CoolSpools Email message XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX sent successfully and returned by the CM_SNDAPIR API Each log record also contains details e when the message was sent e by which job it was sent e by which user it was sent e sender email address e sender name e subject e message text e message type e priority e confirm delivery option Message Recipients CM_MSGRCP Message Recipients file CM_MSGRCP logs recipients for each email message that is sent Each record is identified by the email identifier which is also the key to CM_MSGLOG Each record also contains CoolSpools Email User Guide V6R1 Page 134 www ariadnesoftware co uk e recipient email address e recipient name e recipient type Message Attachments CM_MSGATC Message Attachments file CM_MSGATC logs attachments for each email message that is sent Each record is identified by the email identifier which is also the key to CM_MSGLOG Each record also contains e attachment file name e attachment method e attachment content type e attachment code page CoolSpools Email User Guide V6R1 Page 135 www ariadnesoftware co uk Environment variables CoolSpools Email uses a number of environment variables that can be set to control various aspects of its processing such as setting user definable defaults for certain parameters The concept of en
92. sage priority N Normal H High or L Low Whether confirmation of delivery is requested N No Y Yes When sending to more than one recipient whether a separate message is sent to each recipient or a single message to a list of recipients N No Y Yes The encryption password to be used for encrypting logged and saved message information N B CoolSpools Email does not currently provide support for encrypted messages This password simply relates to the encryption of information stored in the message log and saved messages Whether details of the message are recorded in the CoolSpools Email message log N No Y Yes Whether the message text is encrypted in the message log N No Y Yes Whether the entire message is saved in its final form so it can be re sent at a later time N No Y Yes Whether the saved message is saved in an encrypted form N No Y Yes Page 68 Save compressed Retention period Save in directory Message stream file Attachments Available command keys are F3 Exit F5 Refresh F10 Send F11 Screen 1 F12 Cancel CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Whether the saved message is saved ina compressed form N No Y Yes A number of days after which the saved message is eligible for deletion This value is used by DLTCMNMSG when you specify DLTSAVMSG YES MSG The path to the directory in which the email message will be saved CURDIR current direct
93. se options were described above In the following sections we will explore the various other options available from this menu CoolSpools Email User Guide V6R1 Page 44 www ariadnesoftware co uk SNDCMNMSG command Option 1 Send email message and option 3 Retrieve email message from the CoolSpools Email menu prompt the SNDCMNMSG Send CoolSpools Email Message command which allows you to send an email message The same functionality is available from option 2 the CRTCMNMSG Create CoolSpools Email Message command and the Coo Spools Email Send Message API Application Program Interface which are described in a later section of this document CRTCMNMSG provides a more user friendly interface for creating email messages The difference between options 1 and 3 is that option 2 supplies the default value for the EMAILID parameter EMAILID NEW and prevents this parameter from being changed This is more convenient if you are sure you just want to create a brand new email Option 3 on the other hand allows you to input the identifier of a previously saved email message on the EMAILID parameter in order to retrieve that message as the basis for the new message Command parameters are as follows EMAILID Email id to retrieve The EMAILD Email id to retrieve parameter allows you to specify the identifier of a previously saved email to be used as the basis for the new message Options for the first element Email id are NEW D
94. serProfile hostname domainname CoolSpools Email also derives the name of the user concerned according to the following rules 1 If a Preferred name is available this is used 2 If a First name and Last name are available these are used 3 If a Given name and Surname are available these are used 4 If a User description is available it is used 5 If the user profile has text associated with it it is used 6 Otherwise the name is blank CoolSpools Email User Guide V6R1 Page 81 www ariadnesoftware co uk Working with Address List Entries Address list entry information is stored in file CM_LSTENT If you wish to ensure that only a restricted number of people can maintain address lists you should set the authorities on this file appropriately for example by associating an authorization list with it The WRKADRLE Work with Address List Entries command allows you to add and manage address list entries There is a single command parameter ADRL The ADRL Address list identifies the address list whose entries you wish to work with Alternatively use the WRKADRL Work with address lists command and enter option 8 Work with address list entries against the address list in which you are interested Work with Address List Entries System YOURSYS Address list SALES Text description Sales Department Type options press Enter 1 Add 2 Chang 4 Remov 5 Displa
95. subsystem description Qualifier 2 Library LIBL The subsystem description is located by means of the library list CURLIB The subsystem description is located in the current library name Specify the name of the library n which the subsystem description is located CoolSpools Email User Guide V6R1 Page 32 www ariadnesoftware co uk Class CLS Specifies the class associated with the prestart job entry The class determines certain attributes of the job such as its priority and timeslice You are unlikely to need to change this option but can do so if you need to adjust the performance of the servers by modifying things like priority and timeslice Single values SAME No change is made to the existing setting Other options are Qualifier 1 Class QBATCH The QBATCH class is used If this gives too low a priority and performance is not adequate specify an alternative class with a higher priority level name Specify the name of the class Qualifier 2 Library LIBL Locate the class through the library list CURLIB The class is located in the current library name Specify the name of the library where the class is located Submit to job queue JOBQ Specifies the name of the job queue to which the CoolSpools SMTP server jobs are submitted when they are started manually using the STRSMTPSVR command You are unlikely to need to change this option unless you have specified a subsystem other than QUSRWRK for the S
96. t of this message to add or remove extensions so long as you ensure that each extension is exactly 5 characters long including any trailing blanks and remembering that installing PTFs or a new release will overwrite your changes Any file extension not listed in one of these messages will be treated as application binary data BINARY Application binary This is the default MIME content CoolSpools Email User Guide V6R1 Page 54 www ariadnesoftware co uk type used for data types other than those which have distinct content types of their own image audio video etc TEXT Identifies the attachment as plain ASCII text CSV Identifies the attachment as CSV or other similar delimited ASCII text HTML Identifies the attachment as HTML PDF Identifies the attachment as a PDF XML Identifies the attachment as XML IMAGE identifies the attachment as an image VIDEO identifies the attachment as a video file AUDIO identifies the attachment as an audio file Code page This element allows you to identify the code page of the data in the attachment file This value is used if the content type is indicated as TEXT or HTML to convert the data to ASCII format so it can be displayed by the client email software Options are STMF Default The code page attribute of the file in the IFS is used 1 65534 The code page to use Attachment name in email This element allows you to specify the name of the attachment as it sho
97. thod ATTACH or EMBED 521 209 CHAR 7 Content type FILE TEXT HTML IMAGE VIDEO AUDIO BINARY 528 210 BINARY 4 Attachment code page 1 STMF Format for CM_A0200 o o BINARY Length of attachment path name 2 2 CHARG 2 Attachment path name 514 202 CHAR 7 Attachment method ATTACH or EMBED CoolSpools Email User Guide V6R1 Page 121 www ariadnesoftware co uk IMAGE VIDEO AUDIO BINARY 528 210 Bang Attachment code page 1 STMF 521 lds Content type FILE TEXT HTML 532 214 Bapu Length of attachment name 534 216 CHAR 64 The name to give the attachment in the email FILE The name is the same as that of the file being attached Priority INPUT CHAR 1 A code indicating the message priority N Normal priority H High priority L Low priority Confirm delivery INPUT CHAR 1 Whether confirmation of delivery is requested Y Yes N No Email message id OUTPUT CHAR 30 The unique message identifier of the message that was sent if the call to the API was successful This value is the key to the Coo Spools Email message log file CM_MSGLOG Error code INPUT OUTPUT CHAR CoolSpools Email User Guide V6R1 Page 122 www ariadnesoftware co uk A standard IBM System i API error structure in the following format Type Field pepes D 4 Bytes provided Bytes available 8 8 OUTPUT CHAR 7 Exception ID Reserved Exception data Optional Parameter Gr
98. u do not wish to have to recreate This command allows you to automate the conversion of your existing SNADS distribution lists and create CoolSpools Email address lists from them Command parameters are as follows DSTL The DSTL Distribution List parameter identifies the distribution list you wish to convert ADRL The ADRL Address List parameter specifies the name of the new address list you wish to create Options are DSTL Default The name of the address list is derived from the name of the distribution list by concatenating the two parts of the distribution list name with an intervening underscore For examples a distribution list called ARIADNE SALES will become an address list called ARIADNE_SALES Address list name Enter a valid address list name of your own choosing TEXT The TEXT Text Description parameter enables you to enter up to 50 characters of free format text to describe and further identify the new address list its contents and purpose CoolSpools Email User Guide V6R1 Page 79 www ariadnesoftware co uk HOSTNAME The TCP IP host name to be used when converting distribution list entries to email addresses Options are SYS Default The currently defined local host name as specified by the CHGTCPDMN Change TCP IP Domain command is retrieved and used Host name Enter a valid TCP IP host name of your own choosing DOMAIN The TCP IP domain name to be used whe
99. uld appear in the email Options are FILE Default The name of the attachment is the same as that of the file being attached Attachment_name The name to give the attachment in the email CoolSpools Email User Guide V6R1 Page 55 www ariadnesoftware co uk Example Attaching a PDF file SNDCMNMSG ATTACH home sales salesreport pdf ATTACH BINARY Example Embedding an HTML file SNDCMNMSG ATTACH home sales salesreport htm EMBED HTML MSGSTMF Stream file containing message The MSGSTMF Stream file containing message parameter allows you to specify the path name of a stream file from which the text of the message should be taken In order to use this parameter specify MSG STMF This could be a text file or a complete HTML document If a database file member is to be used the name must be given according to IFS naming conventions e g QSYS LIB library_name LIB file_name FILE member_name MBR Single values NONE The text of the message is not taken from a stream file Invalid if MSG STMF was specified Message stream file path Options are path name Specify the path name of the file containing the message text Code page The codepage of the data in the stream file specified on the previous element Options are STME The CCSID attribute of the stream file is used to CoolSpools Email User Guide V6R1 Page 56 www ariadnesoftware co uk 1 65534 determine the code page Specify the code
100. unsupported unlicensed version or have moved or copied the command object from its original location Contact support ariadnesoftware co uk for assistance License Keys You are entitled to upgrade to V6R1MO of CoolSpools Email free of charge if e the machine on which you wish to run CoolSpools Email V6R1MO0 has a valid license for an earlier version of Communiqu or CoolSpools PLUS and e you are either in your first 12 months maintenance period after purchase or have paid your latest annual maintenance invoice CoolSpools Email User Guide V6R1 Page 13 www ariadnesoftware co uk If you wish to upgrade you can simply download the software from www ariadnesoftware co uk and install it according to the instructions contained in the Installation section of this User Guide However if you licensed an earlier version of Communiqu or CoolSpools PLUS you will need to request a license key for the new version Simply e mail support ariadnesoftware co uk and ask for your key for V6R1MO of CoolSpools Email Please quote your system serial number s and processor group code s in your e mail These are shown at the top of the WRKLICINF screen Without a license key CoolSpools Email V6R1M0 will allow you a 30 day grace period and will then no longer run If you have not paid your annual maintenance invoice and if you need longer than 30 days to test CoolSpools Email VG MO we will on request send you a temporary license key to
101. very has been attempted at least once but where delivery has not yet been processed successfully All messages are shown irrespective of their status Once the list of emails has been displayed refer to the online help text available by pressing F1 for information about the information displayed and the options available CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Page 43 Using CoolSpools Email The CoolSpools Email Menu The easiest way to get started with CoolSpools Email is to use Coo Spools Email menu The CoolSpools Email menu brings together all of CoolSpools Email s command line options in a single convenient place To display the CoolSpools Email menu enter the following command at an AS 400 command line GO COOLSPV6R1 EMAIL EMAIL CoolSpools Email Menu Select one of the following 1 Send email messag 2 Creat mail messag 3 Retriev mail messag 4 Re send email messag 10 Work with email address lists 11 Convert distribution list 21 Work with email addr directories 31 Send iCalendar item 32 Send vCalendar item 41 Manage CoolSpools email sent via IBM s MSF 42 Manage CoolSpools email sent via CoolSpools SMTP 43 Change default email delivery method to IBM MSF 44 Change default email delivery method to CoolSpools SMTP Selection or command gt F3 Exit F4 Prompt F9 Retriev F12 Cancel F13 Information Assistant F16 AS 400 main menu Some of the
102. vironment variables is described and the environment variables used by CoolSpools Email are fully documented in the CoolSpools Programmer s Guide However the following are particularly important and deserve to be highlighted here Name CS_EMAIL_SEND_ERROR_ACTION CS_EMAIL_METHOD CS_EMAIL_SAVE_DAYS CS_EMAIL_SAVE_ENCRYPTED CS_EMAIL_SAVE_OPTION CS_EMAIL_SAVE_PASSWORD Default value STOP Processing stops immediately If therefore a spooled file is being split into multiple output files and an email error occurs on one output file any subsequent files will not be processed Description What action CoolSpools Spool Converter takes if it is unable to send an email with an attachment e g because no email address is available or an invalid not well formed email address is specified The default method by which emails are delivered When an email is saved the default retention period in days to assign The email becomes eligible for deletion using the DLTCMNMSG command with the DLTSAVMSG MSG option after the specified number of days Whether when an email is to be saved it is saved in compressed form MSF IBM s Mail Server Framework and the IBM SMTP server are used NOMAX no limit NO The email is not encrypted when it is saved NO The email is not saved Whether by default emails are saved after being sent to allow them to be resent later using RSNCMNMSG
103. will not be able to see the names of all people to whom the message was sent The SAVE Save options parameter specifies whether the message should be saved to allow later resending with the RSNCMNMSG command Note that messages sent with SAVE NO and LOG YES specified cannot be resent with RSNCMNMSG but can be retrieved by specifying the email identifier on the EMAILID parameter of SNDCMNMSG The default is the single option NO which indicates that the message will not be saved Alternatively specify a value for the following parameter elements Save message to allow resend YES Encrypt information YES NO Compress information ES NO Retain for how many days NOMAX Nbr_of_days CoolSpools Email User Guide V6R1 www ariadnesoftware co uk A copy of the email will be saved in a stream file on the system so that it can be resent if required The saved email is encrypted A password must be entered on the PWD parameter The saved email is not encrypted The saved email is compressed The saved email is not compressed The saved email is retained indefinitely Specify the number of days after which the email will be considered expired and become eligible for deletion when the DLTCMNMSG command is run with the DLTSAVMSG YES MSG option Page 60 Save in directory CURDIR The email is saved in the current directory of the job running the command HOMEDIR The email is saved in t
104. ws FROMADRDIR The FROMADRDIR From address directory identifies the address directory you wish to copy TOADRDIR The TOADRDIR To address directory identifies the address directory you wish to create TEXT The TEXT Text Description parameter enables you to enter up to 50 characters of free format text to describe and further identify the new address directory its contents and purpose CPYADRDIRE The CPYADRDIRE Copy address directory entries command allows you to indicate whether you want to copy the contents of the existing address directory or just its description Options are YES Default Yes The contents of the address directory are copied NO No The contents of the address directory are not copied Example Copy the Sales Department address directory to create a combined Sales and Marketing directory CPYADRDIR FROMADRDIR SALES CoolSpools Email User Guide V6R1 Page 93 www ariadnesoftware co uk TOADRDIR SALES_AND_MARKETING TEXT Sales and Marketing address directory CPYADRDIRE YES CoolSpools Email User Guide V6R1 Page 94 www ariadnesoftware co uk Deleting an address directory The DLTADRDIR Delete Address List command allows you to delete an existing address directory Command parameters are as follows ADRDIR The ADRDIR Address directory identifies the address directory you wish to delete Example Deleting the Sales Department address directory DLTADRDIR
105. y 6 Print Opt Email address Jane Doe ariadnesoftware co uk Joe Bloggs ariadnesoftware co uk John Smith ariadnesoftware co uk Bottom F3 Exit F5 Refresh F12 Cancel F17 Position to Options that can be input against entries in the list are CoolSpools Email User Guide V6R1 Page 82 www ariadnesoftware co uk 1 Add 2 Change 4 Remove 5 Display 6 Print Available command keys are F3 Exit F5 Refresh F12 Cancel F17 Position CoolSpools Email User Guide V6R1 www ariadnesoftware co uk Select this option to add a new address list entry This option is available only on the first line of the display You can enter the new email address in the space available if desired This is equivalent to running the ADDADRLE Add Address List Entry command Select this option to change an existing address list entry This is equivalent to running the CHGADRLE Change Address List Entry command Select this option to remove one or more address list entries This is equivalent to running the RMVADRLE Remove Address List Entry command Selection this option to display the details of an address list entry Select this option to print an address list entry Exit the application Refresh the list Return to the previous screen Display the positioner window to allow the list to be positioned to a specified address list Page 83 Adding an address list entry The ADDADRLE Add Address List Entry command

Email User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents