home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / hrxmail.zip / HRxMail.txt < prev   
Text File  |  1996-06-12  |  5KB  |  175 lines
  1. Documentation file for HRxMail.dll functions.
  2.  
  3. Function Name:  HStoreMail
  4. Syntax:         HStoreMail( <username>, <mail directory>, <msg> )
  5.  
  6. Description:
  7.  
  8. <username>  -- The username of the user.
  9. <mail directory> -- The full pathname of the user's mail directory.
  10. <msg> -- The message file to store in the user's mailbox.
  11.  
  12. This function accepts the arguments given and stores the message file
  13. in the user's mailbox.
  14.  
  15. Return Values:
  16.  
  17. "Error 1. Wrong Number of Arguments."
  18. "Error 2. Cannot open mailbox."
  19. "Error 3. Cannot store mail."
  20. "Error 4. Error closing mailbox."
  21. "OK. Mail stored."
  22.  
  23. ------------------------------------------------------------------------------
  24.  
  25. Function Name:  HNumMail
  26. Syntax:         HNumMail( <username>, <mail directory> )
  27.  
  28. Description:
  29.  
  30. <username>  -- The username of the user.
  31. <mail directory> -- The full pathname of the user's mail directory.
  32.  
  33. This function returns the number of mail messages in the user's mailbox.
  34.  
  35. Return Values:
  36.  
  37. "Error 1. Wrong Number of Arguments."
  38. "Error 2. Cannot open mailbox."
  39. "Error 4. Error closing mailbox."
  40. "OK. x messages."  (where x is the number of messages present.)
  41.  
  42. ------------------------------------------------------------------------------
  43.  
  44. Function Name:  HRetrMailFile
  45. Syntax:         HRetrMailFile( <username>, <mail directory>, <file>, <index>, <flag> )
  46.  
  47. Description:
  48.  
  49. <username>  -- The username of the user.
  50. <mail directory> -- The full pathname of the user's mail directory.
  51. <file> -- A temporary file which will be overwritten by the mail message.
  52. <index> -- The message number to retrieve.
  53. <flag> -- If set to "delete", the message is removed. This variable
  54.           is optional. If not present, the message is not removed.
  55.  
  56. This function retrieves the message file indicated by the index value.
  57. The message file is copied to the filename indicated by msg overwriting 
  58. any previous contents.
  59.  
  60. Return Values:
  61.  
  62. "Error 1. Wrong Number of Arguments."
  63. "Error 2. Cannot open mailbox."
  64. "Error 4. Error closing mailbox."
  65. "Error 5. Message not present."
  66. "Error 6. Message not deleted."
  67. "OK. Mail retrieved."
  68.  
  69. ------------------------------------------------------------------------------
  70.  
  71. Function Name:  HRetrMail
  72. Syntax:         HRetrMail( <username>, <mail directory>, <var>, <index>, <flag> )
  73.  
  74. Description:
  75.  
  76. <username>  -- The username of the user.
  77. <mail directory> -- The full pathname of the user's mail directory.
  78. <var> -- A stem variable holding the message. One line per component.
  79. <index> -- The message number to retrieve.
  80. <flag> -- If set to "delete", the message is removed. This variable
  81.           is optional. If not present, the message is not removed.
  82.  
  83. This function retrieves the message file indicated by the index value.
  84. The message file is copied to the stem variable.
  85.  
  86. Return Values:
  87.  
  88. "Error 1. Wrong Number of Arguments."
  89. "Error 2. Cannot open mailbox."
  90. "Error 4. Error closing mailbox."
  91. "Error 5. Message not present."
  92. "Error 6. Message not deleted."
  93. "Error 7. Stem variable not present."
  94. "Error 8. Error storing stem variable."
  95. "OK. Mail retrieved."
  96.  
  97. ------------------------------------------------------------------------------
  98.  
  99. Function Name:  HRetrHead
  100. Syntax:         HRetrHead( <username>, <mail directory>, <var>, <index> )
  101.  
  102. Description:
  103.  
  104. <username>  -- The username of the user.
  105. <mail directory> -- The full pathname of the user's mail directory.
  106. <var> -- A stem variable holding the message. One line per component.
  107. <index> -- The message number to retrieve.
  108.  
  109. This function retrieves the headers of the message file indicated by 
  110. the index value. The headers are copied to stem variable.
  111.  
  112. Return Values:
  113.  
  114. "Error 1. Wrong Number of Arguments."
  115. "Error 2. Cannot open mailbox."
  116. "Error 4. Error closing mailbox."
  117. "Error 5. Message not present."
  118. "Error 7. Stem variable not present."
  119. "Error 8. Error storing stem variable."
  120. "OK. Headers retrieved."
  121.  
  122. ------------------------------------------------------------------------------
  123.  
  124. Function Name:  HRetrSize
  125. Syntax:         HRetrSize( <username>, <mail directory>, <index>, <size> )
  126.  
  127. Description:
  128.  
  129. <username>  -- The username of the user.
  130. <mail directory> -- The full pathname of the user's mail directory.
  131. <index> -- The message number to query.
  132. <size> -- The returned size of the message in bytes.
  133.  
  134. This function returns the size of the indicated message. A size of 0 
  135. indicates the message did not exist.
  136.  
  137. Return Values:
  138.  
  139. "Error 1. Wrong Number of Arguments."
  140. "Error 2. Cannot open mailbox."
  141. "Error 4. Error closing mailbox."
  142. "Error 9. Error storing value."
  143. "OK. Size retrieved."
  144.  
  145. ------------------------------------------------------------------------------
  146.  
  147. Function Name:  HMailLoadFuncs
  148. Syntax:         HMailLoadFuncs()
  149.  
  150. Description:
  151.  
  152. This functions loads all functions.
  153.  
  154. Return Values:
  155.  
  156. "Error 1. Wrong Number of Arguments."
  157. "OK. Functions loaded."
  158.  
  159. ------------------------------------------------------------------------------
  160.  
  161. Function Name:  HMailDropFuncs
  162. Syntax:         HMailDropFuncs()
  163.  
  164. Description:
  165.  
  166. This functions unloads all functions.
  167.  
  168. Return Values:
  169.  
  170. "Error 1. Wrong Number of Arguments."
  171. "OK. Functions dropped."
  172.  
  173. ------------------------------------------------------------------------------
  174.  
  175.