3.2.4.2.48.20 MailTo (get) (Opnum 30)

  • Article

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

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

mailTo: Pointer to a variable that upon completion contains the mail to email addresses to which the reports will be sent when the file management job is run. 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

This code is returned for the following reasons:

  • The mailTo parameter is NULL.

  • The list of addresses in the mailTo parameter is too long.

  • One or more of the addresses are not formatted correctly.

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 File Management Job.Mail to email addresses to which the reports will be emailed when the file management job is run.

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.