10
Sun, Nov
10 New Articles

TechTip: Using the QTMMSENDMAIL API

APIs
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

I think that most of us know that you can use the SNDDST command to send an email with a single attachment. But what do you do if you need to send multiple attachments? Or send to multiple persons? Well, you have a few options. First, you can take the easy way out and just send multiple emails with a single attachment (no shame in that...I did it for years). Or you can take the bull by the horns and use the QTMMSENDMAIL API to send multiple attachments to multiple people in a single email. Although getting started using QTMMSENDMAIL will require some work up front, the returns are well worth the effort. But there are several items to be addressed (no pun intended) before using the API.

First, you need to create a MIME-formatted email file and place it in the IFS. In my opinion, this is the most difficult part of using the QTMMSENDMAIL API. IBM apparently figures that if you are using the API, then you must be able to recite RFC822 from memory, because IBM has no documentation regarding building a MIME email file. For those of you who are unfamiliar with RFC822, it is the document that defines the "standard for the format of ARPA Internet text messages." Feel free to wade through it at your leisure. It is not an easy read, but it does have some good information. Personally, I would not bother with it unless you are planning to build your own version of Outlook or Eudora. I found an excellent "how-to" article that was much more helpful. In addition, I have included a sample of a valid MIME-formatted email below. If you are only going to be sending text messages and text files (flat text or comma delimited), you can just use the sample I have included as a guide. If you are planning to email programs or *SAVF types of files, you will probably need to get detailed information from the sources mentioned above.

Once you understand how to create your MIME email file, you can move on to the next hurdle. To send email using QTMMSENDMAIL, you need to call it with the correct parameters. However, in this instance, that is not as simple as it sounds. To start with, the IBM documentation is not clear on how to format the parameters. To make matters worse, those of us who are predominantly RPG programmers are used to working with fixed field lengths and tend to be thrown off by variable field lengths and pointers.

If you are familiar with C and/or C++ and the use of structures, you can probably skip the next few paragraphs. For the rest of you, I will walk you through the process so you get a thorough understanding of how to build the structure(s) needed for the QTMMSENDMAIL API.

The QTMMSENDMAIL API has seven required parameters:

  1. File Name is the IFS path and file name of the MIME email file. Maximum file name length is 255.
  2. File Name Length is the length of the file name. Max is 255.
  3. Originator Address is the email address of the sender. Maximum originator address length is 256.
  4. Length of Originator is the length of the originator address. Max is 256.
  5. Recipient Structure is the data structure (ADDTO100) of all recipients. Maximum length for any single recipient address is 256.
  6. Total Number of Recipients should be obvious. It's the total number of persons the email is being sent to, including carbon copies (CC) and blind carbon copies (BCC).
  7. Error Code is the standard API error structure. See the IBM documentation for details.


The tricky part is that the file name, originator address, recipient structure, and error code are passed as pointers, and the recipient structure occurs once for each recipient. Passing pointers is simply a matter of using the %ADDR BIF to get the address of each of the fields. The multiple occurrences of the recipient structure (ADDTO100) need to be placed end to end into a large field or data structure. In the sample program, I use a function to prepare each occurrence and then append it to the large RecipTbl field. This process of appending each occurrence could be further shortcut by using a pointer and moving the data directly into the RecipTbl field (alas, I have a deadline, so I'm not going back to change it now).

Gotchas

There are a few things to watch for when using QTMMSENDMAIL. Foremost among these is that if your MIME email file is incorrect in some way, the API will complete successfully (i.e., QUSEC shows no error), but the email(s) never show up at the destination. This was an irritating problem when I was learning to create the MIME emails correctly. As a side note, the originator and recipients listed in the MIME file do not necessarily have to match the ones you send as parms to the QTMMSENDMAIL API. However, this causes some unexpected results (as I found out) and is not recommended.

Also, the conversion between EBCDIC and ASCII can be a problem. If everything you are sending is binary data (e.g., programs, *SAVF files, etc.), you will not have this problem. However, if you are sending data from a file as an attachment, you will need to convert the data to ASCII.

Lastly, I have not included any error checking on the API call in the sample program. You may want to add some (just in case).

Jeff Olen is a member of the AS/400 development team at Gauss Interprise, a content management software company located in Irvine, California. He can be reached by email at This email address is being protected from spambots. You need JavaScript enabled to view it..


Jeff Olen

Jeff Olen is a super-spy now but keeps his cover identity intact by working for video game studios on the East Coast. So when he’s not out killing members of ISIS or rescuing refugees, you can find him playing Wolfenstein II or testing the new Fallout 76 releases at his beach house in Costa Rica. In any case, he can’t be reached. You can email his cat at This email address is being protected from spambots. You need JavaScript enabled to view it.. She will pass on your message…if she feels like it.


MC Press books written by Jeff Olen available now on the MC Press Bookstore.

The IBM i Programmer’s Guide to PHP The IBM i Programmer’s Guide to PHP
Get the scoop on how PHP can—and should—be deployed on IBM systems.
List Price $79.95

Now On Sale

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: