Share via

3.2.4.2.5.1 MailFrom (get) (Opnum 12)

  • Article

The MailFrom (get) method returns the mail from property of the action. The MailFrom string parameter contains the address used as the sender of email generated by this action. The format of the email address has to be as specified in [RFC5322].

 [propget, id(FSRM_PROPERTY(FSRM_DISPID_ACTION_EMAIL | 0x01))] HRESULT MailFrom(
   [out, retval] BSTR* mailFrom
 );

mailFrom: Pointer to a variable that upon completion contains the mail from value of the object. The maximum length of this string MUST be 4,000 characters.

Return Values: The method MUST return zero on success, or a nonzero error code on failure.

Return value/code

Description

0x80070057

E_INVALIDARG

The mailFrom parameter is NULL.

Upon receiving this message, the server MUST validate parameters:

  • Verify that mailFrom is not NULL.

If any validation fails, the server MUST terminate processing and return a nonzero error code.

The server MUST set mailFrom to the mail from email address of the action.

If the email address contains the special string "[ADMIN_EMAIL]", the server MUST return the email address without resolving the "[ADMIN EMAIL]" macro.