Required Backend Functions Backend Interface Error Messaging
(nnchoke-retrieve-groups GROUPS &optional SERVER)
|
groups is a list of groups, and this function should request data on all those groups. How it does it is of no concern to Gnus, but it should attempt to do this in a speedy fashion.
The return value of this function can be either
|
(nnchoke-request-update-info GROUP INFO &optional SERVER)
|
A Gnus group info (see Group Info) is handed to the backend for alterations. This comes in handy if the backend really carries all the information (as is the case with virtual and imap groups). This function should destructively alter the info to suit its needs, and should return the (altered) group info. There should be no result data from this function. |
(nnchoke-request-type GROUP &optional ARTICLE)
|
When the user issues commands for ``sending news'' (F in the
summary buffer, for instance), Gnus has to know whether the article the
user is following up on is news or mail. This function should return
There should be no result data from this function. |
(nnchoke-request-update-mark GROUP ARTICLE MARK)
|
If the user tries to set a mark that the backend doesn't like, this
function may change the mark. Gnus will use whatever this function
returns as the mark for article instead of the original
mark. If the backend doesn't care, it must return the original
mark, and not
The only use for this I can see is what There should be no result data from this function. |
(nnchoke-request-scan &optional GROUP SERVER)
|
This function may be called at any time (by Gnus or anything else) to request that the backend check for incoming articles, in one way or another. A mail backend will typically read the spool file or query the POP server when this function is invoked. The group doesn't have to be heeded---if the backend decides that it is too much work just scanning for a single group, it may do a total scan of all groups. It would be nice, however, to keep things local if that's practical. There should be no result data from this function. |
(nnchoke-request-group-description GROUP &optional SERVER)
|
The result data from this function should be a description of group.
|
(nnchoke-request-list-newsgroups &optional SERVER)
|
The result data from this function should be the description of all groups available on the server.
|
(nnchoke-request-newgroups DATE &optional SERVER)
|
The result data from this function should be all groups that were
created after ` |
(nnchoke-request-create-group GROUP &optional SERVER)
|
This function should create an empty group with name group. There should be no return data. |
(nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
|
This function should run the expiry process on all articles in the
articles range (which is currently a simple list of article
numbers.) It is left up to the backend to decide how old articles
should be before they are removed by this function. If force is
non- This function should return a list of articles that it did not/was not able to delete. There should be no result data returned. |
(nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
|
&optional LAST) This function should move article (which is a number) from group by calling accept-form.
This function should ready the article in question for moving by
removing any header lines it has added to the article, and generally
should ``tidy up'' the article. Then it should
If last is
The function should return a cons where the There should be no data returned. |
(nnchoke-request-accept-article GROUP &optional SERVER LAST)
|
This function takes the current buffer and inserts it into group.
If last in
The function should return a cons where the There should be no data returned. |
(nnchoke-request-replace-article ARTICLE GROUP BUFFER)
|
This function should remove article (which is a number) from group and insert buffer there instead. There should be no data returned. |
(nnchoke-request-delete-group GROUP FORCE &optional SERVER)
|
This function should delete group. If force, it should really delete all the articles in the group, and then delete the group itself. (If there is such a thing as ``the group itself''.) There should be no data returned. |
(nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
|
This function should rename group into new-name. All articles in group should move to new-name. There should be no data returned. |