Description
This function lists character encodings that the mail server supports.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/get_charsets
https://hostname.example.com:2083/cpsess##########/execute/Email/get_charsets
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once. // Get a list of character encodings.$encodings_list = $cpanel->uapi( 'Email', 'get_charsets'); LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once. # Get a list of character encodings.my $encodings_list = $cpliveapi->uapi( 'Email', 'get_charsets',); cPanel Template Toolkit
<!-- Get a list of character encodings. -->[% execute('Email', 'get_charsets' ) %] |
Command Line
uapi --user=username Email get_charsets |
Notes:
- You must URI-encode values.
- username represents your account-level username.
Output (JSON)
{ "messages":null, "errors":null, "status":1, "metadata":{ "transformed":1 }, "data":[ "ansi_x3.110-1983", "ansi_x3.4-1968", "armscii-8", "asmo_449", "big5", "big5-hkscs", "brf", "bs_4730", "bs_viewdata", "cp10007", "cp1125", "cp1250", "cp1253", "cp1254", "cp1255", "cp1256", "cp1257", "cp1258", "cp737", "cp775", "csa_z243.4-1985-1", "csa_z243.4-1985-2", "csa_z243.4-1985-gr", "csn_369103", "cwi", "dec-mcs", "din_66003", "ds_2089", "ebcdic-at-de", "ebcdic-at-de-a", "ebcdic-ca-fr", "ebcdic-dk-no", "ebcdic-dk-no-a", "ebcdic-es", "ebcdic-es-a", "ebcdic-es-s", "ebcdic-fi-se", "ebcdic-fi-se-a", "ebcdic-fr", "ebcdic-is-friss", "ebcdic-it", "ebcdic-pt", "ebcdic-uk", "ebcdic-us", "ecma-cyrillic", "es", "es2", "euc-jisx0213", "euc-jp", "euc-jp-ms", "euc-kr", "euc-tw", "gb18030", "gb2312", "gb_1988-80", "gbk", "georgian-academy", "georgian-ps", "gost_19768-74", "greek-ccitt", "greek7", "greek7-old", "gsm03.38", "hp-greek8", "hp-roman8", "hp-roman9", "hp-thai8", "hp-turkish8", "hz-gb-2312", "ibm037", "ibm038", "ibm1004", "ibm1026", "ibm1047", "ibm1124", "ibm1129", "ibm1132", "ibm1133", "ibm1160", "ibm1161", "ibm1162", "ibm1163", "ibm1164", "ibm256", "ibm273", "ibm274", "ibm275", "ibm277", "ibm278", "ibm280", "ibm281", "ibm284", "ibm285", "ibm290", "ibm297", "ibm420", "ibm423", "ibm424", "ibm437", "ibm500", "ibm850", "ibm851", "ibm852", "ibm855", "ibm856", "ibm857", "ibm860", "ibm861", "ibm862", "ibm863", "ibm864", "ibm865", "ibm866", "ibm866nav", "ibm868", "ibm869", "ibm870", "ibm871", "ibm874", "ibm875", "ibm880", "ibm891", "ibm903", "ibm904", "ibm905", "ibm918", "ibm922", "iec_p27-1", "inis", "inis-8", "inis-cyrillic", "invariant", "isiri-3342", "iso-8859-1", "iso-8859-10", "iso-8859-11", "iso-8859-13", "iso-8859-14", "iso-8859-15", "iso-8859-16", "iso-8859-2", "iso-8859-3", "iso-8859-4", "iso-8859-5", "iso-8859-6", "iso-8859-7", "iso-8859-8", "iso-8859-9", "iso-8859-9e", "iso-ir-197", "iso-ir-209", "iso-ir-90", "iso_10367-box", "iso_10646", "iso_11548-1", "iso_2033-1983", "iso_5427", "iso_5427-ext", "iso_5428", "iso_646.basic", "iso_646.irv", "iso_6937", "iso_6937-2-25", "iso_6937-2-add", "iso_8859-1,gl", "iso_8859-supp", "it", "jis_c6220-1969-jp", "jis_c6220-1969-ro", "jis_c6229-1984-a", "jis_c6229-1984-b", "jis_c6229-1984-b-add", "jis_c6229-1984-hand", "jis_c6229-1984-hand-add", "jis_c6229-1984-kana", "jis_x0201", "johab", "jus_i.b1.002", "jus_i.b1.003-mac", "jus_i.b1.003-serb", "koi-8", "koi8-r", "koi8-ru", "koi8-t", "koi8-u", "ks_c_5601-1987", "ksc5636", "latin-greek", "latin-greek-1", "mac-centraleurope", "mac-cyrillic", "mac-is", "mac-sami", "mac-uk", "macintosh", "mik", "msz_7795.3", "nats-dano", "nats-dano-add", "nats-sefi", "nats-sefi-add", "nc_nc00-10", "nextstep", "nf_z_62-010", "nf_z_62-010_1973", "ns_4551-1", "ns_4551-2", "pt", "pt154", "pt2", "rk1048", "sami", "sami-ws2", "sen_850200_b", "sen_850200_c", "shift_jis", "shift_jisx0213", "t.101-g2", "t.61-7bit", "t.61-8bit", "tcvn5712-1", "tis-620", "tscii", "us-ascii", "utf-7", "utf-8", "videotex-suppl", "viscii", "windows-1251", "windows-1252", "windows-31j" ]}
Note:
Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
This function does not accept parameters.
Returns
|
Return |
Type |
Description |
Possible values |
Example |
|
data |
array |
An array of character encodings that the mailserver supports. |
The name of a character encoding. |
utf-8 |