3.2.4.2.7.4 MailTo (put) (Opnum 15)

  • Article

The MailTo (put) method sets the mailTo property of the action. The mailTo string will be used as the list of email addresses to send the reports generated by this action. The format of the email address has to be as specified in [RFC5322].

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

mailTo: Contains the mail to list of email addresses to use for this action. The maximum length of this string MUST be 4,000 characters. The string 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 not a valid value.

  • The content of the mailTo parameter exceeds the maximum length of 4,000 characters.

The server MUST use the mailTo parameter as the list of email addresses to send the reports generated by this action or return a nonzero error code. If mailTo is an empty string, the server MUST NOT email the report when the action is run.

If mailTo contains the string "[ADMIN EMAIL]", the server MUST send the email to the Administrator email address setting (section 3.2.1.9).