Create email account mobile profile configuration

This function generates a mobile configuration profile for an email account.

Important:

When you disable the Receive Mail role, the system disables this function.

Authorizations:
query Parameters
account
required
string

The email account's username.

Example: account=username
use_ssl
required
integer

Whether to use an SSL-encrypted connection.

  • 1 — Use an SSL-encrypted connnection.
  • 0 — Do not use an SSL-encrypted connection.
Enum: 0 1
Example: use_ssl=1
selected_account_services
string
Default: "email,caldav,carddav"

A comma-separated list of the email account service's .mobileconfig file names.

  • caldav — The .mobileconfig file for calendar setup.
  • carddav — The .mobileconfig file for contacts setup.
  • email — The .mobileconfig file for email setup.

Note:

  • If you don't specify a value, this parameter uses the default values.
  • You can request one, two, or all possible values.
  • The function ignores unsupported values.
Enum: "caldav" "carddav" "email"
Example: selected_account_services=email

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  generate_mobileconfig \
  account='username' \
  use_ssl='1'

Response samples

Content type
application/json
{
  • "data": {
    • "payload": "MIIcIwYJKoZIhvcNAQcCoIIcFDCCHBACAQExDzANBglghkgBZQMEAgEFADCCFS4GCSqGSIb3DQEH\nAaCCFR8EghUbPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjwhRE9DVFlQ\nRSBwbGlzdCBQVUJMSUMgIi0vL0FwcGxlLy9EVEQgUExJU1QgMS4wLy9FTiIgImh0dHA6Ly93d3cu\nYXBwbGUuY29tL0RURHMvUHJvcGVydHlMaXN0LTEuMC5kdGQiPg0KPHBsaXN0IHZlcnNpb249IjEu\nMCI+DQo8ZGljdD4NCiAgPGtleT5QYXlsb2FkQ29udGVudDwva2V5Pg0KICA8YXJyYXk+DQogICAg\nPGRpY3Q+DQogICAgICAgIDxrZXk+Q2FsREFWQWNjb3VudERlc2NyaXB0aW9uPC9rZXk+DQogICAg\nICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwvc3Ry\naW5nPg0KICAgICAgICA8a2V5PkNhbERBVkhvc3ROYW1lPC9rZXk+DQogICAgICAgIDxzdHJpbmc+\naG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwvc3RyaW5nPg0KICAgICAgICA8a2V5PkNh\nbERBVlBvcnQ8L2tleT4NCiAgICAgICAgPGludGVnZXI+ODQ0MzwvaW50ZWdlcj4NCiAgICAgICAg\nPGtleT5DYWxEQVZQcmluY2lwYWxVUkw8L2tleT4NCiAgICAgICAgPHN0cmluZz4vcHJpbmNpcGFs\ncy9fX3VpZHNfXy8vPC9zdHJpbmc+DQogICAgICAgIDxrZXk+Q2FsREFWVXNlU1NMPC9rZXk+DQog\nICAgICAgIDx0cnVlLz4NCiAgICAgICAgPGtleT5DYWxEQVZVc2VybmFtZTwva2V5Pg0KICAgICAg\nICA8c3RyaW5nPnVzZXJuYW1lPC9zdHJpbmc+DQogICAgICAgIDxrZXk+UGF5bG9hZERlc2NyaXB0\naW9uPC9rZXk+DQogICAgICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0xMS5hc2hs\nZXk4MnNiLnRsZCBTZWN1cmUgQ2FsZW5kYXIgU2V0dXA8L3N0cmluZz4NCiAgICAgICAgPGtleT5Q\nYXlsb2FkRGlzcGxheU5hbWU8L2tleT4NCiAgICAgICAgPHN0cmluZz51c2VybmFtZUBob3N0LTE3\nMi0xNi0xLTExLmFzaGxleTgyc2IudGxkIFNlY3VyZSBDYWxlbmRhciBTZXR1cDwvc3RyaW5nPg0K\nICAgICAgICA8a2V5PlBheWxvYWRJZGVudGlmaWVyPC9rZXk+DQogICAgICAgIDxzdHJpbmc+Y3Bh\nbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0\ncmluZz4NCiAgICAgICAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9uPC9rZXk+DQogICAgICAgIDxz\ndHJpbmc+aG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwvc3RyaW5nPg0KICAgICAgICA8\na2V5PlBheWxvYWRUeXBlPC9rZXk+DQogICAgICAgIDxzdHJpbmc+Y29tLmFwcGxlLmNhbGRhdi5h\nY2NvdW50PC9zdHJpbmc+DQogICAgICAgIDxrZXk+UGF5bG9hZFVVSUQ8L2tleT4NCiAgICAgICAg\nPHN0cmluZz4wNWQ3OTBjMS03MjVlLTIxODUtMDM1YS0yODNiZGJkMDUxMWQ8L3N0cmluZz4NCiAg\nICAgICAgPGtleT5QYXlsb2FkVmVyc2lvbjwva2V5Pg0KICAgICAgICA8aW50ZWdlcj4xPC9pbnRl\nZ2VyPg0KICAgIDwvZGljdD4NCiAgICA8ZGljdD4NCiAgICAgICAgPGtleT5DYXJkREFWQWNjb3Vu\ndERlc2NyaXB0aW9uPC9rZXk+DQogICAgICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYt\nMS0xMS5hc2hsZXk4MnNiLnRsZCBTZWN1cmUgQ29udGFjdHMgU2V0dXA8L3N0cmluZz4NCiAgICAg\nICAgPGtleT5DYXJkREFWSG9zdE5hbWU8L2tleT4NCiAgICAgICAgPHN0cmluZz5ob3N0LTE3Mi0x\nNi0xLTExLmFzaGxleTgyc2IudGxkOjg0NDM8L3N0cmluZz4NCiAgICAgICAgPGtleT5DYXJkREFW\nVXNlU1NMPC9rZXk+DQogICAgICAgIDx0cnVlLz4NCiAgICAgICAgPGtleT5DYXJkREFWVXNlcm5h\nbWU8L2tleT4NCiAgICAgICAgPHN0cmluZz51c2VybmFtZTwvc3RyaW5nPg0KICAgICAgICA8a2V5\nPlBheWxvYWREZXNjcmlwdGlvbjwva2V5Pg0KICAgICAgICA8c3RyaW5nPnVzZXJuYW1lQGhvc3Qt\nMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQgU2VjdXJlIENvbnRhY3RzIFNldHVwPC9zdHJpbmc+\nDQogICAgICAgIDxrZXk+UGF5bG9hZERpc3BsYXlOYW1lPC9rZXk+DQogICAgICAgIDxzdHJpbmc+\nQ2FyZERBVjwvc3RyaW5nPg0KICAgICAgICA8a2V5PlBheWxvYWRJZGVudGlmaWVyPC9rZXk+DQog\nICAgICAgIDxzdHJpbmc+Y3BhbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEu\nYXNobGV5ODJzYi50bGQ8L3N0cmluZz4NCiAgICAgICAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9u\nPC9rZXk+DQogICAgICAgIDxzdHJpbmc+aG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDwv\nc3RyaW5nPg0KICAgICAgICA8a2V5PlBheWxvYWRUeXBlPC9rZXk+DQogICAgICAgIDxzdHJpbmc+\nY29tLmFwcGxlLmNhcmRkYXYuYWNjb3VudDwvc3RyaW5nPg0KICAgICAgICA8a2V5PlBheWxvYWRV\nVUlEPC9rZXk+DQogICAgICAgIDxzdHJpbmc+Y2U0YTRiYjEtODQ3Yi1hYWQ0LWVkMTUtNzIyMDY2\nMzA5YzIyPC9zdHJpbmc+DQogICAgICAgIDxrZXk+UGF5bG9hZFZlcnNpb248L2tleT4NCiAgICAg\nICAgPGludGVnZXI+MTwvaW50ZWdlcj4NCiAgICA8L2RpY3Q+DQogICAgPGRpY3Q+DQogICAgICA8\na2V5PkVtYWlsQWNjb3VudERlc2NyaXB0aW9uPC9rZXk+DQogICAgICA8c3RyaW5nPnVzZXJuYW1l\nQGhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0cmluZz4NCiAgICAgIDxrZXk+RW1h\naWxBY2NvdW50TmFtZTwva2V5Pg0KICAgICAgPHN0cmluZz51c2VybmFtZUBob3N0LTE3Mi0xNi0x\nLTExLmFzaGxleTgyc2IudGxkPC9zdHJpbmc+DQogICAgICA8a2V5PkVtYWlsQWNjb3VudFR5cGU8\nL2tleT4NCiAgICAgIDxzdHJpbmc+RW1haWxUeXBlSU1BUDwvc3RyaW5nPg0KICAgICAgPGtleT5F\nbWFpbEFkZHJlc3M8L2tleT4NCiAgICAgIDxzdHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0x\nMS5hc2hsZXk4MnNiLnRsZDwvc3RyaW5nPg0KICAgICAgPGtleT5JbmNvbWluZ01haWxTZXJ2ZXJB\ndXRoZW50aWNhdGlvbjwva2V5Pg0KICAgICAgPHN0cmluZz5FbWFpbEF1dGhQYXNzd29yZDwvc3Ry\naW5nPg0KICAgICAgPGtleT5JbmNvbWluZ01haWxTZXJ2ZXJIb3N0TmFtZTwva2V5Pg0KICAgICAg\nPHN0cmluZz5ob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkPC9zdHJpbmc+DQogICAgICA8\na2V5PkluY29taW5nTWFpbFNlcnZlclBvcnROdW1iZXI8L2tleT4NCiAgICAgIDxpbnRlZ2VyPjk5\nMzwvaW50ZWdlcj4NCiAgICAgIDxrZXk+SW5jb21pbmdNYWlsU2VydmVyVXNlU1NMPC9rZXk+DQog\nICAgICA8dHJ1ZS8+DQogICAgICA8a2V5PkluY29taW5nTWFpbFNlcnZlclVzZXJuYW1lPC9rZXk+\nDQogICAgICA8c3RyaW5nPnVzZXJuYW1lPC9zdHJpbmc+DQogICAgICA8a2V5Pk91dGdvaW5nTWFp\nbFNlcnZlckF1dGhlbnRpY2F0aW9uPC9rZXk+DQogICAgICA8c3RyaW5nPkVtYWlsQXV0aFBhc3N3\nb3JkPC9zdHJpbmc+DQogICAgICA8a2V5Pk91dGdvaW5nTWFpbFNlcnZlckhvc3ROYW1lPC9rZXk+\nDQogICAgICA8c3RyaW5nPmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0cmluZz4N\nCiAgICAgIDxrZXk+T3V0Z29pbmdNYWlsU2VydmVyUG9ydE51bWJlcjwva2V5Pg0KICAgICAgPGlu\ndGVnZXI+NDY1PC9pbnRlZ2VyPg0KICAgICAgPGtleT5PdXRnb2luZ01haWxTZXJ2ZXJVc2VTU0w8\nL2tleT4NCiAgICAgIDx0cnVlLz4NCiAgICAgIDxrZXk+T3V0Z29pbmdNYWlsU2VydmVyVXNlcm5h\nbWU8L2tleT4NCiAgICAgIDxzdHJpbmc+dXNlcm5hbWU8L3N0cmluZz4NCiAgICAgIDxrZXk+T3V0\nZ29pbmdQYXNzd29yZFNhbWVBc0luY29taW5nUGFzc3dvcmQ8L2tleT4NCiAgICAgIDx0cnVlLz4N\nCiAgICAgIDxrZXk+UGF5bG9hZERlc2NyaXB0aW9uPC9rZXk+DQogICAgICA8c3RyaW5nPnVzZXJu\nYW1lQGhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQgU2VjdXJlIEVtYWlsIFNldHVwPC9z\ndHJpbmc+DQogICAgICA8a2V5PlBheWxvYWREaXNwbGF5TmFtZTwva2V5Pg0KICAgICAgPHN0cmlu\nZz51c2VybmFtZUBob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkIFNlY3VyZSBFbWFpbCBT\nZXR1cDwvc3RyaW5nPg0KICAgICAgPGtleT5QYXlsb2FkSWRlbnRpZmllcjwva2V5Pg0KICAgICAg\nPHN0cmluZz5jcGFuZWwubWFpbC5vcmcudXNlcm5hbWUuaG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4\nMnNiLnRsZDwvc3RyaW5nPg0KICAgICAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9uPC9rZXk+DQog\nICAgICA8c3RyaW5nPmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQ8L3N0cmluZz4NCiAg\nICAgIDxrZXk+UGF5bG9hZFR5cGU8L2tleT4NCiAgICAgIDxzdHJpbmc+Y29tLmFwcGxlLm1haWwu\nbWFuYWdlZDwvc3RyaW5nPg0KICAgICAgPGtleT5QYXlsb2FkVVVJRDwva2V5Pg0KICAgICAgPHN0\ncmluZz5hNmIzZTAxMC0wMGMxLWIyZjAtYWU4Mi03ZmIzZjllODkzM2Y8L3N0cmluZz4NCiAgICAg\nIDxrZXk+UGF5bG9hZFZlcnNpb248L2tleT4NCiAgICAgIDxpbnRlZ2VyPjE8L2ludGVnZXI+DQog\nICAgICA8a2V5PlByZXZlbnRBcHBTaGVldDwva2V5Pg0KICAgICAgPGZhbHNlLz4NCiAgICAgIDxr\nZXk+UHJldmVudE1vdmU8L2tleT4NCiAgICAgIDxmYWxzZS8+DQogICAgICA8a2V5PlNNSU1FRW5h\nYmxlZDwva2V5Pg0KICAgICAgPGZhbHNlLz4NCiAgICAgIDxrZXk+SW5jb21pbmdNYWlsU2VydmVy\nSU1BUFBhdGhQcmVmaXg8L2tleT4NCiAgICAgIDxzdHJpbmc+SU5CT1g8L3N0cmluZz4NCiAgICA8\nL2RpY3Q+DQogIDwvYXJyYXk+DQogIDxrZXk+UGF5bG9hZERlc2NyaXB0aW9uPC9rZXk+DQogIDxz\ndHJpbmc+dXNlcm5hbWVAaG9zdC0xNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZCBTZWN1cmUgRW1h\naWwgU2V0dXA8L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkRGlzcGxheU5hbWU8L2tleT4NCiAgPHN0\ncmluZz51c2VybmFtZUBob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkIFNlY3VyZSBFbWFp\nbCBTZXR1cDwvc3RyaW5nPg0KICA8a2V5PlBheWxvYWRJZGVudGlmaWVyPC9rZXk+DQogIDxzdHJp\nbmc+Y3BhbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50\nbGQtZW1haWw8L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkT3JnYW5pemF0aW9uPC9rZXk+DQogIDxz\ndHJpbmc+Y3BhbmVsLm1haWwub3JnLnVzZXJuYW1lLmhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJz\nYi50bGQ8L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkUmVtb3ZhbERpc2FsbG93ZWQ8L2tleT4NCiAg\nPGZhbHNlLz4NCiAgPGtleT5QYXlsb2FkVHlwZTwva2V5Pg0KICA8c3RyaW5nPkNvbmZpZ3VyYXRp\nb248L3N0cmluZz4NCiAgPGtleT5QYXlsb2FkVVVJRDwva2V5Pg0KICA8c3RyaW5nPjRmMzI4YTVm\nLWIzMzctODZmZS03Zjk4LTVhOWMyNzFlNzY0MTwvc3RyaW5nPg0KICA8a2V5PlBheWxvYWRWZXJz\naW9uPC9rZXk+DQogIDxpbnRlZ2VyPjE8L2ludGVnZXI+DQo8L2RpY3Q+DQo8L3BsaXN0Pg0KoIIE\nSTCCBEUwggMtoAMCAQICBQG7jhEyMA0GCSqGSIb3DQEBCwUAMF4xMjAwBgkqhkiG9w0BCQEWI3Nz\nbEBob3N0LTE3Mi0xNi0xLTExLmFzaGxleTgyc2IudGxkMSgwJgYDVQQDDB9ob3N0LTE3Mi0xNi0x\nLTExLmFzaGxleTgyc2IudGxkMB4XDTE5MTExOTEzMDk1OFoXDTIwMTExODEzMDk1OFowXjEyMDAG\nCSqGSIb3DQEJARYjc3NsQGhvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQxKDAmBgNVBAMM\nH2hvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQDLTf43fqQJu57fAyGSBD+B/Zc3zVri44KCz/Oi9NlHCtmxET12+mE0TFkWGhjX+tzO\nfom+6Hj5KnGwr8K7qZoXq8zmiKGGvhvg11Ta6I3SJQL7VzU+wTBPXkAl+bWLBqoswzefA7A7jBZE\nv0c8W+wUAosjvmotUtiyeRsNbThTVBht7LwmHyCaAvHfIFkXkS96O6qqx0iZRlXZvahDjw6kiKOB\ne/kDpwl0YxMc3dEx2WCQyIZimtYOxNxglKKZ7UAnuKdy2we3AfOzhq3yKyDXsNyNrQghEn1aB1Ny\nY+/bYZYA/Mhlhk1jjMowEGsjLfJr1Kx6JhtBWzBPfUIkb4q7AgMBAAGjggEIMIIBBDAdBgNVHQ4E\nFgQUlzHaKABlXF/4KWQ7ZrNQij5iE/4wCQYDVR0TBAIwADCBjAYDVR0jBIGEMIGBgBSXMdooAGVc\nX/gpZDtms1CKPmIT/qFipGAwXjEyMDAGCSqGSIb3DQEJARYjc3NsQGhvc3QtMTcyLTE2LTEtMTEu\nYXNobGV5ODJzYi50bGQxKDAmBgNVBAMMH2hvc3QtMTcyLTE2LTEtMTEuYXNobGV5ODJzYi50bGSC\nBQG7jhEyMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAqBgNVHREEIzAhgh9ob3N0LTE3\nMi0xNi0xLTExLmFzaGxleTgyc2IudGxkMA0GCSqGSIb3DQEBCwUAA4IBAQCft6fX2NB0Lg3IM7UU\nw7eltKjsZOX3sCX/UQpwYdB8PcafoQ2Ddpb7H+CeyxW5tPk+qLpapnUWoIJBRahAQ+Xn3YWrJDfC\nFriWIdJH0Rk2Gwhydf7XM+yVm2HYBsAzfZWkF5EAjBJpgLN/28kAWdCv1p362nq79A/jrdKgpZdj\nz6fVb4aNMepJCcwIHivy7HN/PwmbXjqedwAMYsj/XEqw7aJX7+hI3VjFwkQxEbpyObVhcBhh+itt\n1O7t/MMWzg7mmJBnyTt+IbblYYEQoWvZXJgSGWT4U55mWF5arpjL9+NjFsbzvXl6TLEMzbVbpvxH\ntidgoiEpyBgzKFJ9p8TNMYICeTCCAnUCAQEwZzBeMTIwMAYJKoZIhvcNAQkBFiNzc2xAaG9zdC0x\nNzItMTYtMS0xMS5hc2hsZXk4MnNiLnRsZDEoMCYGA1UEAwwfaG9zdC0xNzItMTYtMS0xMS5hc2hs\nZXk4MnNiLnRsZAIFAbuOETIwDQYJYIZIAWUDBAIBBQCggeQwGAYJKoZIhvcNAQkDMQsGCSqGSIb3\nDQEHATAcBgkqhkiG9w0BCQUxDxcNMjAwODE0MjAwMjAwWjAvBgkqhkiG9w0BCQQxIgQguoXcvM7S\nh+TCpzAkazdEcoVI9NI91whPFvfJHZd9x4oweQYJKoZIhvcNAQkPMWwwajALBglghkgBZQMEASow\nCwYJYIZIAWUDBAEWMAsGCWCGSAFlAwQBAjAKBggqhkiG9w0DBzAOBggqhkiG9w0DAgICAIAwDQYI\nKoZIhvcNAwICAUAwBwYFKw4DAgcwDQYIKoZIhvcNAwICASgwDQYJKoZIhvcNAQEBBQAEggEACr8R\nPbw5CymW4Eep61SNsQzH54LXWbaS68mxF+Z8roOSLZTVYhBKP14bGJcUMhsS7c8zGYlOdwXWTA87\n4VQ0O4WIoWOsydxLVgHJ52ZDstN2iXsuW56Cm/Mk7Zow1MFdCJJ/ZX/oKOpnzm/t38kSvTXYyT/X\nLxGnTUYt+QbgUrqrxYZMbZeaAvGXkFTjTSi1kklZdnd7ndvashv5OhQ6zf6y831/c2M7mrn8vJKv\ne44Inb5NRBoK0MAc3f0vmAXrF087ayyNy6E1DqpdPWAGpCKYfIzWtIccrxKcguoIM4mWZ/Lp6mrZ\nI/2K6npCz9Wlm7iYASSsP3NMO8JWk7EWPA==\n"
    },
  • "metadata": {
    • "command": "generate_mobileconfig",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}