|
|
|
|
Scroll up for Table of Contents
Note to Authors: Refer to the Authoring Instruction page  for guidelines. When you are ready to publish to the web, contact your Support Education representative.
Note to Readers: The information in this article is IBM Internal only. Refer to the PRTE_Externalization_Guide before sharing this information with customers. More information on the externalized version of this content can be found in the Externalization section below.
1. Overview
OPTIONAL SECTION
A brief synopsis and description of assumed technical expertise. Complete this section if you are interested in receiving author recognition points.
The purpose of this article is to explain the new IMAP view and folder synching feature which is new optional IMAP feature in 8.52.
In pre-8.52 Domino IMAP environments and those who have this feature turned off in 8.52 mail messages that appear in the Sent, Drafts, and Trash IMAP folders do not stay in sync with the Notes client Sent, Drafts, and Trash views. The reason for this is when an IMAP client Sends, Saves and Draft, or deletes a mail messages the messages are then stored in the special IMAP corresponding Sent, Draft, or Trash folder in the Notes mail database. Or when a Notes client Sends, Saves as Draft, or deletes a mail message the message is stored in the corresponding Sent, Draft, or Trash view. Since the IMAP client only deposits mail messages in the special IMAP folders and the Notes client only deposits them in views then a user who used both IMAP clients and Notes client will never have these folders and views synchronized.
When referring to this article you should be familiar with how Domino can support IMAP clients. You also will need to be familiar with how IMAP clients work.
Back to top
2. Functionality
REQUIRED SECTION
If this is a new feature, provide a high-level functional overview. Or, if this is an update to an existing feature, provided an overview of changes in this version. You may link to other information, for example from the draft InfoCenter.
2a. Functional overview
To enable this feature you will need to do the following:
- Add the following notes ini parameter to the server that will be servicing the IMAP clients that want this feature turned on: EnableImapFolderSynch=1
- Upgrade the mail templates to the latest mail template included with 8.52.
- Make sure that the IMAP client subscribes to the new hidden folders that are new to 8.52 mail template. The folder names need to match exactly.
2b. Functional changes in this release
Back to top
3. Architecture
OPTIONAL SECTION
If this is a new feature, provide a high-level architectural overview. Or, if this is an update to an existing feature, provided an overview of changes in this version. You may link to other information, for example from the draft InfoCenter.
3a. Architectural overview
In order to understand the new architecture you need to understand how Domino traditionally communicated with IMAP clients. Since IMAP clients use the concept of folders
There were two major changes in order to get this feature to work.
The first was to change the IMAP server to make sure all Sent, Draft, and Trash messages that are sent, saved as draft or deleted in the IMAP client to qualify for their corresponding Sent, Draft, or Trash views. Previously these messages were simply deposited in special IMAP folders and the user would not see them in the views when reading mail in their Notes/inotes client.
The second change was to make sure messages Sent, saved as draft, or deleted messages from the Notes/iNotes client can be seen in the proper folders in the IMAP client. The was accomplished on the server side of Note update by depositing the messages based on view qualification into their corresponding IMAP folders. The messages need to be in the special IMAP folder because that is how the IMAP client synchronizes with Notes database.
3b. Architectural changes in this release
Back to top
4. Deployment Considerations
OPTIONAL SECTION
Describe any deployment considerations that impact the feature.
4a. Planning
4b. Install and Upgrade
Institute ini variable on build 8.52 or later: EnableIMAPFolderSynch=1
Upgrade to the latest mail template (mail85.ntf)
4c. Configuration
NOTE: For the iMac Mail application to work a special folder will need to be created or renamed via the Designer client to "Sent Messages" on the TEMPLATE.
Back to top
5. Data Collection
REQUIRED SECTION
Imagine you've just received an issue escalated from a PMR. What sorts of data would you want attached to the APAR? How do you efficiently and accurately gather that information?
Gather a DUMPIMAP report. Can be run with certain switches (outlined below) which gather particular information of the given mail file. Can direct all information to an output file which will generally list all folders and contents (depending on switches utilized).
dumpimap filename [foldername] [options]
Dumps IMAP folders in the specified file
Options are:
-a Show all IMAP folders
-b Brief summary select info only
-D[n] Dump one or all note references (ex: -D300 or -D0x12C)
-f Show only folder names
-n Dont show subfolders
-s[n] Start sequence number (ex: -s100)
-t Turn off printing of flag strings
-u[username] Show seen flags for user specified, current user if blank
-v Scan IMAP index and verify contents with folder and notes
-V[n] Scan notes and verify folder refs with IMAP index entries
**** Switches most useful are the -a, -f, -v and -V. Can be used together or individually against mail files *********
DUMPIMAP (path) Trash -V > (path of output file)
DUMPIMAP (path) -a -v > (path of output file)
Dumpimap (path) -a -b | more
Dumpimap Trash -V > (SPECIFIC FOLDER)
Dumpimap -b -n -h
5a. Must gathers
What information should be gathered when troubleshooting this feature
For a crash an NSD is a must be gathered. The process crashing could be the IMAP task if the crash occurred during IMAP client communication. Or if the crash is occurring on Notes side when depositing messages in the special IMAP folders it could be the server task or if iNotes http task.
If the problem is in improper synchronization a good place to start troubleshooting is the special hidden IMAP folders. These can be viewed by holding the shift and cntl down and choosing the View menu option and then Go to. You should then see all the hidden folder in the mail database. Once you can see the hidden folder you can check the messages that should or shouldn't be there.
Debug.out file should accompany PMR/SPR's.
5b. Running trace
How to run a trace
What traces to run and in what circumstances
5c. Generating log files
How to gather log files (cite automatic data gathering tools where possible)
ini variable "Debug_outfile= (path)"
What log files to gather and in what circumstances
5d. Using debug
How to initiate debug:
ini variables
What debug settings to use and in what circumstances:
IMAPDebug=1
IMAPDebugIO=2
Use to gauge all IMAP activity. Use primarilly to trace or track down certain conditions or problems (Examine what client commands are being sent).
Debug performance considerations: Larger logs, very slight performance spike.
Back to top
6. Troubleshooting
REQUIRED SECTION
Imagine you've just received an issue escalated from a PMR. What sorts of analysis would you want Support to have performed? How do you efficiently and accurately perform the analysis?
6a. Diagnostic process
You know that all is going correctly if....
You know there is a problem if....
Diagnostic tools and techniques
6b. Customer interaction
Questions to ask that can help identify the cause of the problem
Tasks the customer can perform to help identify the problem
6c. Log interpretation
Where to find the log and trace files
How to interpret the log and trace files
You know it's time to escalate a problem when...
6d. Common errors and workarounds
Incompatible or mixed environments
Sequencing issues
Clean up
Configuration
Third-party issues
Back to top
7. Known Issues
REQUIRED SECTION
Include information on planned fixes and deferrals
7a. Beta forum feedback
7b. Deferred SPRs
Back to top
8. Additional Resources
REQUIRED SECTION
Where can support go for more information?
8a. Websites and Forums
8b. Papers and Presentations
8c. Databases and Communities
8d. Contact information
Back to top
9. Summary
OPTIONAL SECTION
A brief recap for the reader. Complete this section if you are interested in receiving author recognition points.
Back to top
10. About the Author
OPTIONAL SECTION
Include your title, where you work, how long you have worked with the subject technology, educational background, or outside of work interests. Complete this section if you are interested in receiving author recognition points.
Back to top
Externalization
This section is for administrative use only.
E2E db doc | External Asset | Asset Status | Externalizer | Date | Comments |
insert doclink here | link to article, technote, etc. | DRAFT or PUBLISHED | enter name here | planned or target | which sections externalized |
Back to top
|
|
|
|