wiki:Documentation/ARexxAPI/ADDRINFO

Version 6 (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

ADDRINFO

NAME
AddrInfo — Return information about an address book entry. (V2.0)
TEMPLATE
VAR/K,STEM/K,ALIAS/A
FUNCTION
Returns information about an address book entry.
INPUTS
VAR/K - variable to store the results of the query
STEM/K - base name used for the stems where the returned data will be stored
ALIAS/A - alias of the entry to return info about
RETURNS
<STEM>TYPE - type of entry, may be one of P (person), L (distribution list) or G (group)
<STEM>NAME - real name of this entry
<STEM>EMAIL - email address of this entry
<STEM>PGP - PGP key ID of this entry
<STEM>HOMEPAGE - homepage of this entry
<STEM>STREET - street address of this entry
<STEM>CITY - city for this entry
<STEM>COUNTRY - country for this entry
<STEM>PHONE - phone # of this entry
<STEM>COMMENT - comment stored with this entry
<STEM>BIRTHDATE - date of birth of this entry, in (D)DMMYYYY format
<STEM>IMAGE - filename with the portrait picture of this entry
<STEM>MEMBERS.COUNT - number of members, if the entry is actually a distribution list
<STEM>MEMBERS.NR - the nth member if the entry is actually a distribution list, NR being a number between 0 and n-1

RC is set to 10 if the supplied alias does not exist or none was provided.

NOTES
Fields where information is not available are returned as an empty string, except for the birth date which is returned as a literal zero (0).
EXAMPLE
/* Enable result codes */
OPTIONS RESULTS

/* Ignore possible error from ADDRINFO */
OPTIONS FAILAT 11

/* Find a given entry */
ADDRINFO 'mars' STEM st.

/* List results */
IF RC ~= 0 THEN EXIT

SAY 'Type of entry: 'st.type
SAY 'Real name:     'st.name
SAY 'Email address: 'st.email
SAY 'PGP key ID:    'st.pgp
SAY 'Homepage:      'st.homepage
SAY 'Street:        'st.street
SAY 'City:          'st.city
SAY 'Country:       'st.country
SAY 'Phone #:       'st.phone
SAY 'Description:   'st.comment
SAY 'Date of birth: 'st.birthdate
SAY 'Portrait:      'st.image
BUGS
SEE ALSO