1        Cone©
2
3MAIL::ACCOUNT::TRANS(3x)Cone: COnsole Newsreader And EMAIL::ACCOUNT::TRANS(3x)
4
5
6

NAME

8       mail::ACCOUNT::translatePath - Convert readable folder path to internal
9       folder path
10

SYNOPSIS

12       #include <libmail/sync.H>
13
14       mail::ACCOUNT *mail;
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, IMAP
21       server mailboxes use names encoded in a modified version of the UTF-7
22       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[1]
27           folderPath is converted from application's character set to the
28           modified UTF-7 character set.
29
30       SMAP
31           folderPath is converted from application's character set to UTF-8.
32           The forward slash character, “/” separates names of individual
33           folders in the SMAP hierarchy. Unicode/ISO-10646 characters that
34           cannot be represented in the application's character set may be
35           specified as “%n;”, where n is a decimal Unicode value. Use “\/” to
36           specify a forward slash character in the folder name, “\\” to
37           specify a backslash character, and “\%” to specify the “%”
38           character.
39
40       mbox mail folders, and maildirs
41           folderPath is converted from application's character set to
42           modified UTF-7 encoding. The forward slash character, “/” separates
43           names of individual folders in the local mail folder hierarchy.
44           Unicode/ISO-10646 characters that cannot be represented in the
45           application's character set may be specified as “%n;”, where n is a
46           decimal Unicode value. Use “\\” to specify a backslash character,
47           and “\%” to specify the “%” character.
48

RETURN CODES AND CALLBACKS

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

SEE ALSO

54       mail::ACCOUNT::getFolderFromPath(3x),
55       mail::ACCOUNT::getFolderFromString(3x), mail::setAppCharset(3x).
56

AUTHOR

58       Sam Varshavchik
59

NOTES

61        1. IMAP
62           http://www.rfc-editor.org/rfc/rfc3501.txt
63
64
65
66Cone©                             08/25/2016          MAIL::ACCOUNT::TRANS(3x)
Impressum