IO18189: INCORRECT JAVADOC FOR THE USERFUNCTIONS.SENDMAIL METHOD

Subscribe

You can track all active APARs for this component.

APAR status

  • Closed as program error.

Error description

  • PRODUCT VERSION
    ITDI 7.1.1
    
    
    PROBLEM DESCRIPTION
    The method sendMail of class com.ibm.di.function.UserFunctions
    has two signatures, described in the following way by the
    current ITDI API javadoc:
    
    1)
    public String sendMail(String from, String recipient,
    String subject, String body, String attachment)
    
    Parameters:
    from - The From field
    recipient - A comma separated list of recipient addresses
    subject - The Subject field
    body - The message text
    attachment - If specified a file-path that will be attached to
                 the message
    
    2)
    public String sendMail(String from, String recipient,
    String subject, String body, String attachments, String replyTo)
    
    Parameters:
    from - The From field
    recipient - A comma separated list of recipient addresses
    subject - The Subject field
    body - The message text
    attachments - If specified a comma separated list of file-paths
                  that will be attached to the message
    replyTo - A comma separated list of ReplyTo addresses
    
    Apart for the replyTo parameter (available only in the second
    signature), the first version would accept only a mail
    attachment, while the second one accepts a comma separated list
    of file-paths to attached to the message.
    However, in the real case, both the methods manage the
    attachment string parameter in the same way, as a a comma
    separated list of file-paths to attach to the mail.
    So the javadoc of the first method signature is incorrect.
    
    
    DESIRED BEHAVIOR
    The javadoc of the first method signature must be changed in the
    the followin way:
    
    public String sendMail(String from, String recipient,
    String subject, String body, String attachments)
    
    Parameters:
    from - The From field
    recipient - A comma separated list of recipient addresses
    subject - The Subject field
    body - The message text
    attachments - If specified a comma separated list of file-paths
                  that will be attached to the message
    

Local fix

  • NA
    

Problem summary

  • Incorrect JavaDoc for UserFunction sendMail method
    

Problem conclusion

  • This is bug in TDI code and has been fixed, formal fix will be
    made available in 7.1.1-TIV-TDI-FP0003.
    

Temporary fix

Comments

APAR Information

  • APAR number

    IO18189

  • Reported component name

    ITDI MULTIPLATF

  • Reported component ID

    5724D9960

  • Reported release

    711

  • Status

    CLOSED PER

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt

  • Submitted date

    2013-02-22

  • Closed date

    2013-02-25

  • Last modified date

    2013-02-25

  • APAR is sysrouted FROM one or more of the following:

  • APAR is sysrouted TO one or more of the following:

    IO18190

Fix information

  • Fixed component name

    ITDI MULTIPLATF

  • Fixed component ID

    5724D9960

Applicable component levels

  • R711 PSY

       UP



Rate this page:

(0 users)Average rating

Document information


More support for:

IBM Security Directory Integrator
General

Software version:

711

Reference #:

IO18189

Modified date:

2013-02-25

Translate my page

Machine Translation

Content navigation