3.2.4.2.48.21 MailTo (put) (Opnum 31)

The MailTo (put) method sets 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].

 [propput, id(FSRM_PROPERTY(FSRM_DISPID_FILE_MANAGEMENT_JOB | 0x0b))] HRESULT MailTo(
   [in] BSTR mailTo
 );

mailTo:  Contains the mail to email addresses to which the reports will be emailed when the file management job is run.  The string in mailTo MUST be in the form of a mailTo string (section 3.2.4.2). The maximum length of this string MUST be 255 characters.

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 list of addresses in the mailTo parameter exceeds the maximum length of 255 characters.

  • One or more of the addresses are not formatted correctly. Each email address needs to be as specified in [RFC5322].

 The server MUST set the File Management Job.Mail to email addresses on the file management job object or return a nonzero error code.

If mailTo contains the string "[ADMIN EMAIL]", the server MUST store that string instead of replacing it with the Administrator email address setting (section 3.2.1.9).