home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / NDK / NDK_3.5 / Documentation / Autodocs / aml.doc < prev    next >
Encoding:
Text File  |  1999-10-12  |  40.7 KB  |  1,619 lines
  1. aml.library/AddArticlePartA                       aml.library/AddArticlePartA
  2.  
  3. NAME
  4.     AddArticlePartA -- Add a part to an article
  5.     AddArticlePart -- Varargs stub for AddArticlePartA
  6.  
  7. SYNOPSIS
  8.     success = AddArticlePartA(article, part, tags)
  9.     D0                    A0         A1       A2
  10.  
  11.     BOOL AddArticlePartA(APTR article, APTR part, struct TagItem *tags);
  12.  
  13.     BOOL AddArticlePart(APTR article, APTR part, ULONG tag1, ...);
  14.  
  15. FUNCTION
  16.     Adds a previously allocated article part to the specified
  17.     article.  Parts added are always in order of addition, which is
  18.     how the resulting article will be built.
  19.  
  20.     Note that at least one part must be added to the article, which
  21.     is normally considered the main body of the article.
  22.  
  23. INPUTS
  24.     article - Pointer to an article object
  25.     part - Pointer to an article part object
  26.     tags - An array of TagItems
  27.  
  28. TAGS
  29.     See SetArticlePartDataA().
  30.  
  31. RETURNS
  32.     success - 1 if successful, 0 otherwise.
  33.  
  34. SEE ALSO
  35.     RemArticlePart()
  36.  
  37. aml.library/AddCustomField                         aml.library/AddCustomField
  38.  
  39. NAME
  40.     AddCustomField -- Add a custom data field to an address
  41.         entry object
  42.  
  43. SYNOPSIS
  44.     success = AddCustomField(addr, field, data)
  45.     D0                    A0     A1        A2
  46.  
  47.     BOOL AddCustomField(APTR addr, STRPTR field, STRPTR data);
  48.  
  49. FUNCTION
  50.     Adds the specified data, which currently must be a string,
  51.     to the address entry object, identifiable by the field name.
  52.     Field names must be unique.
  53.  
  54. RETURNS
  55.     success - 1 if successful, 0 otherwise.
  56.  
  57. SEE ALSO
  58.     RemCustomField(), GetCustomFieldData()
  59.  
  60. aml.library/AddFolderArticle                     aml.library/AddFolderArticle
  61.  
  62. NAME
  63.     AddFolderArticle -- Adds an article to a folder
  64.  
  65. SYNOPSIS
  66.     success = AddFolderArticle(folder, type, data)
  67.     D0                        A0     D0     A1
  68.  
  69.     BOOL AddFolderArticle(APTR folder, ULONG type, APTR data);
  70.  
  71. FUNCTION
  72.     This function attempts to add the the specified article
  73.     to the folder.
  74.  
  75.     The type parameter specifies how the article data will
  76.     be interpreted.  The following values are valid:
  77.  
  78.         ARTICLE_TYPE_FILE - data is a filename of
  79.             an RFC822/MIME formatted message.
  80.         ARTICLE_TYPE_ARTICLE - data is a pointer to
  81.             an allocated article object.
  82.         ARTICLE_TYPE_BUFFER - data is a pointer to a
  83.             buffer, which contains an RFC822/MIME
  84.             style message.
  85.  
  86. INPUTS
  87.     folder - Pointer to a folder object
  88.     type - One of the types listed above
  89.     data - Pointer to the article data
  90.  
  91. RETURNS
  92.     success - 1 if successful, 0 otherwise
  93.  
  94. SEE ALSO
  95.     RemFolderArticle()
  96.  
  97. aml.library/CreateAddressEntryA               aml.library/CreateAddressEntryA
  98.  
  99. NAME
  100.     CreateAddressEntryA -- Create a new address entry object.
  101.     CreateAddressEntry -- Varargs stub for CreateAddressEntryA
  102.  
  103. SYNOPSIS
  104.     addr = CreateAddressEntryA(tags)
  105.     D0                      A0
  106.  
  107.     APTR CreateAddressEntryA(struct TagItem *tags);
  108.  
  109.     APTR CreateAddressEntry(ULONG tag1, ...);
  110.  
  111. FUNCTION
  112.     Creates a new address entry object, and fills in the appropriate
  113.     fields with the provided data.
  114.  
  115. INPUTS
  116.     tags - Pointer to an array of TagItems.
  117.  
  118. TAGS
  119.     See SetAddressEntryAttrsA() for a description of valid tags.
  120.  
  121. RETURNS
  122.     addr - A pointer to a new address entry object.
  123.  
  124. SEE ALSO
  125.     DisposeAddressEntry()
  126.  
  127. aml.library/CreateArticleA                         aml.library/CreateArticleA
  128.  
  129. NAME
  130.     CreateArticleA -- Creates an article object
  131.     CreateArticle -- Varargs stub for CreateArticleA
  132.  
  133. SYNOPSIS
  134.     article = CreateArticleA(folder, tags)
  135.     D0                    A0     A1
  136.  
  137.     APTR CreateArticleA(APTR folder, struct TagItem *)
  138.  
  139.     APTR CreateArticle(APTR folder, ULONG, ...)
  140.  
  141. FUNCTION
  142.     Creates an article object.  This object is used to create
  143.     an e-mail message, newsgroup article or whatever.  Every
  144.     article must have at least one ArticlePart object, which is
  145.     allocated with the CreateArticlePart() function, and
  146.     added to the article with the AddArticlePartA() function.
  147.  
  148. INPUTS
  149.     folder - Folder object to which the new article will
  150.         belong
  151.     tags - Array of TagItems to set attributes for the new
  152.         article
  153.  
  154. RETURNS
  155.     article = Pointer to an article object
  156.  
  157. SEE ALSO
  158.     DisposeArticle, CreateArticlePart,
  159.     AddArticlePartA
  160.  
  161. aml.library/CreateArticlePartA                 aml.library/CreateArticlePartA
  162.  
  163. NAME
  164.     CreateArticlePartA -- Creates a new part object
  165.     CreateArticlePart -- Varargs stub for CreateArticlePartA
  166.  
  167. SYNOPSIS
  168.     part = CreateArticlePartA(article, tags)
  169.     D0                     A0         A1
  170.  
  171.     APTR CreateArticlePartA(APTR aritcle, struct TagItem *tags);
  172.  
  173.     APTR CreateArticlePart(APTR article, ULONG tag1, ...);
  174.  
  175. FUNCTION
  176.  
  177. INPUTS
  178.  
  179. TAGS
  180.  
  181. RETURNS
  182.  
  183. SEE ALSO
  184.     DisposeArticlePart()
  185.  
  186. aml.library/CreateDecoderA                         aml.library/CreateDecoderA
  187.  
  188. NAME
  189.     CreateDecoderA -- Creates a de/encoder object
  190.     CreateDecoder -- Varargs stub for CreateDecoderA
  191.  
  192. SYNOPSIS
  193.     decoder = CreateDecoderA(tags)
  194.     D0                    A0
  195.  
  196.     APTR CreateDecoderA(struct TagItem *tags);
  197.  
  198.     APTR CreateDecoder(ULONG tag1, ...);
  199.  
  200. FUNCTION
  201.     Creates a decoder/encoder object for use with
  202.     encoding or decoding a stream or buffer of
  203.     data.
  204.  
  205. INPUTS
  206.     tags - An array of TagItems.
  207.  
  208. TAGS
  209.     See SetDecoderAttrsA() for details.
  210.  
  211. RETURNS
  212.     decoder - Pointer to a decoder/encoder object
  213.  
  214. SEE ALSO
  215.     DisposeDecoder(), SetDecoderAttrsA(), Decode(), Encode()
  216.  
  217. aml.library/CreateFolderA                           aml.library/CreateFolderA
  218.  
  219. NAME
  220.     CreateFolderA -- Create a folder object
  221.     CreateFolder -- Varargs stub for CreateFolderA
  222.  
  223. SYNOPSIS
  224.     folder = CreateFolderA(server, tags)
  225.     D0                    A0     A1
  226.  
  227.     APTR CreateFolderA(APTR server, struct TagItem *tags);
  228.  
  229.     APTR CreateFolder(APTR server, ULONG tag1, ...);
  230.  
  231. FUNCTION
  232.     This function creates a new folder object for storing
  233.     article objects.
  234.  
  235. INPUTS
  236.     server - The server object, such as a POP server, to
  237.         associate with this object.  One server can be
  238.         assigned to multiple folder objects.  The server
  239.         object MUST remain valid for the life of the
  240.         folder object.
  241.     tags - An array of TagItems
  242.  
  243. TAGS
  244.     See SetFolderAttrsA() for details.
  245.  
  246. RETURNS
  247.     folder - Pointer to a folder object
  248.  
  249. SEE ALSO
  250.     DisposeFolder(), SetFolderAttrsA()
  251.  
  252. aml.library/CreateServerA                           aml.library/CreateServerA
  253.  
  254. NAME
  255.     CreateServerA -- Create a server object
  256.     CreateServer -- Varargs stub for CreateServerA
  257.  
  258. SYNOPSIS
  259.     server = CreateServerA(tags)
  260.     D0                    A0
  261.  
  262.     APTR CreateServerA(struct TagItem *tags);
  263.  
  264.     APTR CreateServer(ULONG tag1, ...);
  265.  
  266. FUNCTION
  267.     This function creates a new server object, for use
  268.     as a POP or SMTP server, an address book, or whatever
  269.     else.
  270.  
  271.     Note that when using a server object with folders or
  272.     address entries, the server must remain valid for the life
  273.     of the associated object.
  274.  
  275. INPUTS
  276.     tags - An array of TagItems
  277.  
  278. TAGS
  279.     See SetServerAttrsA() for details.
  280.  
  281. RETURNS
  282.     server - Pointer to a server object
  283.  
  284. SEE ALSO
  285.     DisposeServer(), SetServerAttrsA()
  286.  
  287. aml.library/Decode                                         aml.library/Decode
  288.  
  289. NAME
  290.     Decode -- Decode a stream/buffer
  291.  
  292. SYNOPSIS
  293.     length = Decode(decoder, type)
  294.     D0                A0     A1
  295.  
  296.     LONG Decode(APTR decoder, ULONG type);
  297.  
  298. FUNCTION
  299.     Decodes data from a input stream or buffer to
  300.     an output stream or buffer.  The corresponding
  301.     stream/buffer must be set up when the decoder is
  302.     created via CreateDecoderA().
  303.  
  304. INPUTS
  305.     decoder - Pointer to a decoder object.
  306.     type - One of the following values, that specifies
  307.         how to decode the input stream/buffer:
  308.  
  309.         DECODE_COPY - Do nothing to the stream.
  310.         DECODE_QP - Decode the stream as quoted-printable
  311.             data.  See the MIME RFCs for details.
  312.         DECODE_B64 - Decode the stream as base64.
  313.         DECODE_UU - Decode the stream as uuencoded.
  314.         DECODE_ROT - Decode the stream as ROT-13 style.
  315.  
  316. RETURNS
  317.     length - The resulting length of the output stream or
  318.         buffer.
  319.  
  320. SEE ALSO
  321.     CreateDecoderA()
  322.  
  323. aml.library/DisposeAddressEntry               aml.library/DisposeAddressEntry
  324.  
  325. NAME
  326.     DisposeAddressEntry -- Frees an address entry object.
  327.  
  328. SYNOPSIS
  329.     success = DisposeAddressEntry(addr)
  330.     D0                        A0
  331.  
  332.     BOOL DisposeAddressEntry(APTR addr);
  333.  
  334. FUNCTION
  335.     Frees the address entry object and any associated memory or
  336.     resources.
  337.  
  338. INPUTS
  339.     addr - The address entry to dispose.
  340.  
  341. RETURNS
  342.     success - If the address entry object was successfully
  343.         disposed.
  344.  
  345. SEE ALSO
  346.     CreateAddressEntryA()
  347.  
  348. aml.library/DisposeArticle                         aml.library/DisposeArticle
  349.  
  350. NAME
  351.     DisposeArticle -- Free an article object
  352.  
  353. SYNOPSIS
  354.     success = DisposeArticle(article)
  355.     D0                    A0
  356.  
  357.     BOOL DisposeArticle(APTR article);
  358.  
  359. FUNCTION
  360.     Free the article object and any associated data.
  361.  
  362. INPUTS
  363.     article - Pointer to an article object
  364.  
  365. RETURNS
  366.     success - 1 if successful, 0 otherwise.
  367.  
  368. SEE ALSO
  369.     CreateArticleA(), OpenArticle()
  370.  
  371. aml.library/DisposeArticlePart                 aml.library/DisposeArticlePart
  372.  
  373. NAME
  374.     DisposeArticlePart -- Frees an article part
  375.  
  376. SYNOPSIS
  377.     DisposeArticlePart(part)
  378.                     A0
  379.  
  380.     void DisposeArticlePart(APTR part);
  381.  
  382. FUNCTION
  383.     Frees the part object and any associated resources.
  384.     Note that the part must have already been removed from an
  385.     article's list with RemArticlePart() before disposing it.
  386.  
  387. INPUTS
  388.     part - Pointer to a part object
  389.  
  390. SEE ALSO
  391.     CreateArticlePartA()
  392.  
  393. aml.library/DisposeDecoder                         aml.library/DisposeDecoder
  394.  
  395. NAME
  396.     DisposeDecoder -- Frees a decoder object
  397.  
  398. SYNOPSIS
  399.     DisposeDecoder(decoder)
  400.                 A0
  401.  
  402.     void DisposeDecoder(APTR decoder);
  403.  
  404. FUNCTION
  405.     Frees the specified decoder object and any associated
  406.     resources.
  407.  
  408. INPUTS
  409.     decoder - Pointer to a decoder object to free.
  410.  
  411. SEE ALSO
  412.     CreateDecoderA()
  413.  
  414. aml.library/DisposeFolder                           aml.library/DisposeFolder
  415.  
  416. NAME
  417.     DisposeFolder -- Frees a folder object
  418.  
  419. SYNOPSIS
  420.     success = DisposeFolder(folder)
  421.     D0                    A0
  422.  
  423.     BOOL DisposeFolder(APTR folder);
  424.  
  425. FUNCTION
  426.     This function frees the folder object and any
  427.     associated resources.
  428.  
  429. INPUTS
  430.     folder - Pointer to a folder object
  431.  
  432. RETURNS
  433.     success - 1 if successful, 0 otherwise
  434.  
  435. SEE ALSO
  436.     CreateFolderA(), OpenFolderA()
  437.  
  438. aml.library/DisposeServer                           aml.library/DisposeServer
  439.  
  440. NAME
  441.     DisposeServer -- Frees a server object
  442.  
  443. SYNOPSIS
  444.     DisposeServer(server);
  445.                 A0
  446.  
  447.     void DisposeServer(APTR server);
  448.  
  449. FUNCTION
  450.     This function frees the server object and any associated
  451.     resources.
  452.  
  453. INPUTS
  454.     server - Pointer to a server object to free
  455.  
  456. SEE ALSO
  457.     CreateServerA()
  458.  
  459. aml.library/Encode                                         aml.library/Encode
  460.  
  461. NAME
  462.     Encode -- Encode a stream/buffer
  463.  
  464. SYNOPSIS
  465.     length = Encode(encoder, type)
  466.     D0                A0     A1
  467.  
  468.     LONG Encode(APTR encoder, ULONG type);
  469.  
  470. FUNCTION
  471.     Encodes data from a input stream or buffer to
  472.     an output stream or buffer.  The corresponding
  473.     stream/buffer must be set up when the encoder is
  474.     created via CreateDecoderA().
  475.  
  476. INPUTS
  477.     encoder - Pointer to a encoder object.
  478.     type - One of the following values, that specifies
  479.         how to encode the input stream/buffer:
  480.  
  481.         ENCODE_COPY - Do nothing to the stream.
  482.         ENCODE_QP - Encode the stream as quoted-printable
  483.             data.  See the MIME RFCs for details.
  484.         ENCODE_B64 - Encode the stream as base64.
  485.         ENCODE_UU - Encode the stream as uuencoded.
  486.         ENCODE_ROT - Encode the stream as ROT-13 style.
  487.  
  488. RETURNS
  489.     length - The resulting length of the output stream or
  490.         buffer.
  491.  
  492. SEE ALSO
  493.     CreateDecoderA()
  494.  
  495. aml.library/ExpungeFolder                           aml.library/ExpungeFolder
  496.  
  497. NAME
  498.     ExpungeFolder -- Deletes a folder and its contents.
  499.  
  500. SYNOPSIS
  501.     value = ExpungeFolder(folder, trash, hook)
  502.     D0                    A0     A1      A2
  503.  
  504.     LONG ExpungeFolder(APTR folder, APTR trash, struct Hook *hook);
  505.  
  506. FUNCTION
  507.     This function will delete the entire contents of the
  508.     specified folder, including indexing and folder information.
  509.     The provided hook will be called for each article item
  510.     deleted, to allow for progress displays and such.  If the trash
  511.     argument is provided, it must be a pointer to another folder
  512.     object to act as a Trash folder, in which the "deleted"
  513.     articles will be placed.
  514.  
  515. INPUTS
  516.     folder - Pointer to a folder object
  517.     trash - Optional pointer to a folder object to
  518.         act as trash
  519.     hook - Pointer to a hook, data is a struct FolderIndex pointer.
  520.  
  521. RETURNS
  522.     value - The number of articles deleted from the folder.
  523.  
  524. aml.library/FindAddressEntryA                   aml.library/FindAddressEntryA
  525.  
  526. NAME
  527.     FindAddressEntryA -- Searches an addressbook for an address entry.
  528.     FindAddressEntry -- Varargs stub for FindAddressEntryA
  529.  
  530. SYNOPSIS
  531.     addr = FindAddressEntryA(server, tags)
  532.     D0                    A0         A1
  533.  
  534.     APTR FindAddressEntryA(APTR server, struct TagItem *tags);
  535.  
  536.     APTR FindAddressEntry(APTR server, ULONG tag1, ...);
  537.  
  538. FUNCTION
  539.     Searches the address book server specified for an address
  540.     entry matching the criteria provided.  This function only
  541.     returns the FIRST matching address object.  Use
  542.     HuntAddressEntryA() to match against ALL possible address
  543.     entry objects.
  544.  
  545. INPUTS
  546.     server - Pointer to an address book server to search
  547.     tags - An array of TagItems that specify the match criteria
  548.  
  549. TAGS
  550.     See SetAddressEntryAttrsA() for a description of valid
  551.     tags that may be used.  Also:
  552.  
  553.     ADDRESSA_PartialMatch (BOOL) - Lets the match routine know
  554.         whether it should match the entire field against the
  555.         match criteria data.
  556.  
  557. RETURNS
  558.     addr - Pointer to the matching address entry object, or NULL
  559.         if no match was found.  This object is allocated, and
  560.         must be properly disposed via DisposeAddressEntry().
  561.  
  562. SEE ALSO
  563.     HuntAddressEntryA(), CreateServerA(), DisposeAddressEntry()
  564.  
  565. aml.library/GetAddressEntryAttrsA           aml.library/GetAddressEntryAttrsA
  566.  
  567. NAME
  568.     GetAddressEntryAttrsA -- Get attributes of an address entry object
  569.     GetAddressEntryAttrs -- Varargs stub for GetAddressEntryAttrsA
  570.  
  571. SYNOPSIS
  572.     value = GetAddressEntryAttrsA(addr, tags)
  573.     D0                        A0     A1
  574.  
  575.     ULONG GetAddressEntryAttrsA(APTR addr, struct TagItem *tags);
  576.  
  577.     ULONG GetAddressEntryAttrs(APTR addr, ULONG tag1, ...);
  578.  
  579. FUNCTION
  580.     Gets the requested attributes from the specified
  581.     address entry object.
  582.  
  583. INPUTS
  584.     addr - A pointer to a previously-created address entry object.
  585.     tags - Pointer to an array of TagItems.
  586.  
  587. TAGS
  588.     See SetAddressEntryAttrsA() for description of the tags.  Also:
  589.  
  590.     ADDRESSA_EntryID (LONG) - Record number of this address entry.
  591.  
  592. RETURNS
  593.     value - The number of attributes successfully gotten.
  594.  
  595. SEE ALSO
  596.     SetAddressEntryAttrsA()
  597.  
  598. aml.library/GetArticleAttrsA                     aml.library/GetArticleAttrsA
  599.  
  600. NAME
  601.     GetArticleAttrsA -- Get article attributes
  602.     GetArticleAttrs -- Varargs stub for GetArticleAttrsA
  603.  
  604. SYNOPSIS
  605.     value = GetArticleAttrsA(article, tags)
  606.     D0                    A0         A1
  607.  
  608.     ULONG GetArticleAttrsA(APTR article, struct TagItem *)
  609.  
  610.     ULONG GetArticleAttrs(APTR article, ULONG, ...)
  611.  
  612. FUNCTION
  613.     Gets attributes of the specified article object.
  614.  
  615. INPUTS
  616.     article - The article object to query
  617.     tags - An array of TagItems
  618.  
  619. TAGS
  620.     See SetArticleAttrsA().
  621.  
  622. RETURNS
  623.     value - The number of attributes successfully queried.
  624.  
  625. aml.library/GetArticlePartDataA               aml.library/GetArticlePartDataA
  626.  
  627. NAME
  628.     GetArticlePartDataA -- Gets the data for the specified part
  629.     GetArticlePartData -- Varargs stub for GetArticlePartDataA
  630.  
  631. SYNOPSIS
  632.     success = GetArticlePartDataA(article, part, tags)
  633.     D0                        A0         A1      A2
  634.  
  635.     BOOL GetArticlePartDataA(APTR article, APTR part, struct TagItem *tags);
  636.  
  637.     BOOL GetArticlePartData(APTR article, APTR part, ULONG tag1, ...);
  638.  
  639. FUNCTION
  640.     Gets the data for the part object.  Pass in one of the appropriate
  641.     tag values for the type of buffer/file to store the data in, and the
  642.     part's data will be placed there.
  643.  
  644. INPUTS
  645.     article - Pointer to an article object
  646.     part - Pointer to a part object
  647.     tags - An array of TagItems
  648.  
  649. TAGS
  650.     See SetArticlePartDataA()
  651.  
  652. RETURNS
  653.     success - 1 if successful, 0 otherwise.
  654.  
  655. SEE ALSO
  656.     SetArticlePartDataA()
  657.  
  658. aml.library/GetCustomFieldData                 aml.library/GetCustomFieldData
  659.  
  660. NAME
  661.     GetCustomFieldData -- Returns the data assigned to a custom
  662.         address entry field
  663.  
  664. SYNOPSIS
  665.     data = GetCustomFieldData(addr, field)
  666.     D0                     A0     A1
  667.  
  668.     APTR GetCustomFieldData(APTR addr, STRPTR field);
  669.  
  670. FUNCTION
  671.     Retrieves the data associated with a custom field
  672.     previously added to the address entry object.
  673.  
  674. INPUTS
  675.     addr - Pointer to an address entry object.
  676.     field - Name of field to get data
  677.  
  678. RETURNS
  679.     data - Pointer to the data for the requested field.
  680.  
  681. SEE ALSO
  682.     AddCustomField(), RemCustomField()
  683.  
  684. aml.library/GetDecoderAttrsA                     aml.library/GetDecoderAttrsA
  685.  
  686. NAME
  687.     GetDecoderAttrsA -- Set object attributes for a decoder/encoder
  688.         object
  689.     GetDecoderAttrsA -- Varargs stub for GetDecoderAttrsA
  690.  
  691. SYNOPSIS
  692.     value = GetDecoderAttrsA(decoder, tags)
  693.     D0                    A0         A1
  694.  
  695.     ULONG GetDecoderAttrsA(APTR decoder, struct TagItem *);
  696.  
  697.     ULONG GetDecoderAttrs(APTR decoder, ULONG tag1, ...);
  698.  
  699. FUNCTION
  700.     Gets attributes of the specified decoder/encoder object.
  701.  
  702. INPUTS
  703.     decoder - Pointer to a decoder/encoder object
  704.     tags - An array of TagItems.
  705.  
  706. TAGS
  707.     The only valid gettable tags are:  DECODERA_DestHandle,
  708.         DECODERA_DestFile, DECODERA_DestBuffer,
  709.         DECODERA_DestLen, DECODERA_Lines
  710.  
  711.     See SetDecoderAttrsA() for details.
  712.  
  713. RETURNS
  714.     value - Number of attributes successfully gotten.
  715.  
  716. SEE ALSO
  717.     SetDecoderAttrsA(), CreateDecoderA()
  718.  
  719. aml.library/GetFolderAttrsA                       aml.library/GetFolderAttrsA
  720.  
  721. NAME
  722.     GetFolderAttrsA -- Get attributes for a folder object
  723.     GetFolderAttrs -- Varargs stub for GetFolderAttrsA
  724.  
  725. SYNOPSIS
  726.     value = GetFolderAttrsA(folder, tags)
  727.     D0                    A0      A1
  728.  
  729.     ULONG GetFolderAttrsA(APTR folder, struct TagItem *tags);
  730.  
  731.     ULONG GetFolderAttrs(APTR folder, ULONG tag1, ...);
  732.  
  733. FUNCTION
  734.     Gets the requested attributes of a folder object.
  735.  
  736. INPUTS
  737.     folder - Pointer to a folder object
  738.     tags - An array of TagItems
  739.  
  740. TAGS
  741.     Set SetFolderAttrsA() for details.  The following tags
  742.     are gettable only:
  743.  
  744.         FOLDERA_Created (ULONG) - When the folder was created.
  745.         FOLDERA_Accessed (ULONG) - When the folder was
  746.             last accessed.
  747.         FOLDERA_MsgCount (ULONG) - The number of articles
  748.             in the folder.
  749.         FOLDERA_NumRead (ULONG) - The number of articles
  750.             in the folder that have been read, i.e., don't
  751.             have the NEW or UNREAD status set.
  752.         FOLDERA_LastRead (ULONG) - The ordinal number of
  753.             the last read article.
  754.  
  755. RETURNS
  756.     value - The number of attributes successfully gotten.
  757.  
  758. SEE ALSO
  759.     SetFolderAttrsA()
  760.  
  761. aml.library/GetServerArticles                   aml.library/GetServerArticles
  762.  
  763. NAME
  764.     GetServerArticles -- Get articles from a server
  765.  
  766. SYNOPSIS
  767.     value = GetServerArticles(server, incoming, hook, flags);
  768.     D0                     A0        A1        A2    D0
  769.  
  770.     LONG GetServerArticles(APTR server, APTR incoming,
  771.             struct Hook *hook, ULONG flags);
  772.  
  773. FUNCTION
  774.     This function tells the server to retrieve its
  775.     articles.
  776.  
  777.     If a hook is provided, it will be called for each article
  778.     retrieved, with the server object passed in A2 and an
  779.     ArticleDisposition structure in A1.  This gives the
  780.     application a chance to parse the article and determine its
  781.     final destination, by setting the ad_Folder pointer.  If this
  782.     pointer is NULL, or no hook is provided, the folder object
  783.     specified by incoming will be used as the destination.  If
  784.     that is not provided, the article is discarded.
  785.  
  786. INPUTS
  787.     server - Pointer to a server object
  788.     incoming - Pointer to the default incoming folder object
  789.     hook - A hook used for progress callbacks
  790.     flags - One or more of the following:
  791.  
  792.         SF_USESPOOL   - Receive messages to server spool vs. folder.
  793.         SF_DELARTICLE - Delete articles from the server
  794.             after successful retrieval.
  795.         SF_BYPASSHOOK - Don't use the progress hook.
  796.  
  797. RETURNS
  798.     value - 0 for success, -1 or a DOS error code for failure
  799.  
  800. SEE ALSO
  801.     GetServerHeaders(), CreateServerA()
  802.  
  803. aml.library/GetServerAttrsA                       aml.library/GetServerAttrsA
  804.  
  805. NAME
  806.     GetServerAttrsA -- Get attributes on a server object
  807.     GetServerAttrs -- Varargs stub for GetServerAttrs
  808.  
  809. SYNOPSIS
  810.     value = GetServerAttrsA(server, tags);
  811.     D0                    A0       A1
  812.  
  813.     ULONG GetServerAttrsA(APTR server, struct TagItem *tags);
  814.  
  815.     ULONG GetServerAttrs(APTR server, ULONG tag1, ...);
  816.  
  817. FUNCTION
  818.     This function allows you to query attributes of a server
  819.     object.
  820.  
  821. INPUTS
  822.     server - Pointer to a server object to query
  823.     tags - An array of TagItems
  824.  
  825. TAGS
  826.     See SetServerAttrsA() for details.
  827.  
  828. RETURNS
  829.     value - The number of attributes successfully gotten.
  830.  
  831. SEE ALSO
  832.     CreateServerA(), SetServerAttrsA()
  833.  
  834. aml.library/GetServerHeaders                     aml.library/GetServerHeaders
  835.  
  836. NAME
  837.     GetServerHeaders -- Gets the article headers for a server
  838.  
  839. SYNOPSIS
  840.     value = GetServerHeaders(server, flags)
  841.     D0                    A0         A1
  842.  
  843.     ULONG GetServerHeaders(APTR server, ULONG flags);
  844.  
  845. FUNCTION
  846.     This function tells the server to retrieve the
  847.     headers of the specified server.
  848.  
  849.     Valid flag values are:
  850.  
  851.     SF_BYPASSHOOK - Avoid using the server's
  852.         progress hook.
  853.     SF_DELARTICLE - Delete articles off the server
  854.         if it was successfully retrieved.
  855.  
  856. INPUTS
  857.     server - Pointer to a server object
  858.     flags - See <libraries/aml.h> for valid flags
  859.  
  860. RETURNS
  861.     value - 0 for success, -1 or a DOS error code
  862.         for failure.
  863.  
  864. SEE ALSO
  865.     CreateServerA()
  866.  
  867. aml.library/HuntAddressEntryA                   aml.library/HuntAddressEntryA
  868.  
  869. NAME
  870.     HuntAddressEntryA -- Search for possible matching address entry
  871.         objects
  872.     HuntAddressEntry -- Varargs stub for HuntAddressEntryA
  873.  
  874. SYNOPSIS
  875.     addr = HuntAddressEntryA(server, tags)
  876.     D0                    A0         A1
  877.  
  878.     APTR HuntAddressEntryA(APTR server, struct TagItem *tags);
  879.  
  880.          APTR HuntAddressEntry(APTR server, ULONG tag1, ...);
  881.  
  882. FUNCTION
  883.     Searches the address book server specified for an address
  884.     entry matching the criteria provided.  This function returns,
  885.     one per iteration, a matching address entry object.  Call
  886.     HuntAddressEntryA() repeatedly to get each possible matching
  887.     address entry object.  Returns NULL when no more matches are
  888.     found.
  889.  
  890. TAGS
  891.     See FindAddressEntryA() for details
  892.  
  893. RETURNS
  894.     addr - Pointer to an address entry object, or NULL for
  895.         no (more) match(es) found.  This is an allocated object,
  896.         and must be disposed properly via DisposeAddressEntry().
  897.  
  898. SEE ALSO
  899.     FindAddressEntryA(), DisposeAddressEntry()
  900.  
  901. aml.library/OpenAddressEntry                     aml.library/OpenAddressEntry
  902.  
  903. NAME
  904.     OpenAddressEntry -- Open an existing address entry
  905.  
  906. SYNOPSIS
  907.     addr = OpenAddressEntry(server, id)
  908.     D0                    A0       A1
  909.  
  910.     APTR OpenAddressEntry(APTR server, ULONG id);
  911.  
  912. FUNCTION
  913.     Opens the specified address entry from a server.
  914.  
  915. INPUTS
  916.     server - Pointer to a server object
  917.     id - Ordinal number of the address entry object
  918.         to open, starting at 0.
  919.  
  920. RETURNS
  921.     addr - Pointer to an address entry object.  This object
  922.         is allocated, and must be properly disposed via
  923.         DisposeAddressEntry().
  924.  
  925. SEE ALSO
  926.     CreateAddressEntryA(), DisposeAddressEntry()
  927.  
  928. aml.library/OpenArticle                               aml.library/OpenArticle
  929.  
  930. NAME
  931.     OpenArticle -- Opens an existing article from disk or a server
  932.  
  933. SYNOPSIS
  934.     article = OpenArticle(server, folder, msgid, flags)
  935.     D0                    A0     A1       A2       A3
  936.  
  937.     APTR OpenArticle(APTR server, APTR folder, ULONG msgid,
  938.         ULONG flags)
  939.  
  940. FUNCTION
  941.     Opens an existing article from disk or a server, depending
  942.     on the type of server passed in.  Currently, the only server
  943.     type supported is POP3.  This function only retrieves header
  944.     information for the article in question, as well as a breakdown
  945.     of the parts of the article.  To get actual data for each part,
  946.     consult the appropriate article part function.
  947.  
  948. INPUTS
  949.     server - Pointer to a server object from which to retrieve
  950.         the article
  951.     folder - Pointer to a folder object which contains the article
  952.     msgid - The numeric ID of the message on the server
  953.     flags - Flags to control how the message is retrieve.  Should be
  954.         set to 0 for now.
  955.  
  956. RETURNS
  957.     article - Pointer to an article object
  958.  
  959. SEE ALSO
  960.     DisposeArticle, GetArticlePart, GetArticlePartData
  961.  
  962. aml.library/OpenFolderA                               aml.library/OpenFolderA
  963.  
  964. NAME
  965.     OpenFolderA -- Open an existing folder
  966.     OpenFolder -- Varargs stub for CreateFolderA
  967.  
  968. SYNOPSIS
  969.     folder = OpenFolderA(server, tags)
  970.     D0                    A0     A1
  971.  
  972.     APTR OpenFolderA(APTR server, struct TagItem *tags);
  973.  
  974.     APTR OpenFolder(APTR server, ULONG tag1, ...);
  975.  
  976. FUNCTION
  977.     Basically the same as CreateFolderA(), but this
  978.     function opens an existing folder.
  979.  
  980. INPUTS
  981.     server - The server object, such as a POP server, to
  982.         associate with this object.  One server can be
  983.         assigned to multiple folder objects.  The server
  984.         object MUST remain valid for the life of the
  985.         folder object.
  986.     tags - An array of TagItems
  987.  
  988. TAGS
  989.     See SetFolderAttrsA() for details.
  990.  
  991. RETURNS
  992.     folder - Pointer to a folder object
  993.  
  994. SEE ALSO
  995.     DisposeFolder(), SetFolderAttrsA
  996.  
  997. aml.library/ReadFolderSpool                       aml.library/ReadFolderSpool
  998.  
  999. NAME
  1000.     ReadFolderSpool -- Reads a spool file into the folder
  1001.  
  1002. SYNOPSIS
  1003.     count = ReadFolderSpool(folder, importfile, flags)
  1004.     D0                    A0         A1        DO
  1005.  
  1006.     ULONG ReadFolderSpool(APTR folder, STRPTR importfile, ULONG flags);
  1007.  
  1008. FUNCTION
  1009.     This function reads a spoolfile and imports each article
  1010.     into the folder.  The function expects the file to be in
  1011.     UNIX mailbox format, i.e., each article is preceded by a
  1012.     "From " line, identifying the start of the article.  This
  1013.     "From " line is discarded.
  1014.  
  1015. INPUTS
  1016.     folder - Pointer to a folder object
  1017.     importfile - Filename of the spoolfile to import
  1018.     flags - See <libraries/aml.h> for valid flags.
  1019.  
  1020. RETURNS
  1021.     count - The number of article read from the spool.
  1022.  
  1023. SEE ALSO
  1024.     WriteFolderSpool()
  1025.  
  1026. aml.library/RemAddressEntry                       aml.library/RemAddressEntry
  1027.  
  1028. NAME
  1029.     RemAddressEntry -- Deletes an address entry object
  1030.         from the server and disposes it.
  1031.  
  1032. SYNOPSIS
  1033.     success = RemAddressEntry(server, addr)
  1034.     D0                        A0     A1
  1035.  
  1036.     BOOL RemAddressEntry(APTR server, APTR addr);
  1037.  
  1038. FUNCTION
  1039.     This function does the same thing as DisposeAddressEntry(),
  1040.     as well as deleting its entry from the server.
  1041.  
  1042. INPUTS
  1043.     server - Pointer to a server object
  1044.     addr - Pointer to an address entry object to delete/dispose.
  1045.  
  1046. RETURNS
  1047.     success - 1 if the entry was successfully deleted, 0 otherwise.
  1048.  
  1049. SEE ALSO
  1050.     CreateAddressEntryA()
  1051.  
  1052. aml.library/RemCustomField                         aml.library/RemCustomField
  1053.  
  1054. NAME
  1055.     RemCustomField -- Removes a custom field from an address
  1056.         entry object
  1057.  
  1058. SYNOPSIS
  1059.     RemCustomField(addr, field)
  1060.                 A0     A1
  1061.  
  1062.     void RemCustomField(APTR addr, STRPTR field);
  1063.  
  1064. FUNCTION
  1065.     Removes the named custom field and its associated data
  1066.     from the address entry object.
  1067.  
  1068. SEE ALSO
  1069.     AddCustomField(), GetCustomFieldData()
  1070.  
  1071. aml.library/RemFolder                                   aml.library/RemFolder
  1072.  
  1073. NAME
  1074.     RemFolder -- Remove all traces of a folder
  1075.  
  1076. SYNOPSIS
  1077.     success = RemFolder(folder)
  1078.     D0                A0
  1079.  
  1080.     BOOL RemFolder(APTR folder);
  1081.  
  1082. FUNCTION
  1083.     This function deletes the entire contents of a folder
  1084.     and then frees the folder object itself.
  1085.  
  1086. INPUTS
  1087.     folder - Pointer to a folder object
  1088.  
  1089. RETURNS
  1090.     success - 1 for successful deletion of the folder and all
  1091.     its contents, 0 otherwise.
  1092.  
  1093. SEE ALSO
  1094.     CreateFolderA()
  1095.  
  1096. aml.library/RemFolderArticle                     aml.library/RemFolderArticle
  1097.  
  1098. NAME
  1099.     RemFolderArticle -- Remove an article from a folder
  1100.  
  1101. SYNOPSIS
  1102.     success = RemFolderArticle(folder, article)
  1103.     D0                        A0     A1
  1104.  
  1105.     BOOL RemFolderArticle(APTR folder, APTR article);
  1106.  
  1107. FUNCTION
  1108.     This function will attempt to delete the specified
  1109.     article from the specified folder.
  1110.  
  1111. INPUTS
  1112.     folder - Pointer to a folder object
  1113.     article - Pointer to an article object
  1114.  
  1115. RETURNS
  1116.     success - 1 if successful, 0 otherwise
  1117.  
  1118. SEE ALSO
  1119.     AddFolderArticle()
  1120.  
  1121. aml.library/SaveAddressEntry                     aml.library/SaveAddressEntry
  1122.  
  1123. NAME
  1124.     SaveAddressEntry -- Saves an address entry object.
  1125.  
  1126. SYNOPSIS
  1127.     error = SaveAddressEntry(server, addr)
  1128.     D0                    A0        A1
  1129.  
  1130.     LONG SaveAddressEntry(APTR server, APTR addr);
  1131.  
  1132. FUNCTION
  1133.     Saves the address entry object to the address book
  1134.     server.
  1135.  
  1136. INPUTS
  1137.     server - Pointer to a server object in which to
  1138.         store the address entry data.
  1139.     addr - Pointer to an address entry object to save.
  1140.  
  1141. RETURNS
  1142.     error - 0 for success, a DOS error code for failure.
  1143.  
  1144. SEE ALSO
  1145.     CreateAddressEntryA()
  1146.  
  1147. aml.library/SaveFolder                                 aml.library/SaveFolder
  1148.  
  1149. NAME
  1150.     SaveFolder -- Saves a folder object
  1151.  
  1152. SYNOPSIS
  1153.     success = SaveFolder(folder)
  1154.     D0                 A0
  1155.  
  1156.     BOOL SaveFolder(APTR folder);
  1157.  
  1158. FUNCTION
  1159.     This function attempts to save the folder's data
  1160.     to local disk or an associated server.
  1161.  
  1162. INPUTS
  1163.     folder - Pointer to a folder object
  1164.  
  1165. RETURNS
  1166.     success - 1 if successful, 0 otherwise.
  1167.  
  1168. SEE ALSO
  1169.     CreateFolderA()
  1170.  
  1171. aml.library/ScanFolderIndex                       aml.library/ScanFolderIndex
  1172.  
  1173. NAME
  1174.     ScanFolderIndex -- Scan a folder's index
  1175.  
  1176. SYNOPSIS
  1177.     ScanFolderIndex(folder, hook, flags)
  1178.     D0              A0         A1    DO
  1179.  
  1180.     void ScanFolderIndex(APTR folder, struct Hook *hook, ULONG flags);
  1181.  
  1182. FUNCTION
  1183.     Scans a folder index, calling the provided hook, so that
  1184.     the application can display a progress bar and/or set
  1185.     status flags on each item in the index.
  1186.  
  1187.     The hook function will be passed the pointer to the folder
  1188.     object in A2 and a FolderIndex structure in A1.  See
  1189.     <libraries/aml.h> for details on the FolderIndex structure,
  1190.     and any flags or status that may be set/checked in it.
  1191.  
  1192. INPUTS
  1193.     folder - Pointer to a folder object to scan
  1194.     hook - Pointer to an initialized hook
  1195.     flags - Currently should be NULL
  1196.  
  1197. aml.library/SendArticle                               aml.library/SendArticle
  1198.  
  1199. NAME
  1200.     SendArticle -- Send an article
  1201.  
  1202. SYNOPSIS
  1203.     success = SendArticle(server, article, file)
  1204.     D0                A0         A1       A2
  1205.  
  1206.     BOOL SendArticle(APTR server, APTR article, STRPTR file);
  1207.  
  1208. FUNCTION
  1209.     Sends the article to the specified server.  The article can
  1210.     either be an article object, passed in the 'article' parameter,
  1211.     or a disk file, passed in the 'file' parameter.
  1212.  
  1213. INPUTS
  1214.     server - Pointer to a server object
  1215.     article - Pointer to an article object
  1216.     file - Filename of an article to send
  1217.  
  1218. RETURNS
  1219.     success - 1 if successful, 0 otherwise.
  1220.  
  1221. SEE ALSO
  1222.     AddFolderArticle()
  1223.  
  1224. aml.library/SetArticleAttrsA                     aml.library/SetArticleAttrsA
  1225.  
  1226. NAME
  1227.     SetArticleAttrsA -- Set article attributes
  1228.     SetArticleAttrs -- Varargs stub for SetArticleAttrsA
  1229.  
  1230. SYNOPSIS
  1231.     value = SetArticleAttrsA(article, tags)
  1232.     D0                    A0         A1
  1233.  
  1234.     ULONG SetArticleAttrsA(APTR article, struct TagItem *)
  1235.  
  1236.     ULONG SetArticleAttrs(APTR article, ULONG, ...)
  1237.  
  1238. FUNCTION
  1239.     Sets attributes on an article object
  1240.  
  1241. INPUTS
  1242.     article - The article object to set attributes on
  1243.     tags - An array of TagItems containing attributes to set
  1244.  
  1245. TAGS
  1246.     ARTICLEA_To, ARTICLEA_Cc, ARTICLEA_Bcc, ARTICLEA_From,
  1247.     ARTICLEA_ReplyTo, ARTICLEA_Subject, ARTICLEA_ContentType,
  1248.     ARTICLEA_ContentSubType, ARTICLEA_ContentEncoding,
  1249.     ARTICLEA_Groups, ARTICLEA_XFace, ARTICLEA_MessageID,
  1250.     ARTICLEA_Reference, ARTICLEA_SigFile (all STRPTR) - Each tag
  1251.         corresponds to an appropriate message/newsarticle header
  1252.         as defined by RFC 822; 2045, et. al.  Note that these
  1253.         tags are NOT cumulative, i.e., specifying the
  1254.         ADDRESSA_To tag twice will not add the next address to
  1255.         the "To" list, but replace it.  Please see the
  1256.         appropriate RFC for details on the proper formation
  1257.         of each header's data.
  1258.  
  1259.     ARTICLEA_CustomHeaders (STRPTR) - A set of valid article headers,
  1260.         each terminated by a "\r\n" sequence.
  1261.  
  1262.     ARTICLEA_Date (STRPTR), ARTICLEA_DateVal (LONG) - Allows you to
  1263.         set the Date: header using either a previous header's
  1264.         value (_Date), or a 32-bit integer value based off the epoch
  1265.         (_DateVal).
  1266.  
  1267.     ARTICLEA_Flags (LONG) - Sets appropriate flags for the
  1268.         article, like unread, reply, forward, etc. status.  See the
  1269.         library's header file for valid values.
  1270.  
  1271.     ARTICLEA_ReturnReceipt (BOOL) - Sets whether the appropriate
  1272.         return receipt headers should be generated.  (Set only.)
  1273.  
  1274. RETURNS
  1275.     value - The number of attributes successfully set.
  1276.  
  1277. SEE ALSO
  1278.     libraries/aml.h
  1279.  
  1280. aml.library/SetArticlePartDataA               aml.library/SetArticlePartDataA
  1281.  
  1282. NAME
  1283.     SetArticlePartDataA -- Sets an article part's data
  1284.     SetArticlePartData -- Varargs stub for SetArticlePartDataA
  1285.  
  1286. SYNOPSIS
  1287.     success = SetArticlePartDataA(part, tags)
  1288.     D0                        A0     A1
  1289.  
  1290.     BOOL SetArticlePartDataA(APTR part, struct TagItem *tags);
  1291.  
  1292.     BOOL SetArticlePartData(APTR part, ULONG tag1, ...);
  1293.  
  1294. FUNCTION
  1295.     Sets the data for the part object.  Data can be any of a number
  1296.     of things, depending on the tag used to pass in the data.  The
  1297.     data pointed to must remain valid for the life of the part
  1298.     object.
  1299.  
  1300. INPUTS
  1301.     part - Pointer to the part object
  1302.     tags - Array of TagItems.
  1303.  
  1304. TAGS
  1305.     PARTA_DataFilename (STRPTR) - A filename of the actual data
  1306.         to add to the part.
  1307.     PARTA_DataFile (BPTR) - A file pointer from a call to Open()
  1308.     PARTA_DataString (STRPTR) - A string buffer, NULL-terminated
  1309.         of the data.
  1310.     PARTA_DataBuffer (APTR) - A generic buffer of data.  Must be
  1311.         accompanied by the PARTA_DataLength tag.
  1312.     PARTA_DataLength (ULONG) - Specifies how long the data buffer
  1313.         is.  Only valid for PARTA_DataString and PARTA_DataBuffer.
  1314.         It is required for PARTA_DataBuffer, and can be used
  1315.         creatively for limiting the length of data passed via
  1316.         PARTA_DataString.  This tag is ignored for other data
  1317.         types.
  1318.  
  1319. RETURNS
  1320.     success - 1 if successful, 0 otherwise.
  1321.  
  1322. aml.library/SetDecoderAttrsA                     aml.library/SetDecoderAttrsA
  1323.  
  1324. NAME
  1325.     SetDecoderAttrsA -- Set attributes for a de/encoder object
  1326.     SetDecoderAttrs -- Varargs stub for SetDecoderAttrsA
  1327.  
  1328. SYNOPSIS
  1329.     value = SetDecoderAttrsA(decoder, tags)
  1330.     D0                    A0         A1
  1331.  
  1332.     ULONG SetDecoderAttrsA(APTR decoder, struct TagItem *tags);
  1333.  
  1334.     ULONG SetDecoderAttrs(APTR decoder, ULONG tag1, ...);
  1335.  
  1336. FUNCTION
  1337.     Sets attributes of the specified decoder/encoder object.
  1338.  
  1339. INPUTS
  1340.     decoder - Pointer to a decoder/encoder object.
  1341.     tags - An array of TagItems.
  1342.  
  1343. TAGS
  1344.     DECODERA_SourceHandle (BPTR) - Pointer to a previously
  1345.         opened file handle for the input stream.
  1346.     DECODERA_SourceFile (STRPTR) - Filename of a file to
  1347.         open for the input stream.
  1348.     DECODERA_SourceBuffer (APTR) - Pointer to a buffer that
  1349.         will be the source.
  1350.     DECODERA_SourceLen (ULONG) - Length of the provided source
  1351.         buffer.  MUST be provided for a source of type
  1352.         DECODERA_SourceBuffer.
  1353.     DECODERA_DestHandle (BPTR) - Pointer to a previously
  1354.         opened file handle for the output stream.
  1355.     DECODERA_DestFile (STRPTR) - Filename of a file to create
  1356.         for the output stream.
  1357.     DECODERA_DestBuffer (APTR) - Pointer to a buffer that will
  1358.         be the destination.
  1359.     DECODERA_DestLen (ULONG) - Maximum length of the destination
  1360.         buffer.  MUST be provided for a destination type of
  1361.         DECODERA_DestBuffer.
  1362.     DECODERA_Lines (ULONG) - Number of lines.
  1363.     DECODERA_Boundary (STRPTR) - String that specifies the MIME
  1364.         boundary of a multipart or partial decode stream.
  1365.         This will allow the decoder to intelligently stop
  1366.         decoding certain media types.
  1367.     DECODERA_Flags (ULONG) - Flags for the decoder/encoder
  1368.         object.  See <libraries/aml.h> for valid flags.
  1369.  
  1370. RETURNS
  1371.     value - Number of attributes successfully set.
  1372.  
  1373. SEE ALSO
  1374.     CreateDecoderA(), GetDecoderAttrsA(), <libraries/aml.h>
  1375.  
  1376. aml.library/SetFolderAttrsA                       aml.library/SetFolderAttrsA
  1377.  
  1378. NAME
  1379.     SetFolderAttrsA -- Set the attributes of a folder object
  1380.     SetFolderAttrs -- Varargs stub for SetFolderAttrsA
  1381.  
  1382. SYNOPSIS
  1383.     count = SetFolderAttrsA(folder, tags)
  1384.     D0                    A0     A1
  1385.  
  1386.     ULONG SetFolderAttrsA(APTR folder, struct TagItem *tags);
  1387.  
  1388.     ULONG SetFolderAttrs(APTR folder, ULONG tag1, ...);
  1389.  
  1390. FUNCTION
  1391.     This function sets the specified attributes for
  1392.     a folder object.
  1393.  
  1394. INPUTS
  1395.     folder - Pointer to a folder object
  1396.     tags - An array of TagItems
  1397.  
  1398. TAGS
  1399.     The following tags are valid:
  1400.  
  1401.         FOLDERA_SpoolFile (STRPTR) - A file to be
  1402.             check for possible new articles.
  1403.  
  1404.         FOLDERA_Path (STRPTR) - Path that this folder
  1405.             will be located.
  1406.  
  1407.         FOLDERA_Name (STRPTR) - The actual name of
  1408.             the folder.
  1409.  
  1410.         FOLDERA_DefaultName (ULONG) - Used for setting
  1411.             the name of a "default" folder, typical
  1412.             for e-mail applications.  The following
  1413.             values can be passed with this tag:
  1414.  
  1415.                 FOLDER_DEF_INBOX, FOLDER_DEF_OUTBOX,
  1416.                 FOLDER_DEF_DRAFTS, FOLDER_DEF_SAVED,
  1417.                 FOLDER_DEF_TRASH
  1418.  
  1419.         FOLDERA_Flags (ULONG) - See <libraries/aml.h> for
  1420.             details on the valid flag values.
  1421.  
  1422.         FOLDERA_UserData (APTR) - User defined.
  1423.  
  1424.         FOLDERA_FirstMsgID (ULONG) - An ordinal number
  1425.             specifying the first valid article ID for
  1426.             this folder.
  1427.  
  1428.         FOLDERA_LastMsgID (ULONG) - An ordinal number
  1429.             specifying the last valid article ID for
  1430.             this folder.
  1431.  
  1432. RETURNS
  1433.     count - The number of attributes successfully set.
  1434.  
  1435. SEE ALSO
  1436.     DisposeFolder(), SetFolderAttrsA
  1437.  
  1438. aml.library/SetServerAttrsA                       aml.library/SetServerAttrsA
  1439.  
  1440. NAME
  1441.     SetServerAttrsA -- Set attributes for a server object
  1442.     SetServerAttrs -- Varargs stub for SetServerAttrs
  1443.  
  1444. SYNOPSIS
  1445.     value = SetServerAttrsA(server, tags)
  1446.     D0                    A0      A1
  1447.  
  1448.     ULONG SetServerAttrsA(APTR server, struct TagItem *tags);
  1449.  
  1450.     ULONG SetServerAttrs(APTR server, ULONG tag1, ...);
  1451.  
  1452. FUNCTION
  1453.     This function allows you to set the attributes on
  1454.     a server object.
  1455.  
  1456. INPUTS
  1457.     server - Pointer to a server object
  1458.     tags - An array of TagItems
  1459.  
  1460. TAGS
  1461.     SERVERA_Type (ULONG) - This is the most important
  1462.         tag, and is required at a minimum.  The valid types
  1463.         are:
  1464.  
  1465.         SVRTYPE_FILE - A "file" server.  This is the type of
  1466.             server that must be specified to access an
  1467.             addressbook.  See the SERVERA_Directory tag below.
  1468.         SVRTYPE_SMTP - This creates a server for use with
  1469.             sending e-mail messages.  If not specified via
  1470.             SERVERA_HostPort, the port defaults to 25.
  1471.         SVRTYPE_POP3 - This creates a server used for
  1472.             retrieving e-mail messages from a POP3 server.
  1473.             If not specified via SERVERA_HostPort, the port
  1474.             defaults to 110.
  1475.         SVRTYPE_NNTP - This creates a server use for
  1476.             sending and receiving news articles.  If not
  1477.             specified via SERVERA_HostPort, the port
  1478.             defaults to 119.
  1479.  
  1480.     SERVERA_Directory (STRPTR) - Use this tag to specify the
  1481.         name of a directory that contains address entries
  1482.         for an address book.
  1483.  
  1484.     SERVERA_HostName (STRPTR) - This is the name or IP address
  1485.         of the host machine that this server object will
  1486.         connect to.
  1487.  
  1488.     SERVERA_HostPort (ULONG) - This allows you to specify the
  1489.         port number to use for the server object.  If not
  1490.         specified, it will default to the appropriate value
  1491.         for the type of server object.
  1492.  
  1493.     SERVERA_UserName (STRPTR) - This is the username to use
  1494.         when authenticating with the server.
  1495.  
  1496.     SERVERA_PassWord (STRPTR) - This is the password the
  1497.         server object will use when authenticating.
  1498.  
  1499.     SERVERA_SpoolFile (STRPTR) - Filename of a file to use
  1500.         when downloading articles from a server.  It is
  1501.         recommended to use SERVERA_ProgressHook instead,
  1502.         for better control of the destination of the
  1503.         incoming articles.
  1504.  
  1505.     SERVERA_ProgressHook (struct Hook *) - A hook to be called
  1506.         when the server is sending/receiving articles.  This
  1507.         allows the application to display a progress bar, as well
  1508.         as specify the ultimate destination of incoming articles.
  1509.  
  1510.         When the hook function is called, the server object is
  1511.         passed in A2.  A1 will contain a ServerProgressData structure
  1512.         for outgoing transactions, an ArticleDisposition structure for
  1513.         incoming transactions.  See <libraries/aml.h> for details.
  1514.  
  1515.     SERVERA_Flags (ULONG) - See <libraries/aml.h> for valid flags.
  1516.  
  1517.     SERVERA_NewsGroup (STRPTR) - If the server is a news server, use
  1518.         this tag to specify the name of the newsgroup to attach to.
  1519.  
  1520.     SERVERA_LogFile (STRPTR) - This is a filename of a logfile for
  1521.         the server to dump information to.
  1522.  
  1523.     SERVERA_MaxSize (ULONG) - Maximum size in bytes for articles
  1524.         that the server should retrieve.  If the article is larger
  1525.         than this value, action is taken based upon the values for
  1526.         the two tags below.
  1527.  
  1528.     SERVERA_MaxLines (ULONG) - This tells the server object how many
  1529.          lines of an article to retrieve if the article exceeds the
  1530.          size limit specified by SERVERA_MaxSize.
  1531.  
  1532.     SERVERA_MaxWarning (STRPTR) - If the article being retrieve is
  1533.         larger than the requested maximum, after the number of
  1534.         lines are retrieved specified by SERVERA_MaxLines, this
  1535.         message will be appended to the article.
  1536.  
  1537.     SERVERA_UserData (APTR) - User defined.
  1538.  
  1539. RETURNS
  1540.     value - The number of attributes successfully set.
  1541.  
  1542. SEE ALSO
  1543.     CreateServerA(), GetServerAttrsA()
  1544.  
  1545. aml.library/WriteFolderSpool                     aml.library/WriteFolderSpool
  1546.  
  1547. NAME
  1548.     WriteFolderSpool -- Writes the folder to a UNIX style spool
  1549.  
  1550. SYNOPSIS
  1551.     count = WriteFolderSpool(folder, exportfile, flags)
  1552.     D0                    A0         A1        D0
  1553.  
  1554.     ULONG WriteFolderSpool(APTR folder, STRPTR exportfile, ULONG flags);
  1555.  
  1556. FUNCTION
  1557.     Writes the contents of the specified folder out to a
  1558.     UNIX-style mailbox format spool.  Each article is prepended
  1559.     with a "From " line that allows another mail parser to detect
  1560.     the beginning of each article.
  1561.  
  1562. INPUTS
  1563.     folder - Pointer to a folder object
  1564.     exportfile - Filename of the spoolfile to create
  1565.     flags - See <libraries/aml.h> for valid flags.
  1566.  
  1567. RETURNS
  1568.     count - The number of articles written to the spool file.
  1569.  
  1570. SEE ALSO
  1571.     ReadFolderSpool()
  1572.  
  1573. datatypes.library/--rexxhost--                 datatypes.library/--rexxhost--
  1574.  
  1575.      NOT IMPLEMENTED YET!
  1576.  
  1577. aml.library/GetAddressEntryAttrsA           aml.library/GetAddressEntryAttrsA
  1578.  
  1579. NAME
  1580.     SetAddressEntryAttrsA -- Set attributes of an address entry object
  1581.     SetAddressEntryAttrs -- Varargs stub for SetAddressEntryAttrsA
  1582.  
  1583. SYNOPSIS
  1584.     value = SetAddressEntryAttrsA(addr, tags)
  1585.     D0                        A0     A1
  1586.  
  1587.     ULONG SetAddressEntryAttrsA(APTR addr, struct TagItem *tags);
  1588.  
  1589.     ULONG SetAddressEntryAttrs(APTR addr, ULONG tag1, ...);
  1590.  
  1591. FUNCTION
  1592.     Sets the requested attributes from the specified
  1593.     address entry object.
  1594.  
  1595. INPUTS
  1596.     addr - Pointer to a previously-created address entry object.
  1597.     tags - Pointer to an array of TagItems.
  1598.  
  1599. TAGS
  1600.     ADDRESSA_Group, ADDRESSA_Name, ADDRESSA_Address,
  1601.     ADDRESSA_City, ADDRESSA_State, ADDRESSA_Zip,
  1602.     ADDRESSA_Country, ADDRESSA_Phone, ADDRESSA_Fax,
  1603.     ADDRESSA_Comments, ADDRESSA_URL, ADDRESSA_EMail,
  1604.     ADDRESSA_Flags, ADDRESSA_ICQ, ADDRESSA_FTP,
  1605.     ADDRESSA_Company, ADDRESSA_JobTitle, ADDRESSA_MobilePhone,
  1606.     ADDRESSA_ImageFile (STRPTR)
  1607.         The meanings of these tags should be obvious, we hope. :)
  1608.  
  1609.     ADDRESSA_EntryType (ULONG)
  1610.         What type of address entry this is; See <libraries/aml.h> for details.
  1611.  
  1612.  
  1613. RETURNS
  1614.     value - The number of attributes successfully set.
  1615.  
  1616. SEE ALSO
  1617.     GetAddressEntryAttrsA()
  1618.  
  1619.