[7562] Deprecate msiSendMail.

korydraughn · Mar 18, 2024 · bc1e61d · bc1e61d
1 parent 892cd4c
commit bc1e61d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/doxygen/microservices.cpp b/doxygen/microservices.cpp
@@ -112,7 +112,7 @@
   - #msiSubstr   - Returns a substring of the given string
 
  \subsection msiemail Email Microservices
-  - #msiSendMail   - Sends email
+  - #msiSendMail   - (Deprecated) Sends email
 
  \subsection msikv Key-Value (Attr-Value) Microservices
   - #writeKeyValPairs - Writes key-value pairs to stdout or stderr and with given separator

diff --git a/server/re/src/mailMS.cpp b/server/re/src/mailMS.cpp
@@ -14,12 +14,15 @@
  *
  * \brief Sends email
  *
+ * \deprecated Deprecated in 4.3.2. Use the Python rule engine plugin or expose your own mail utility via msiExecCmd.
+ *
  * \module core
  *
  * \since pre-2.1
  *
  *
- * \note   This microservice sends e-mail using the mail command in the unix system. No attachments are supported. The sender of the e-mail is the unix user-id running the irodsServer.
+ * \note This microservice sends e-mail using the mail command in the unix system. No attachments are supported. The
+ *       sender of the e-mail is the unix user-id running the irodsServer.
  *
  * \usage See clients/icommands/test/rules/
  *
@@ -41,7 +44,7 @@
  * \pre none
  * \post none
  * \sa none
-**/
+ **/
 int msiSendMail( msParam_t* xtoAddr, msParam_t* xsubjectLine, msParam_t* xbody, ruleExecInfo_t* ) {
 
     const char * toAddr = ( char * ) xtoAddr->inOutStruct;