1mail::ACCOUNT::translmaatielP:a:tAhC(C3OxU)NT Synchronous AmPaIilr:e:fAeCrCeOnUcNeT::translatePath(3x)
2
3
4

NAME

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

SYNOPSIS

10       #include <libmail/sync.H>
11
12       mail::ACCOUNT *mail;
13
14
15
16       std::string path=mail->translatePath (std::string folderPath);
17

USAGE

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

RETURN CODES AND CALLBACKS

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

SEE ALSO

52       mail::ACCOUNT::getFolderFromPath(3x),     mail::ACCOUNT::getFolderFrom‐
53       String(3x), mail::setAppCharset(3x).
54
55
56
57                                 10 April 2006mail::ACCOUNT::translatePath(3x)
Impressum