wiki:Documentation/ARexxAPI/GETMAILINFO

Version 4 (modified by Jens Maus, 4 years ago) (diff)

Languages:

ARexx Function List

  1. Documentation/ARexxAPI/ADDRDELETE
  2. Documentation/ARexxAPI/ADDREDIT
  3. Documentation/ARexxAPI/ADDRFIND
  4. Documentation/ARexxAPI/ADDRGOTO
  5. Documentation/ARexxAPI/ADDRINFO
  6. Documentation/ARexxAPI/ADDRLOAD
  7. Documentation/ARexxAPI/ADDRNEW
  8. Documentation/ARexxAPI/ADDRRESOLVE
  9. Documentation/ARexxAPI/ADDRSAVE
  10. Documentation/ARexxAPI/APPBUSY
  11. Documentation/ARexxAPI/APPNOBUSY
  12. Documentation/ARexxAPI/FINDMAIL
  13. Documentation/ARexxAPI/FLUSHINDEXES
  14. Documentation/ARexxAPI/FOLDERINFO
  15. Documentation/ARexxAPI/GETCONFIGINFO
  16. Documentation/ARexxAPI/GETFOLDERINFO
  17. Documentation/ARexxAPI/GETMAILINFO
  18. Documentation/ARexxAPI/GETSELECTED
  19. Documentation/ARexxAPI/GETURL
  20. Documentation/ARexxAPI/HELP
  21. Documentation/ARexxAPI/HIDE
  22. Documentation/ARexxAPI/INFO
  23. Documentation/ARexxAPI/ISONLINE
  24. Documentation/ARexxAPI/LISTFREEZE
  25. Documentation/ARexxAPI/LISTSELECT
  26. Documentation/ARexxAPI/LISTUNFREEZE
  27. Documentation/ARexxAPI/MAILARCHIVE
  28. Documentation/ARexxAPI/MAILBOUNCE
  29. Documentation/ARexxAPI/MAILCHANGESUBJECT
  30. Documentation/ARexxAPI/MAILCHECK
  31. Documentation/ARexxAPI/MAILCOPY
  32. Documentation/ARexxAPI/MAILDELETE
  33. Documentation/ARexxAPI/MAILEDIT
  34. Documentation/ARexxAPI/MAILEXPORT
  35. Documentation/ARexxAPI/MAILFILTER
  36. Documentation/ARexxAPI/MAILFORWARD
  37. Documentation/ARexxAPI/MAILIMPORT
  38. Documentation/ARexxAPI/MAILINFO
  39. Documentation/ARexxAPI/MAILMOVE
  40. Documentation/ARexxAPI/MAILREAD
  41. Documentation/ARexxAPI/MAILREPLY
  42. Documentation/ARexxAPI/MAILSEND
  43. Documentation/ARexxAPI/MAILSENDALL
  44. Documentation/ARexxAPI/MAILSTATUS
  45. Documentation/ARexxAPI/MAILUPDATE
  46. Documentation/ARexxAPI/MAILWRITE
  47. Documentation/ARexxAPI/NEWMAILFILE
  48. Documentation/ARexxAPI/QUIT
  49. Documentation/ARexxAPI/READCLOSE
  50. Documentation/ARexxAPI/READINFO
  51. Documentation/ARexxAPI/READPRINT
  52. Documentation/ARexxAPI/READSAVE
  53. Documentation/ARexxAPI/REQUEST
  54. Documentation/ARexxAPI/REQUESTFILE
  55. Documentation/ARexxAPI/REQUESTFOLDER
  56. Documentation/ARexxAPI/REQUESTSTRING
  57. Documentation/ARexxAPI/RESTART
  58. Documentation/ARexxAPI/SCREENTOBACK
  59. Documentation/ARexxAPI/SCREENTOFRONT
  60. Documentation/ARexxAPI/SETFLAG
  61. Documentation/ARexxAPI/SETFOLDER
  62. Documentation/ARexxAPI/SETMAIL
  63. Documentation/ARexxAPI/SETMAILFILE
  64. Documentation/ARexxAPI/SHOW
  65. Documentation/ARexxAPI/USERINFO
  66. Documentation/ARexxAPI/WRITEATTACH
  67. Documentation/ARexxAPI/WRITEBCC
  68. Documentation/ARexxAPI/WRITECC
  69. Documentation/ARexxAPI/WRITEEDITOR
  70. Documentation/ARexxAPI/WRITEFROM
  71. Documentation/ARexxAPI/WRITEIDENTITY
  72. Documentation/ARexxAPI/WRITELETTER
  73. Documentation/ARexxAPI/WRITEMAILTO
  74. Documentation/ARexxAPI/WRITEOPTIONS
  75. Documentation/ARexxAPI/WRITEQUEUE
  76. Documentation/ARexxAPI/WRITEREPLYTO
  77. Documentation/ARexxAPI/WRITESEND
  78. Documentation/ARexxAPI/WRITESUBJECT
  79. Documentation/ARexxAPI/WRITETO

GETMAILINFO

NAME
GetMailInfo — Return information about the current message.
TEMPLATE
VAR/K,STEM/K,ITEM/A
FUNCTION
Returns information about the current message.
INPUTS
VAR/K - alternative variable to put the results into instead of RESULT (V2.0)
STEM/K- base name used for the stems where the returned data will be stored (V2.0)
ITEM/A - item to return info about, may be one of
  • ACT(IVE) - position (0 = first message in the folder)
  • STA(TUS) - status of the message, possible values are
    • N - new
    • O - read
    • U - unread
    • R - replied
    • F - forwarded
    • S - sent
    • W - pending
    • H - hold
    • E - error sending
  • FRO(M) - sender
  • TO - primary recipient
  • REP(LY) - return address; this will be either the first recipient in the "Reply-To:" header, or the first sender in the "From:" header if no "Reply-To:" header exists
  • SUB(JECT) - subject
  • FIL(E) - full path of the message file
RETURNS
VAR - info returned by the query
<STEM>VALUE - info returned by the query
NOTES
Superseded by MAILINFO in V2.0+. Don't use it in new scripts.
EXAMPLE
/* Enable result codes */
OPTIONS RESULTS

/* Request info */
GETMAILINFO ACTIVE VAR posi
GETMAILINFO STATUS VAR status
GETMAILINFO FROM VAR from
GETMAILINFO TO VAR to
GETMAILINFO REPLY VAR replyto
GETMAILINFO SUBJECT VAR subj
GETMAILINFO FILE VAR path

/* Display results */
SAY 'Position: 'posi
SAY 'Status:   'status
SAY 'From:     'from
SAY 'To:       'to
SAY 'Reply-To: 'replyto
SAY 'Subject:  'subj
SAY 'Path:     'path
BUGS
SEE ALSO
MAILINFO