wiki:Documentation/ARexxAPI/ADDREDIT

Version 4 (modified by damato, 9 months ago) (diff)

--

Languages:


ARexx API

    ADDREDIT

    NAME

    AddrEdit -- Fill in the fields of the current address book entry.

    (V2.0)

    TEMPLATE

    ALIAS,NAME,EMAIL,PGP,HOMEPAGE,STREET,CITY,COUNTRY,PHONE,COMMENT, BIRTHDATE/N,IMAGE,MEMBER/M,ADD/S

    FUNCTION

    Edits the fields of the current address book entry.

    INPUTS

    ALIAS - alias for the entry (upto 29 chars)
    NAME - real name for the entry (upto 39 chars)
    EMAIL - email address for the entry
    PGP - PGP ID for the entry (person only)
    HOMEPAGE - homepage for the entry (person only) (upto 231 chars)
    STREET - snail mail address of the entry (person only) (upto 79 chars)
    CITY - city for the entry (person only) (upto 79 chars)
    COUNTRY - country for the entry (person only) (upto 79 chars)
    PHONE - phone # for the entry (person only) (upto 79 chars)
    COMMENT - comment for the entry (up to 79 chars)
    BIRTHDATE/N - birthdate for a person in DDMMYYYY format, e.g. 13091969
    IMAGE - image filename for the entry (person only)
    MEMBER/M - use the argument(s) to edit a member list
    ADD/S - combined with 'member', adds new members to a distribution list, instead of replacing the old member info

    RETURNS

    RC is set 10 if no entry is currently selected in the address book.

    NOTES

    Arguments longer than the available space are simply truncated.

    EXAMPLE

    /* Enable result codes */
    OPTIONS RESULTS
    
    /* Select an entry */
    ADDRGOTO YAM_ml
    
    /* Edit this entry */
    'ADDREDIT EMAIL "yam@freelists.org" COMMENT "The place to be"'
    
    /* Select a distribution list */
    ADDRGOTO blacklisted
    
    /* Reset the list */
    ADDREDIT MEMBER 'bill'
    
    /* Add a couple of members */
    ADDREDIT MEMBER 'jobs@example.com' MEMBER 'smith@example.net' ADD
    

    BUGS

    Even if a group or person is selected, MEMBER [ADD] will return success (0).

    Entering nonsense data as birth date or editing a distribution list would throw Enforcer hits; this was fixed in V2.4.

    SEE ALSO