1mail::account::translatmeaPialt:h:(a3cxc)ount Native APImraeifle:r:eanccceount::translatePath(3x)
2
3
4

NAME

6       mail::account::translatePath - Convert readable folder path to internal
7       folder path
8

SYNOPSIS

10       std::string folderPath=folder->getPath();
11
12
13
14       std::string path=account->translatePath (std::string folderPath);
15

USAGE

17       This function converts a human-readable representation  of  a  folder's
18       path  to  the  internal  folder path in the mail account.  For example,
19       IMAP server mailboxes use names encoded in a modified  version  of  the
20       UTF-7  character  set,  and this method converts a folder path from the
21       application's character  set  to  the  modified  UTF-7  character  set.
22       Specifically:
23
24       IMAP   folderPath  is converted from application's character set to the
25              modified UTF-7 character set.
26
27       SMAP   folderPath is converted  from  application's  character  set  to
28              UTF-8.   The  forward  slash character, ``/'' separates names of
29              individual folders in  the  SMAP  hierarchy.   Unicode/ISO-10646
30              characters that cannot be represented in the application's char‐
31              acter set may be specified as ``%n;'', where n is a decimal Uni‐
32              code  value.  Use ``\/'' to specify a forward slash character in
33              the folder name, ``\\'' to specify a  backslash  character,  and
34              ``\%'' to specify the ``%'' character.
35
36       mbox mail folders, and maildirs
37              folderPath is converted from application's character set to mod‐
38              ified UTF-7 encoding.  The forward slash character, ``/''  sepa‐
39              rates names of individual folders in the local mail folder hier‐
40              archy.  Unicode/ISO-10646 characters that cannot be  represented
41              in  the application's character set may be specified as ``%n;'',
42              where n is a decimal Unicode value.  Use  ``\\''  to  specify  a
43              backslash character, and ``\%'' to specify the ``%'' character.
44

RETURN CODES AND CALLBACKS

46       This  function  returns  the converted path string.  An empty string is
47       returned if folderPath is not a valid folder path.
48

SEE ALSO

50       mail::account::findfolder(3x),     mail::account::folderFromString(3x),
51       mail::setAppCharset(3x).
52
53
54
55                                 10 April 2006mail::account::translatePath(3x)
Impressum