3.2.4.2.7.3 MailTo (get) (Opnum 14)

  • Article

The MailTo (get) method returns the mail to list of email addresses property of the action. The value of the mailTo parameter is the list of email addresses that the reports generated by this action will be sent to. The format of the email address has to be as specified in [RFC5322].

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_ACTION_REPORT | 0x02))] HRESULT MailTo(
   [out, retval] BSTR* mailTo
 );

mailTo: A pointer to a variable that upon completion contains the mail to list of email addresses of the action. The string returned in mailto MUST be in the form of a mailTo string (section 3.2.4.2).

Return Values: The method MUST return zero on success, or a nonzero error code on failure.

Return value/code

Description

0x80070057

E_INVALIDARG

The mailTo parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that mailTo is not NULL.

If any validation fails, the server MUST terminate processing and return a nonzero error code.

The server MUST set mailTo to the mail to list of email addresses for the reports generated by this action.

If the list of email recipients contains the special string "[ADMIN_EMAIL]", the server MUST return the list of email recipients without resolving the "[ADMIN EMAIL]" macro.