3.2.4.2.11.11 EmailTest (Opnum 17)
The EmailTest method sends an email message to the specified email address using the settings that the File Server Resource Manager Protocol is configured to use. The settings include SMTP server name and Mail from email address. The format of the email address has to be as specified in [RFC5322].
-
[id(FSRM_DISPID_SETTING | 0x01)] HRESULT EmailTest( [in] BSTR mailTo );
mailTo: Contains the email address for the File Server Resource Manager Protocol to send the test email message to.
Return Values: The method MUST return zero on success, or a nonzero error code on failure.
-
Return value/code
Description
0x8004530D
FSRM_E_OUT_OF_RANGE
The content of the mailTo parameter exceeds the maximum length of 4,000 characters.
0x80045318
FSRM_E_INVALID_SMTP_SERVER
The SmtpServer property is not set.
0x8004531C
FSRM_E_EMAIL_NOT_SENT
An email message could not be sent.
Upon receiving this message, the server MUST perform the following operations:
If the email address mentioned in mailTo exceeds the maximum length of 4,000 characters, the server MUST return FSRM_E_OUT_OF_RANGE.
If Mail from email address set by MailFrom (put) (section 3.2.4.2.11.4) contains an invalid email address, the server MUST return FSRM_E_INVALID_SMTP_SERVER.
The server MUST send an email message to the email address specified by using the settings that the File Server Resource Manager Protocol is configured to use or return FSRM_E_EMAIL_NOT_SENT.