HP NonStop Data Transformation Engine E-mail Adapter Reference Guide Abstract This manual provides information about using the HP NonStop™ Data Transformation Engine (NonStop DTE) e-mail adapter on the NonStop server. Product Version NonStop Data Transformation Engine 6.7.
Document History Part Number Product Version Published 528263-001 NonStop Data Transformation Engine 6.7.
Contents About This Document Related References........................................................................................... 5 Chapter 1 - E-mail Adapters Overview ....................................................................................................... 6 System Requirements ........................................................................................ 6 Chapter 2 - Command Alias Chapter 3 - E-mail Commands List of Commands.............................................
Contents Data Sources............................................................................................. 27 Data Targets............................................................................................. 28 Example ....................................................................................................... 28 Example Files................................................................................................. 28 Example - Send Mail Using the MAPI Protocol ............
About This Document This document contains detailed information about using the E-mail Adapter. For general information regarding using any of the Mercator Resource adapters, see the Resource Adapters Reference Guide. This document assumes that the reader knows the Windows environment, has used the Mercator Design Studio, and understands words such as mapping, type trees, and other basic Mercator terminology.
Chapter 1 - E-mail Adapters This chapter introduces the e-mail adapters. You can use the adapters with a Command Server, Event Server, Platform API, or map in a map rule. Overview E-mail adapters automatically receive e-mail messages as sources of a map or send e-mail messages as targets of a map. The possibilities are flexible and easy to implement.
Chapter 2 - Command Alias Specify adapter commands by using a command string on the command line or by creating a command file that contains adapter commands. The command syntax is: -IA[alias]card_num -OA[alias]card_num In the command syntax, -IA is the Input Source Override execution command and -OA is the Output Target Override execution command, alias is the adapter alias, and card_num is the number of the map card. The E-mail adapter alias and corresponding execution commands are listed below.
Chapter 3 - E-mail Commands This chapter describes the functions and use of E-mail commands and their options. List of Commands The following table lists valid commands for e-mail adapters, the command syntax, and whether the command is supported (√) for use with data sources, targets, or both.
Chapter 3 - E-mail Commands List of Commands Name Syntax Source Server ² -SERVER host_name Subject -SUBJECT subject Text -TEXT string To Recipient -TO recipient Trace -TRACE[+][S|V] [full_path] Type ² -TYPE content_type Username -USER user_id ! ! ! ! ! ! ² supported by Internet E-mail adapter only ³ supported by cc:Mail, Lotus Notes, and Internet E-mail adapters only supported by MAPI adapter only E-mail Adapter Reference Guide 9 ! ! ! ¹ supported by cc:Mail adapter only 4 ! Ta
Chapter 3 - E-mail Commands List of Commands Attachment (-ATT or -ATTACH) The Attachment adapter command (-ATT or -ATTACH) processes message attachments. When used for a data source, you can read attachments instead of the note text. In this case, filename must be omitted. When used for a data target, this command changes the location of data supplied through the map from the body of the e-mail to a file attachment with the name specified by filename.
Chapter 3 - E-mail Commands List of Commands Attachment Name (-AN or -ATTNAME) The Attachment Name adapter command (-AN or -ATTNAME) specifies that the name of the attachment should be returned together with the attachment itself. This command can only be used on input. It results in the name of the attachment being returned as a header to the data. -ATTNAME fieldname Option Description fieldname Specify the name of the header field that should be returned in the header.
Chapter 3 - E-mail Commands List of Commands Audit information is recorded detailing files sent or received from each host, elapsed time, file size, and retry count for each file. -AUDIT[+][S] [full_path] Option Description + Append audit information to the existing log file. If a log file does not exist, it is created. S Summary mode. Record only minimal information in the log file. full_path Create audit file with the specified name in the specified directory.
Chapter 3 - E-mail Commands List of Commands CC Recipient (-CC) The CC Recipient adapter command (-CC) identifies a courtesy copy (CC) recipient, but is otherwise identical to the To Recipient adapter command (-TO). -CC recipient Option Description recipient Specify the CC recipient. From (-FROM) The From adapter command (-FROM) uses the specified e-mail address as the sender of the generated message.
Chapter 3 - E-mail Commands List of Commands Header (-HDR) When used on input, the Header adapter command (-HDR) retrieves the message header in the following format: From: originator[originator_address] Subject: subject text Date: yyyy/mm/dd hh: mm To: recipient[recipient_address]; …; recipient[recipient_address] cc: recipient[recipient_address]; …; recipient[recipient_address] bcc: recipient[recipient_address]; …; recipient[recipient_address] -HDR[+] Option Description + Append user-supplied header
Chapter 3 - E-mail Commands List of Commands Login (-L or -LOGIN) The Login adapter command (-L or -LOGIN) is used for data sources to supply the method(s) used to gain access to the mailbox. When a Login command is not provided, the default setting is USERPASS. Consult your System Administrator if you are unsure of the method to use. Generally, the method used is USERPASS. Note This command is only supported by the Internet E-mail adapter.
Chapter 3 - E-mail Commands List of Commands Password (-P or -PASS) Use the Password adapter command (-P or -PASS) to gain authorized access to mailboxes that use security passwords. This command is required unless you are using a mailbox that does not require you to specify the user ID and password to connect to the mailbox. -PASS password Option Description password When used for a data source, supply the case-sensitive password required for entry to the source mailbox.
Chapter 3 - E-mail Commands List of Commands Priority (-PRI or -PRIORITY) Use the Priority adapter command (-PRI or -PRIORITY) to set the priority of the message. -PRIORITY level Option Description level Required value. Specify the level of priority: 1. -low or -lo 2. -normal or -nrm 3. -high or –hi Note This command is only supported by cc:Mail, Lotus Notes, and Internet E-mail adapters.
Chapter 3 - E-mail Commands List of Commands Raw (-RAW) Use the Raw (-RAW) command in an input card to dump out the received message without interpreting or processing the header fields. Use it on an output card if the data specified contains the header data. The type tree RawInet.mtt in the examples directory can be used to create the header data. To access an example for this adapter, click Start > Programs > Mercator 6.7 > Examples and navigate to Resource Adapters.
Chapter 3 - E-mail Commands List of Commands Resolve (-RESOLVE) Use the Resolve adapter command (-RESOLVE) to allow address checking and enable RTF (Rich Text Format). This command only applies to data targets in MAPI e-mail systems. -RESOLVE Note This command is only supported by the MAPI adapter. Server (-SVR or -SERVER) Use the Server adapter command (-SVR or -SERVER) to identify the host server where the mailbox can be accessed or addressed. Use only with the Internet E-mail adapter.
Chapter 3 - E-mail Commands List of Commands Text (-TXT or -TEXT) Use the Text adapter command (-TXT or -TEXT) to process the text part(s) of the message. When used for a data source, it specifies that text parts should be retrieved in addition to attachments if the Attachment adapter command (-ATTACH) is specified. In this case, omit string and the flag is ignored if -ATTACH has not been specified.
Chapter 3 - E-mail Commands List of Commands Trace (-T or -TRACE) Use the Trace adapter command (-T or -TRACE) to produce a diagnostic file in the map directory with the default name m4email.mtr. Trace information is recorded detailing the adapter activity. -TRACE[+][S|V] [full_path] Option Description + Append trace information to the existing log file. S Summary mode. Record only minimal information in the log file. Default value. V Verbose mode.
Chapter 3 - E-mail Commands List of Commands Username (-U or -USER) Use the Username adapter command (-U or -USER) to identify the user name associated with the account being accessed. You may omit this command if mailbox session is currently active. -USER user_id Option Description user_id Specify a valid user name for the e-mail account being accessed. When used for a data target and this command is omitted, the default profile is used to log on to the e-mail system.
Chapter 3 - E-mail Commands Using E-mail Adapter Commands Using E-mail Adapter Commands Use the e-mail adapters either as the data source of an input map card, as the data target for an output map card, or both. You can also use the adapters on the command line or in a map rule using the functions GET, PUT, or RUN. E-mail adapters support protocols for several popular e-mail applications.
Chapter 4 - Syntax Summary This chapter presents syntax summaries for general e-mail, cc:Mail, Notes, and Internet E-mail adapters. E-mail Adapter Commands The following command syntax summaries pertain to general e-mail adapters.
Chapter 4 - Syntax Summary cc:Mail Adapter Commands Data Targets The following is the command syntax of the e-mail adapter commands used for data targets: -PROTO MAPI [-USER user_id] [-PASS password] [-SUBJECT subject] [-TO recipient] [-CC recipient] [-BCC recipient] [-RECEIPT] [-RESOLVE] [-ATTACH filename] [-TEXT string] [-TRACE[+][S|V] [full_path]] [-AUDIT[+][S] [full_path]] [-RAW] [-HDR[+]] [-TYPE content_type] cc:Mail Adapter Commands This section discusses the cc:Mail syntax summary and how it is u
Chapter 4 - Syntax Summary Notes Adapter Commands Data Targets The following is the command syntax of the cc:Mail adapter commands used for data targets: -PROTO CCMAIL -USER user_id [-PASS password] [-PO post_office] [-SUBJECT subject] [-TO recipient] [-CC recipient] [-BCC recipient] [-PRIORITY level] [-RECEIPT] [-ATTACH filename] [-TEXT string] [-TRACE[+][S|V] [full_path]] [-AUDIT[+][S] [full_path]] Notes Adapter Commands This section discusses the Notes syntax summary and how it is used.
Chapter 4 - Syntax Summary Internet E-mail Adapter Commands Data Targets The following is the syntax of the Notes e-mail adapter commands used for data targets: -PROTO NOTES [-PASS password] [-SUBJECT subject] [-TO recipient] [-CC recipient] [-BCC recipient] [-PRIORITY level] [-RECEIPT] [-ATTACH filename] [-TEXT string] [-TRACE[+][S|V] [full_path]] [-AUDIT[+][S] [full_path]] Internet E-mail Adapter Commands This section discusses the Internet e-mail syntax summary and how it is used.
Chapter 4 - Syntax Summary Example Data Targets The following is the syntax of the Internet e-mail adapter commands used for data targets: -PROTO INET [-SERVER host_name] [-PASS password] [-SUBJECT subject] [-FROM sender] [-TO recipient] [-CC recipient] [-BCC recipient] [-PRIORITY level] [-RECEIPT] [-ATTACH filename] [-TEXT string] [-TRACE[+][S|V] [full_path]] [-AUDIT[+][S] [full_path]] Example = RUN(“XExLogEM.mmc”, “ -WD -AE=” + GETDIRECTORY( AuditLog )+ “XExLogEM.
Chapter 4 - Syntax Summary Example Files Example - Send Mail Using the MAPI Protocol For the GET > Source setting in an input card dialog, select e-mail. In the GET > Source > Command field, the following command example: -PR MAPI -U sbill -ATT -T receives electronic mail using the MAPI protocol to a user named sbill. The Attachment adapter command (–ATT) command specifies that any message attachments are processed.
Chapter 5 - Troubleshooting For information about error codes and messages returned by the adapters, see Appendix A - Return Codes and Error Messages. Various troubleshooting tools are available when you encounter problems using e-mail adapters as data sources or targets for a map. If you attempt to run a map that uses an e-mail adapter and receive a run-time error or do not get the expected output, use any or all of the following troubleshooting tools: ♦ View the Trace log file (.
Chapter 5 - Troubleshooting MAPI E-mail Systems MAPI E-mail Systems ♦ The 32-bit version of the MAPI Services (mapi32.dll and its associated software) must be installed on the same computer where the adapters are installed ♦ A valid profile must exist. (Profiles are associated with the user ID) ♦ The Event Server, if used, must run under a user ID that has access to the desired profile Examples The following scenarios and solutions can help you troubleshoot common problems using the MAPI utility adapter.
Chapter 5 - Troubleshooting cc:Mail cc:Mail The 32-bit version of VIM Services (vim32.dll and its associated software) must be installed on the same computer where the adapters are installed. Internet E-mail ♦ The 32-bit version of Internet E-mail (wsock32.dll, normally installed as part of the Windows operating system) must be installed on the same computer where the adapters are to be installed ♦ Windows (95/NT) or BSD (UNIX) Sockets must be installed on the client computer.
Chapter 5 - Troubleshooting Lotus Notes Lotus Notes ♦ The 32-bit version of VIM Services (vim32.dll and its associated software) must be installed on the same computer where the adapters are to be installed. ♦ Notes must be in the PATH. When using the Event Server, only the System PATH is available. The User PATH is never accessible if the server runs under the appropriate user ID. You may need to manually modify those settings.
Appendix A - Return Codes and Error Messages Return codes and messages are returned when the particular activity completes. Return codes and messages may also be recorded as specified in the audit logs, trace files, execution summary files, etc. Messages The following is a listing of all the codes and messages that can be returned as a result of using E-mail adapter for sources or targets. Note Adapter return codes with positive numbers are warning codes that indicate a successful operation.
Appendix A - Return Codes and Error Messages Messages Return Code Message 1 No data provided. Create on content specified: no data sent. -1 Unsupported protocol -1 Insufficient memory to continue -1 Invalid protocol selection.
Index . D .log, 30 .
Index P 19 syntax summary cc mail, 25 general e-mail, 24 Internet e-mail, 27 notes, 26 system requirements, 6 P Password (-P or -PASS) adapter command, 16 Platform API, 6 POP3, 6 Post Office (-PO) cc:Mail adapter command, 16 Priority (-PRI or -PRIORITY) adapter command, 17 Protocol (-PR or -PROTO) adapter command, 17 T target, 25, 26, 27, 28 Text (-TXT or -TEXT) adapter command, 20 To Recipient (-TO) adapter command, 20 Trace (-T or -TRACE) adapter command, 21 trace file, 30 trace file example, 30 troubl
