Table of Contents | Previous
Messaging Access SDK Guide
A
- adding
- message content 39
- message headers 39
- message part 43
- all IMAP4 states, protocol commands 61
- APPEND command, IMAP4 236
- Authenticated state
- functions 235
- functions with callbacks 63
- in IMAP4 session 61
- protocol commands 61
- Authorization state
- in POP3 session 81
- protocol commands 81
B
- BASE64 encoding 33
- Basic (Leaf) Body Part functions 152
- batching commands (pipelining), SMTP 23
- beginDynamicParse function 192
- body data
- adding 40
- deleting 44
- buf_inputStream_create function 118
- buffer size definition, MIME 216
- building MIME messages 37
C
- callback mapping
- IMAP4 63
- MIME 50
- POP3 83
- SMTP 17
- CAPABILITY command, IMAP4 69, 231
- CHECK command, IMAP4 248
- checking for new messages, IMAP4 71
- clients
- creating, IMAP4 67
- creating, POP3 86
- creating, SMTP 20
- freeing, IMAP4 67
- freeing, POP3 86
- freeing, SMTP 20
- CLOSE command, IMAP4 74, 249
- closing mailboxes, IMAP4 74
- compiling the SDK 8
- MS Windows 11
- Unix 10
- connecting to a server 67
- IMAP4 67
- POP3 87
- SMTP 21
- content types, MIME 33, 216
- conventions, document 14
- COPY command, IMAP4 250
- counting messages, POP3 89
- CREATE command, IMAP4 237
- creating
- data sink 50
- dynamic parser 52
- MIME messages, convenience function 38, 43
- creating a client
- IMAP4 67
- POP3 86
- SMTP 20
- creating a response sink
- IMAP4 66
- POP3 85
- SMTP 19
D
- DATA command, SMTP 124, 125
- data sinks 5
- callbacks 49, 50
- creating 50
- decoding
- message headers, utility 46
- messages 47
- definitions for all SDK protocols 110
- DELE command, POP3 284
- DELETE command, IMAP4 238
- DELETEACL command, IMAP4 264
- deleting
- body data 44
- MIME messages 44
- developer information 15
- disconnecting from the server
- IMAP4 68
- POP3 87
- SMTP 22
- disposition types
- MIME 215
- document conventions 14
- downloading the SDK 4
- dynamic parsers
- creating 52
- freeing 53
- running 53
- dynamic parsing 48, 49
- dynamicParse function 193
- dynamicParseInputstream function 194
E
- EHLO command, SMTP 21, 22, 127, 135
- encoding
- encoding entire MIME message 44
- message headers, utility 46
- messages 44
- encoding types
- BASE64 33
- MIME 33, 215
- Q 46
- QP (Quoted Printable) 33
- endDynamicParse function 194
- ending the session
- IMAP4 74
- POP3 93
- SMTP 27
- error codes
- all SDK protocols 111
- MIME 213
- SDK 7
- ESMTP Support, determining 22
- EXAMINE command, IMAP4 239
- EXPN command, SMTP 128
- EXPUNGE command, IMAP4 251
- Extended IMAP4
- functions 263
- functions with callbacks 64
- extensions
- determining, IMAP4 69
- determining, SMTP 22
F
- FETCH command, IMAP4 74, 252, 260
- fetching message data, IMAP4 73
- file_inputStream_create function 117
- file_mime_type structure 201
- file_outputStream_create function 119
- freeing
- dynamic parser 53
- freeing the client
- IMAP4 67
- POP3 86
- SMTP 20
- freeing the data sink
- MIME 52
- freeing the response sink
- IMAP4 66
- POP3 86
- SMTP 20
- functions
- beginDynamicParse 192
- buf_inputStream_create 118
- dynamicParse 193
- dynamicParseInputstream 194
- endDynamicParse 194
- file_inputStream_create 117
- file_outputStream_create 119
- getFileMIMEType 189
- IMAP4 218
- IMAP4, by task 75
- imap4_append 235
- imap4_capability 231
- imap4_check 248
- imap4_close 248
- imap4_connect 220
- imap4_copy 249
- imap4_create 236
- imap4_delete 237
- imap4_deleteACL 263
- imap4_disconnect 221
- imap4_examine 238
- imap4_expunge 250
- imap4_fetch 251
- imap4_free 222
- imap4_get_option 222
- imap4_getACL 264
- imap4_initialize 223
- imap4_list 239
- imap4_listRights 265
- imap4_login 232
- imap4_logout 233
- imap4_lsub 240
- imap4_myRights 266
- imap4_namespace 267
- imap4_noop 233
- imap4_processResponses 224
- imap4_rename 241
- imap4_search 253
- imap4_select 242
- imap4_sendCommand 225
- imap4_set_option 226
- imap4_setACL 268
- imap4_setChunkSize 225
- imap4_setResponseSink 227
- imap4_setTimeout 227
- imap4_status 243
- imap4_store 256
- imap4_subscribe 244
- imap4_uidCopy 258
- imap4_uidFetch 259
- imap4_uidSearch 260
- imap4_uidStore 262
- imap4_unsubscribe 245
- imap4Sink_free 228
- imap4Sink_initialize 229
- imap4Tag_free 229
- messagePart_fromMessage 172
- MIME, by task 55
- mime_basicPart_deleteData 153
- mime_basicPart_free_All 180
- mime_basicPart_free_all 154
- mime_basicPart_getDataBuf 154
- mime_basicPart_getDataStream 155
- mime_basicPart_getSize 156
- mime_basicPart_putByteStream 157
- mime_basicPart_setDataBuf 158
- mime_basicPart_setDataStream 158
- mime_decodeBase64 184
- mime_decodeHeaderString 184
- mime_decodeQP 185
- mime_encodeBase64 186
- mime_encodeHeaderString 187
- mime_encodeQP 187
- mime_Header_free 188
- mime_Header_new 189
- mime_malloc 190
- mime_memfree 191
- mime_message_addBasicPart 161, 162
- mime_message_addMessagePart 161
- mime_message_addMultiPart 162
- mime_message_create 163
- mime_message_deleteBody 164
- mime_message_free_all 165
- mime_message_getBody 166
- mime_message_getContentSubType 166
- mime_message_getContentType 167
- mime_message_getContentTypeParams 168
- mime_message_getHeader 168
- mime_message_putByteStream 169
- mime_messagePart_deleteMessage 171
- mime_messagePart_free_all 171
- mime_messagePart_getMessage 173
- mime_messagePart_putByteStream 173
- mime_messagePart_setMessage 174
- mime_multiPart_addBasicPart 175
- mime_multiPart_addFile 176
- mime_multiPart_addMessagePart 177
- mime_multiPart_addMultiPart 178
- mime_multiPart_deletePart 179
- mime_multiPart_getPart 181
- mime_multiPart_getPartCount 181
- mime_multiPart_putByteStream 182
- mimeDataSink_free 199
- mimeDataSink_new 199
- mimeDynamicParser_free 195
- mimeDynamicParser_new 195
- nsStream_free 120
- parseEntireMessage 197
- parseEntireMessageInputstream 197
- POP3, by task 94
- pop3_connect 283
- pop3_delete 284
- pop3_disconnect 285
- pop3_free 285
- pop3_get_option 286
- pop3_initialize 287
- pop3_list 287
- pop3_listA 288
- pop3_noop 289
- pop3_pass 290
- pop3_processResponses 291
- pop3_quit 291
- pop3_reset 292
- pop3_retrieve 293
- pop3_sendCommand 294
- pop3_set_option 295
- pop3_setChunkSize 295
- pop3_setResponseSink 296
- pop3_setTimeout 297
- pop3_stat 299
- pop3_top 300
- pop3_uidList 300
- pop3_uidListA 301
- pop3_user 302
- pop3_xAuthList 303
- pop3_xAuthListA 303
- pop3_xSender 304
- pop3Sink_free 298
- pop3Sink_initialize 298
- smpt_ehlo 126
- SMTP, by task 28
- smtp_bdat 123
- smtp_connect 124
- smtp_data 125
- smtp_disconnect 126
- smtp_expand 127
- smtp_free 128
- smtp_get_option 128
- smtp_help 129
- smtp_initialize 130, 143
- smtp_mailFrom 131
- smtp_noop 131
- smtp_processReponses 132
- smtp_quit 133
- smtp_rcptTo 134
- smtp_reset 135
- smtp_send 135
- smtp_sendCommand 136
- smtp_sendStream 137
- smtp_set_option 138
- smtp_setChunkSize 138
- smtp_setPipelining 139
- smtp_setResponseSink 140
- smtp_setTimeout 141
- smtp_verify 142
- smtpSink_free 143
G
- GETACL command, IMAP4 265
- getFileMIMEType function 189
- getting message count, POP3 89
H
- HELP command, SMTP 130
- how Protocol APIs work together 2
I
- IMAP4 (Internet Message Access Protocol, version 4)
- Authenticated state functions 235
- callback mapping 63
- commands
- APPEND 236
- CAPABILITY 69, 231
- CHECK 248
- CLOSE 74, 249
- COPY 250
- CREATE 237
- DELETE 238
- DELETEACL 264
- EXAMINE 239
- EXPUNGE 251
- FETCH 74, 252, 260
- GETACL 265
- LIST 240
- LISTRIGHTS 266
- LOGIN 70, 232
- LOGOUT 233
- LSUB 241
- MYRIGHTS 267
- NAMESPACE 268
- NOOP 71
- RENAME 242
- SEARCH 72, 254, 261
- SELECT 243
- SETACL 269
- STATUS 244
- STORE 257, 262
- SUBSCRIBE 245
- supported in SDK 106
- UID 72, 258, 260, 261, 262
- UNSUBSCRIBE 246
- commands in session states 60
- commands supported in SDK 104
- data structures 270
- functions with callbacks 63
- functions, alphabetical list 218
- functions, complete list 218
- General functions 219
- in SDK 2
- list of RFCs 15
- protocol 60
- Selected state functions 247
- session commands 61
- session states 60
- sessions 62
- supported protocol commands 104
- imap4_append function 235
- imap4_capability function 231
- imap4_check function 248
- imap4_close function 248
- imap4_connect function 220
- imap4_copy function 249
- imap4_create function 236
- imap4_delete function 237
- imap4_deleteACL function 263
- imap4_disconnect function 221
- imap4_examine function 238
- imap4_expunge function 250
- imap4_fetch function 251
- imap4_free function 222
- imap4_get_option function 222
- imap4_getACL function 264
- imap4_initialize function 223
- imap4_list function 239
- imap4_listRights function 265
- imap4_login function 232
- imap4_logout function 233
- imap4_lsub function 240
- imap4_myRights function 266
- imap4_namespace function 267
- imap4_noop function 233
- imap4_processResponses function 224
- imap4_rename function 241
- imap4_search function 253
- imap4_select function 242
- imap4_sendCommand function 225
- imap4_set_option function 226
- imap4_setACL function 268
- imap4_setChunkSize function 225
- imap4_setResponseSink function 227
- imap4_setTimeout function 227
- imap4_status function 243
- imap4_store function 256
- imap4_subscribe function 244
- imap4_uidCopy function 258
- imap4_uidFetch function 259
- imap4_uidSearch function 260
- imap4_uidStore function 262
- imap4_unsubscribe function 245
- imap4Client_t structure 270
- imap4Sink_free function 228
- imap4Sink_initialize function 229
- imap4Sink_t structure 270
- imap4Tag_free function 229
- installing the SDK 4
- Internet Draft, IMAP4 Namespace 16
- Internet Protocols 101
- and protocol APIs 3
L
- LIST command
- IMAP4 240
- POP3 90, 288, 289, 301, 302
- LIST command, POP3 90
- listing messages, POP3 90
- LISTRIGHTS command, IMAP4 266
- locks 311
- logging in
- IMAP4 69
- POP3 88
- logging out
- IMAP4 70
- LOGIN command, IMAP4 70, 232
- LOGOUT command, IMAP4 233
- LSUB command, IMAP4 241
M
- MAIL FROM command, SMTP 24, 131
- mailboxes, closing, IMAP4 74
- mailer, setting, SMTP 24
- message headers 35
- adding 39
- decoding, utility 46
- encoding, utility 46
- messagePart_fromMessage function 172
- messages
- adding message content 39
- adding message headers 39
- adding message parts 43
- building 37
- checking for, IMAP4 71
- counting, POP3 89
- creating with a convenience function 38, 43
- creating, MIME 37
- deleting 44
- encoding 44
- encoding entire message 44
- fetching message data, IMAP4 73
- listing, POP3 90
- message body 36
- parsing entire message 47
- retrieving message headers, POP3 91
- retrieving, POP3 92
- searching for, IMAP4 72
- sending, SMTP 26
- structure 34
- Messaging Access SDK
- downloading 4
- error codes 7
- installing 4
- organization 4
- supported Internet protocols 101
- supported platforms 5
- MIME (Multipurpose Internet Mail Extensions) 32
- callback mapping 50
- canonical form 44
- content subtypes 33
- content types 33, 216
- content types, listed 34
- data sink 49, 50
- Data Sink functions 198
- data structures 201
- definitions and codes 212
- disposition types 215
- dynamic parser 48, 49
- Dynamic Parsing functions 192
- encoding types 33, 215
- error codes 213
- functions by functional group 150
- functions, alphabetical list 151
- in SDK 2
- list of RFCs 15
- Message functions 159
- Message Parsing functions 196
- Message Part functions 170
- Multipart functions 36, 175
- operations 37
- sessions 36
- type definitions 215
- Utility functions 45, 183
- mime_basicPart_deleteData function 153
- mime_basicPart_free_all function 154, 180
- mime_basicPart_getDataBuf function 154
- mime_basicPart_getDataStream function 155
- mime_basicPart_getSize function 156
- mime_basicPart_putByteStream function 157
- mime_basicPart_setDataBuf function 158
- mime_basicPart_setDataStream function 158
- mime_basicPart_t structure 202
- mime_decodeBase64 function 184
- mime_decodeHeaderString function 184
- mime_decodeQP function 185
- mime_encodeBase64 function 186
- mime_encodeHeaderString function 187
- mime_encodeQP function 187
- mime_Header_free function 188
- mime_Header_new function 189
- mime_header_t structure 203
- mime_inputstream_t structure 204
- mime_malloc function 190
- mime_memfree function 191
- mime_message_addBasicPart function 161, 162
- mime_message_addMessagePart function 161
- mime_message_addMultiPart function 162
- mime_message_create function 163
- mime_message_deleteBody function 164
- mime_message_free_all function 165
- mime_message_getBody function 166
- mime_message_getContentSubType function 166
- mime_message_getContentType function 167
- mime_message_getContentTypeParams function 168
- mime_message_getHeader function 168
- mime_message_putByteStream function 169
- mime_message_t structure 205
- mime_messagePart_deleteMessage function 171
- mime_messagePart_free_all function 171
- mime_messagePart_getMessage function 173
- mime_messagePart_putByteStream function 173
- mime_messagePart_setMessage function 174
- mime_messagePart_t structure 205
- mime_multiPart_addBasicPart function 175
- mime_multiPart_addFile function 176
- mime_multiPart_addMessagePart function 177
- mime_multiPart_addMultiPart function 178
- mime_multiPart_deletePart function 179
- mime_multiPart_getPart function 181
- mime_multiPart_getPartCount function 181
- mime_multiPart_putByteStream function 182
- mime_multiPart_t structure 207
- mime_outputstream_t structure 208
- mimeDataSink_free function 199
- mimeDataSink_new function 199
- mimeDataSink_t structure 208
- mimeDynamicParser_free function 195
- mimeDynamicParser_new function 195
- MS Windows, compiling on 11
- multipart, adding 41, 42
- multiple threads
- in MIME 312
- using 311
- multithreading
- in messaging applications 311
- in MIME API 312
- MYRIGHTS command, IMAP4 267
N
- NAMESPACE command, IMAP4 268
- namespace, Internet Draft 16
- Netscape developer information 15
- Non-Authenticated state
- functions 230
- functions with callbacks 63
- protocol commands 61
- NOOP command
- IMAP4 71
- POP3 289
- SMTP 132
- nsmail.h header file 109
- nsmail_inputstream_t structure 114
- nsmail_io_fns_t structure 113
- nsmail_outputstream_t structure 115
- nsStream.h header 109
- nsStream_free function 120
O
- option definition for all SDK protocols 111
- organization of guide 12
- overview of this manual 12
P
- parseEntireMessage function 197
- parseEntireMessageInputstream function 197
- parsing 46
- dynamic parsing 49
- the entire message 47
- parsing, simultaneous 312
- PASS command, POP3 88, 290
- pipelining (batching commands), SMTP 23
- PIPELINING command, SMTP 23, 140
- POP3 (Post Office Protocol, version 3) 79, 80
- callback mapping 83
- commands
- DELE 284
- LIST 90, 288, 289, 301, 302
- NOOP 289
- PASS 88, 290
- QUIT 93, 292
- RETR 92, 293
- RSET 293
- STAT 89, 299
- supported in SDK 106
- TOP 91, 300
- UIDL 301, 302
- USER 88, 302
- XAUTHLIST 303, 304
- XSENDER 305
- data structures 305
- functions with callbacks 84
- functions, complete list 282
- in SDK 2
- list of RFCs 16
- response codes 82
- session states 80
- session states and commands 81
- sessions 82
- supported protocol commands 106
- pop3_connect function 283
- pop3_delete function 284
- pop3_disconnect function 285
- pop3_free function 285
- pop3_get_option function 286
- pop3_initialize function 287
- pop3_list function 287
- pop3_listA function 288
- pop3_noop function 289
- pop3_pass function 290
- pop3_processResponses function 291
- pop3_quit function 291
- pop3_reset function 292
- pop3_retrieve function 293
- pop3_sendCommand function 294
- pop3_set_option function 295
- pop3_setChunkSize function 295
- pop3_setResponseSink function 296
- pop3_setTimeout function 297
- pop3_stat function 299
- pop3_top function 300
- pop3_uidList function 300
- pop3_uidListA function 301
- pop3_user function 302
- pop3_xAuthList function 303
- pop3_xAuthListA function 303
- pop3_xSender function 304
- pop3Client_t structure 305
- pop3Sink_free function 298
- pop3Sink_initialize function 298
- pop3Sink_t structure 306
- Protocol APIs 1
- and Internet Protocols 3, 101
- combining 2
- commands supported in SDK 101
- IMAP4 60
- in the SDK 1
- POP3 80
- SMTP 14
Q
- QUIT command
- POP3 93, 292
- SMTP 27, 133
- Quoted Printable encoding 33
R
- RCPT TO command, SMTP 25, 134
- recipients, setting, SMTP 25
- RENAME command, IMAP4 242
- requesting server capabilities
- IMAP4 69
- SMTP 22
- response codes
- POP3 82
- SMTP 15
- response sinks 5
- creating, IMAP4 66
- creating, POP3 85
- creating, SMTP 19
- freeing, IMAP4 66
- freeing, POP3 86
- freeing, SMTP 20
- RETR command, POP3 92, 293
- retrieving a message header, POP3 91
- retrieving a message, POP3 92
- RFCs (Request for Comments)
- IMAP4 15
- MIME 15
- POP3 16
- SMTP 15
- RSET command, POP3 293
- running the dynamic parser 53
S
- SDK files 4
- SEARCH command, IMAP4 72, 254, 261
- searching for messages, IMAP4 72
- SELECT command, IMAP4 243
- Selected state
- functions with callbacks 64
- in IMAP4 session 61
- protocol commands 61
- sending the message, SMTP 26
- servers
- connecting to, IMAP4 67
- connecting to, POP3 87
- connecting to, SMTP 21
- determining ESMTP support 22
- determining server extensions, IMAP4 69
- determining server extensions, SMTP 22
- disconnecting from, IMAP4 68
- disconnecting from, POP3 87
- disconnecting from, SMTP 22
- requesting capabilities, IMAP4 69
- session states
- in IMAP4 sessions 60
- in POP3 sessions 80
- sessions
- ending, IMAP4 74
- ending, POP3 93
- ending, SMTP 27
- SETACL command, IMAP4 269
- setting
- mailers, SMTP 24
- recipients, SMTP 25
- shared definitions 109
- SMTP (Simple Mail Transfer Protocol) 14
- callback mapping 17
- commands
- DATA 124, 125
- EHLO 21, 22, 127, 135
- EXPN 128
- HELP 130
- MAIL FROM 24, 131
- NOOP 132
- PIPELINING 23, 140
- QUIT 27, 133
- RCPT TO 25, 134
- VRFY 142
- commands, supported in SDK 102
- data structures 144
- functions with callbacks 17
- functions, listed 122
- in SDK 2
- list of RFCs 15
- Reply Codes, listed 16
- response codes 15
- sessions 15
- supported protocol commands 102
- smtp_bdat function 123
- smtp_connect function 124
- smtp_data function 125
- smtp_disconnect function 126
- smtp_ehlo function 126
- smtp_expand function 127
- smtp_free function 128
- smtp_get_option function 128
- smtp_help function 129
- smtp_initialize function 130, 143
- smtp_mailFrom function 131
- smtp_noop function 131
- smtp_processReponses 132
- smtp_quit function 133
- smtp_rcptTo function 134
- smtp_reset function 135
- smtp_send function 135
- smtp_sendCommand function 136
- smtp_sendStream function 137
- smtp_set_option function 138
- smtp_setChunkSize function 138
- smtp_setPipelining function 139
- smtp_setResponseSink function 140
- smtp_setTimeout function 141
- smtp_verify function 142
- smtpClient_t structure 144
- smtpSink_free function 143
- smtpSink_t structure 145
- STAT command, POP3 89, 299
- STATUS command, IMAP4 244
- STORE command, IMAP4 257, 262
- structures
- file_mime_type 201
- IMAP4 270
- imap4Client_t 270
- imap4Sink_t 270
- MIME 201
- mime_basicPart_t 202
- mime_header_t 203
- mime_inputstream_t 204
- mime_message_t 205
- mime_messagePart_t 205
- mime_multiPart_t 207
- mime_outputstream_t 208
- mimeDataSink_t 208
- nsmail_inputstream_t 114
- nsmail_io_fns_t 113
- nsmail_outputstream_t 115
- POP3 305
- pop3Client_t 305
- pop3Sink_t 306
- SMTP 144
- smtpClient_t 144
- smtpSink_t 145
- SUBSCRIBE command, IMAP4 245
- supported platforms
- Messaging Access SDK 5
T
- text conventions 14
- thread safety 311
- TOP command, POP3 91, 300
- Transaction state
- in POP3 session 81
- protocol commands 81
- type definitions, MIME 215
U
- UID command, IMAP4 72, 74, 258, 260, 261, 262
- UIDL command, POP3 301, 302
- Unix, compiling the SDK 10
- UNSUBSCRIBE command, IMAP4 246
- Update state
- in POP3 session 81
- protocol commands 81
- USER command, POP3 88, 302
V
- VRFY command, SMTP 142
X
- XAUTHLIST command, POP3 303, 304
- XSENDER command, POP3 305
Table of Contents | Previous
Last Updated: June 3, 1998
Copyright © 1998
Netscape Communications Corporation