3.2.4.2.34.8 MailTo (get) (Opnum 18)

  • Article

The MailTo (get) method returns the email address recipient list to which the reports will be emailed when the report job is successfully completed. The format of the email address needs to be as specified in [RFC5322].

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

mailTo: Pointer to a variable that upon completion contains the email recipient list to which the reports will be sent when the report job is generated. The string returned in mailTo MUST be in the form of 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 the mailTo parameter to Report Job.Mail to to which the reports will be sent when the report job is generated.

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.