Apple-2-SW/emailler
1
0
Fork 0
mirror of https://github.com/bobbimanners/emailler.git synced 2024-05-28 05:41:28 +00:00
Code Issues Projects Releases Wiki Activity

Docs

Browse Source
This commit is contained in:
Bobbi Webber-Manners 2020-10-29 19:00:14 -04:00
parent 33fb31353c
commit 24835ff235
3 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README-nntp65.md
View File

@ -12,5 +12,28 @@
<p align="center"><img src="img/NNTP65_2.jpg" alt="NNTP65" height="400px"></p>
`NNTP65.SYSTEM` is a Network News Transport Protocol (NNTP) client for the Apple II. It requires an Uthernet-II ethernet card and will not work with other interfaces without modification, because it uses the W5100 hardware TCP/IP stack.
Before running `NNTP65.SYSTEM` for the first time, be sure you have performed the basic Emai//er setup described [here](README-emailler-setup.md) and have also performed the initialization specific to Usenet discussed in [this page](README-usenet-setup.md). In particular, the `NEWS.SPOOL` directory must have been created, otherwise `NNTP65.SYSTEM` will be unable to download news articles.
`NNTP65.SYSTEM` runs without any user interaction and performs the following tasks:
- Detect Uthernet-II
- Obtain IP address using DHCP
- Connect to NNTP server using parameters from first three lines of `NEWS.CFG`. (`AUTHINFO USER` and `AUTHINFO PASS` commands)
- For each newsgroup listed in `NEWSGROUPS.CFG`:
- Issue `GROUP` command to select the newsgroup.
- Parse the respond from the server which indicates the message number of the first and last messages available in the newsgroup.
- If the article number in `NEWSGROUPS.CFG` is zero, set the current article number to the last available article number minus 100 (so that up to 100 articles are retrieved when the newgroup is retrieved for the first time.) Otherwise, set the current article number to the first article number recorded in `NEWSGROUPS.CFG`.
- Issue the `STAT` command to the NNTP server for the current article number.
- If the article does not exist, increment the current article number and loop to the previous step.
- For each article to be retrieved from the selected newsgroup:
- Issue the `NEXT` command to the NNTP server to advance to the next article.
- Issue to `ARTICLE` command to retrieve the news article, writing it to a file in the `NEWS.SPOOL` directory (eg: `/H1/DOCUMENTS/EMAIL/NEWS.SPOOL/NEWS.1234`).
- Write an updated newsgroup line to the file `NEWSGROUPS.NEW`. This will be identical to the line read from `NEWSGROUPS.CFG` except with the last article number updated.
- Copy the messages just retrieved from the `NEWS.SPOOL` directory to the mailbox for the newsgroup in question.
- Once all newsgroups have been retrieved, rename `NEWSGROUPS.NEW` to replace `NEWSGROUPS.CFG`.
- Issue the `QUIT` command to disconnect from the NNTP server.
[Back to Main emai//er Docs](README-emailler.md#detailed-documentation-for-usenet-functions)

6
README-pop65.md
View File

@ -10,11 +10,11 @@
<p align="center"><img src="img/POP65.jpg" alt="POP65" height="400px"></p>
POP65 is a Post Office Protocol v3 (POP3) client for the Apple II. It requires an Uthernet-II ethernet card and will not work with other interfaces without modification, because it uses the W5100 hardware TCP/IP stack. POP65 is used to download new email messages from a POP3 email server. (I use Dovecot on the Raspberry Pi as my POP3 server, but other POP3 servers should work too.)
`POP65.SYSTEM` is a Post Office Protocol v3 (POP3) client for the Apple II. It requires an Uthernet-II ethernet card and will not work with other interfaces without modification, because it uses the W5100 hardware TCP/IP stack. `POP65.SYSTEM` is used to download new email messages from a POP3 email server. (I use Dovecot on the Raspberry Pi as my POP3 server, but other POP3 servers should work too.)
Before running `POP65.SYSTEM` for the first time, be sure you have created the email root directory and the `SPOOL` directory, as described [here](README-emailler-setup.md). POP3 will initialize the `INBOX` mailbox, creating `NEXT.EMAIL` and `EMAIL.DB` files if they do not exist.
Before running `POP65.SYSTEM` for the first time, be sure you have created the email root directory and the `SPOOL` directory, as described [here](README-emailler-setup.md). `POP65.SYSTEM` will initialize the `INBOX` mailbox, creating `NEXT.EMAIL` and `EMAIL.DB` files if they do not exist.
POP65 runs without any user interaction and performs the following tasks:
`POP65.SYSTEM` runs without any user interaction and performs the following tasks:
- Detect Uthernet-II
- Obtain IP address using DHCP

6
README-smtp65.md
View File

@ -10,11 +10,11 @@
<p align="center"><img src="img/SMTP65.jpg" alt="SMTP65" height="400px"></p>
SMTP65 is a Simple Mail Transport Protocol (SMTP65) client for the Apple II. It requires an Uthernet-II ethernet card and will not work with other interfaces without modification, because it uses the W5100 hardware TCP/IP stack. POP65 is used to send outgoing email messages to an SMTP email server. (I use Postfix on the Raspberry Pi as my SMTP server, but other SMTP servers should work too.)
`SMTP65.SYSTEM` is a Simple Mail Transport Protocol (SMTP65) client for the Apple II. It requires an Uthernet-II ethernet card and will not work with other interfaces without modification, because it uses the W5100 hardware TCP/IP stack. `SMTP65.SYSTEM` is used to send outgoing email messages to an SMTP email server. (I use Postfix on the Raspberry Pi as my SMTP server, but other SMTP servers should work too.)
Before running SMTP65 for the first time, be sure to have created the `SENT` mailbox. This must be a 'proper' mailbox, not just a directory. You may create a mailbox using the `N` (new mailbox) command in `EMAIL.SYSTEM`.
Before running `SMTP65.SYSTEM` for the first time, be sure to have created the `SENT` mailbox. This must be a 'proper' mailbox, not just a directory. You may create a mailbox using the `N` (new mailbox) command in `EMAIL.SYSTEM`.
SMTP65 performs the following tasks:
`SMTP65.SYSTEM` performs the following tasks:
- Detect Uthernet-II
- Obtain IP address using DHCP