46 The commands fall into a number of categories: |
46 The commands fall into a number of categories: |
47 |
47 |
48 - Connect and logon to remote server: |
48 - Connect and logon to remote server: |
49 - #KIMAP4MTMConnect |
49 - #KIMAP4MTMConnect |
50 - #KIMAP4MTMDisconnect |
50 - #KIMAP4MTMDisconnect |
|
51 - #KIMAP4MTMSilentConnect |
51 - Synchronise headers: |
52 - Synchronise headers: |
52 - #KIMAP4MTMCancelBackgroundSynchronise |
53 - #KIMAP4MTMCancelBackgroundSynchronise |
53 - #KIMAP4MTMConnectAndSyncCompleteAfterConnect |
54 - #KIMAP4MTMConnectAndSyncCompleteAfterConnect |
54 - #KIMAP4MTMConnectAndSyncCompleteAfterDisconnect |
55 - #KIMAP4MTMConnectAndSyncCompleteAfterDisconnect |
55 - #KIMAP4MTMConnectAndSyncCompleteAfterFullSync |
56 - #KIMAP4MTMConnectAndSyncCompleteAfterFullSync |
57 - #KIMAP4MTMFolderFullSync |
58 - #KIMAP4MTMFolderFullSync |
58 - #KIMAP4MTMFullSync |
59 - #KIMAP4MTMFullSync |
59 - #KIMAP4MTMInboxNewSync |
60 - #KIMAP4MTMInboxNewSync |
60 - #KIMAP4MTMSynchronise |
61 - #KIMAP4MTMSynchronise |
61 - #KIMAP4MTMWaitForBackground |
62 - #KIMAP4MTMWaitForBackground |
|
63 - #KIMAP4MTMSilentConnectAndSynchronise |
|
64 - #KIMAP4MTMSilentConnectAndSyncCompleteAfterFullSync |
62 - Subscribe to mailboxes: |
65 - Subscribe to mailboxes: |
63 - #KIMAP4MTMLocalSubscribe |
66 - #KIMAP4MTMLocalSubscribe |
64 - #KIMAP4MTMLocalUnsubscribe |
67 - #KIMAP4MTMLocalUnsubscribe |
65 - Populate messages: |
68 - Populate messages: |
66 - #KIMAP4MTMPopulate |
69 - #KIMAP4MTMPopulate |
151 /** Connects to the specified IMAP service. |
154 /** Connects to the specified IMAP service. |
152 |
155 |
153 This makes a network connection and logs on the IMAP server specified |
156 This makes a network connection and logs on the IMAP server specified |
154 in the settings for the service. |
157 in the settings for the service. |
155 |
158 |
|
159 Command KIMAP4MTMSilentConnect is also available to silently connect to the network. |
|
160 |
156 @c aSelection: @c aSelection[0] should contain the entry ID of the service |
161 @c aSelection: @c aSelection[0] should contain the entry ID of the service |
157 to connect to. |
162 to connect to. |
158 |
163 |
159 @c aParameter: packages a pointer to an implementation of the connection observer |
164 @c aParameter: packages a pointer to an implementation of the connection observer |
160 interface, MMsvImapConnectionObserver. Callbacks are made to this interface |
165 interface, MMsvImapConnectionObserver. Callbacks are made to this interface |
172 |
177 |
173 /** Connects to the specified IMAP service, and starts a background synchronisation. |
178 /** Connects to the specified IMAP service, and starts a background synchronisation. |
174 |
179 |
175 The call completes when the connection occurs and the synchronisation starts. See |
180 The call completes when the connection occurs and the synchronisation starts. See |
176 CImap4ClientMtm for a description of a background synchronisation. |
181 CImap4ClientMtm for a description of a background synchronisation. |
|
182 |
|
183 Command KIMAP4MTMSilentConnectAndSynchronise is also available to silently connect to the network. |
177 |
184 |
178 @c aSelection: @c aSelection[0] should contain the entry ID of the service |
185 @c aSelection: @c aSelection[0] should contain the entry ID of the service |
179 to connect to. |
186 to connect to. |
180 |
187 |
181 @c aParameter: packages a pointer to an implementation of the connection observer |
188 @c aParameter: packages a pointer to an implementation of the connection observer |
489 /** Connect and synchronise the specified service, and complete after synchronisation. |
496 /** Connect and synchronise the specified service, and complete after synchronisation. |
490 |
497 |
491 This is similar to KIMAP4MTMConnectAndSynchronise, except that the operation |
498 This is similar to KIMAP4MTMConnectAndSynchronise, except that the operation |
492 does not complete until synchronisation is complete. |
499 does not complete until synchronisation is complete. |
493 |
500 |
|
501 Command KIMAP4MTMSilentConnectAndSyncCompleteAfterFullSync is also available to |
|
502 silently connect to the network. |
|
503 |
494 @c aSelection: @c aSelection[0] should contain the entry ID of the service |
504 @c aSelection: @c aSelection[0] should contain the entry ID of the service |
495 to connect to. |
505 to connect to. |
496 |
506 |
497 @c aParameter: packages a pointer to an implementation of the connection observer |
507 @c aParameter: packages a pointer to an implementation of the connection observer |
498 interface, MMsvImapConnectionObserver. Callbacks are made to this interface |
508 interface, MMsvImapConnectionObserver. Callbacks are made to this interface |
1074 message creation flags and message type. |
1084 message creation flags and message type. |
1075 |
1085 |
1076 The operation object returned is a CImEmailOperation. Final progress information |
1086 The operation object returned is a CImEmailOperation. Final progress information |
1077 from this contains the ID of the newly created message. |
1087 from this contains the ID of the newly created message. |
1078 */ |
1088 */ |
1079 KIMAP4MTMCreateReceiptEmailMessage |
1089 KIMAP4MTMCreateReceiptEmailMessage, |
|
1090 |
|
1091 /** Connects to the specified IMAP service. |
|
1092 |
|
1093 This makes a network connection and logs on the IMAP server specified |
|
1094 in the settings for the service. |
|
1095 |
|
1096 This differs from KIMAP4MTMConnect by connecting to the network silently, without prompting the user. |
|
1097 |
|
1098 @c aSelection: @c aSelection[0] should contain the entry ID of the service |
|
1099 to connect to. |
|
1100 |
|
1101 @c aParameter: packages a pointer to an implementation of the connection observer |
|
1102 interface, MMsvImapConnectionObserver. Callbacks are made to this interface |
|
1103 to notify the client of the stages of connection. |
|
1104 |
|
1105 Completion: KErrBusy if the device is already connected to the specified server. |
|
1106 |
|
1107 Example: |
|
1108 @code |
|
1109 TBuf8<1> parameter; |
|
1110 iOperation = iClientMtm->InvokeAsyncFunctionL(KIMAP4MTMSilentConnect, *iServiceSelection, parameter, iStatus); |
|
1111 @endcode |
|
1112 */ |
|
1113 KIMAP4MTMSilentConnect, |
|
1114 |
|
1115 /** Connects to the specified IMAP service, and starts a background synchronisation. |
|
1116 |
|
1117 The call completes when the connection occurs and the synchronisation starts. See |
|
1118 CImap4ClientMtm for a description of a background synchronisation. |
|
1119 |
|
1120 This differs from KIMAP4MTMConnectAndSynchronise by connecting to the network silently, without prompting the user. |
|
1121 |
|
1122 @c aSelection: @c aSelection[0] should contain the entry ID of the service |
|
1123 to connect to. |
|
1124 |
|
1125 @c aParameter: packages a pointer to an implementation of the connection observer |
|
1126 interface, MMsvImapConnectionObserver. Callbacks are made to this interface |
|
1127 to notify the client of the stages of connection and synchronisation. |
|
1128 |
|
1129 Completion: KErrBusy if the device is already connected to the specified server. |
|
1130 |
|
1131 Example: |
|
1132 @code |
|
1133 TPckg<MMsvImapConnectionObserver*> parameter(this); |
|
1134 iOperation = iClientMtm->InvokeAsyncFunctionL(KIMAP4MTMSilentConnectAndSynchronise, *iServiceSelection, parameter, iStatus); |
|
1135 @endcode |
|
1136 */ |
|
1137 KIMAP4MTMSilentConnectAndSynchronise, |
|
1138 |
|
1139 /** Connect and synchronise the specified service, and complete after synchronisation. |
|
1140 |
|
1141 This is similar to KIMAP4MTMConnectAndSyncCompleteAfterFullSync except that it will not |
|
1142 prompt the user while connecting. |
|
1143 |
|
1144 @c aSelection: @c aSelection[0] should contain the entry ID of the service |
|
1145 to connect to. |
|
1146 |
|
1147 @c aParameter: packages a pointer to an implementation of the connection observer |
|
1148 interface, MMsvImapConnectionObserver. Callbacks are made to this interface |
|
1149 to notify the client of the stages of connection and synchronisation. |
|
1150 |
|
1151 Completion: KErrBusy if a connected session already exists. |
|
1152 */ |
|
1153 KIMAP4MTMSilentConnectAndSyncCompleteAfterFullSync |
|
1154 |
1080 }; |
1155 }; |
1081 |
1156 |
1082 #endif |
1157 #endif |