{"id":3242,"date":"2026-04-04T04:02:31","date_gmt":"2026-04-04T04:02:31","guid":{"rendered":"https:\/\/pheonixsolutions.com\/knowledge-base\/?p=3242"},"modified":"2026-04-04T04:02:35","modified_gmt":"2026-04-04T04:02:35","slug":"suspend-email-account-login-using-cpanel-uapi","status":"publish","type":"post","link":"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/","title":{"rendered":"Suspend Email Account Login Using cPanel UAPI"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\">Introduction<\/h2>\n\n\n\n<p>The <strong>Email Suspend Login<\/strong> function in cPanel allows administrators to immediately prevent a user from logging into their email account. This is useful for situations where an account may be compromised, inactive, or requires temporary access restriction.<\/p>\n\n\n\n<p>Key points:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Suspending login <strong>does not stop incoming emails<\/strong>. The user will still receive emails in their inbox.<\/li>\n\n\n\n<li>Suspension is immediate and prevents all authenticated connections to the email account.<\/li>\n\n\n\n<li>To <strong>resume login<\/strong>, the suspension must be removed using the corresponding UAPI function.<\/li>\n\n\n\n<li>If you want to <strong>stop receiving emails<\/strong>, a different UAPI function must be used.<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\" \/>\n\n\n\n<h2 class=\"wp-block-heading\">Prerequisites<\/h2>\n\n\n\n<p>Before using the <code>suspend_login<\/code> function, ensure the following:<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong>cPanel Access<\/strong>: You must have administrative access to the cPanel account where the email resides.<\/li>\n\n\n\n<li><strong>API Access<\/strong>: UAPI must be available and accessible for your cPanel version (tested on version 11.134.0.13).<\/li>\n\n\n\n<li><strong>Credentials<\/strong>: Username and password for basic authentication or an API token with sufficient privileges.<\/li>\n\n\n\n<li><strong>Target Email<\/strong>: You must know the email address that you want to suspend.<\/li>\n<\/ol>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\" \/>\n\n\n\n<h2 class=\"wp-block-heading\">Steps \/ Usage<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">1. Prepare the UAPI Command<\/h3>\n\n\n\n<p>Use the <code>uapi<\/code> command-line tool to suspend an email login:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>uapi --output=jsonpretty \\\n  --user=username \\\n  Email \\\n  suspend_login \\\n  email='test@example.com'\n<\/code><\/pre>\n\n\n\n<p><strong>Parameters:<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>--user=username<\/code>: The cPanel username.<\/li>\n\n\n\n<li><code>Email suspend_login<\/code>: The module and function being called.<\/li>\n\n\n\n<li><code>email='test@example.com'<\/code>: Target email address to suspend.<\/li>\n\n\n\n<li><code>--output=jsonpretty<\/code>: Optional, formats the output for readability.<\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\" \/>\n\n\n\n<h2 class=\"wp-block-heading\">Conclusion<\/h2>\n\n\n\n<p>The <strong>Email Suspend Login<\/strong> UAPI function is a straightforward and powerful tool for administrators to control access to email accounts without affecting email delivery. By following the steps above:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>You can temporarily block access to specific accounts.<\/li>\n\n\n\n<li>Keep email delivery operational.<\/li>\n\n\n\n<li>Maintain a secure email environment.<\/li>\n<\/ul>\n\n\n\n<p>Always verify the <code>result.status<\/code> and <code>result.errors<\/code> fields after executing the API to ensure that the operation completed successfully.<\/p>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Introduction The Email Suspend Login function in cPanel allows administrators to immediately prevent a user from logging into their email account. This is useful for situations where an account may be compromised, inactive, or requires temporary access restriction. Key points: Prerequisites Before using the suspend_login function, ensure the following: Steps \/ Usage 1. Prepare the ..<\/p>\n<div class=\"clear-fix\"><\/div>\n<p><a href=\"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/\" title=\"read more...\">Read more<\/a><\/p>\n","protected":false},"author":11,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[33],"tags":[],"class_list":["post-3242","post","type-post","status-publish","format-standard","hentry","category-whm"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.6 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Suspend Email Account Login Using cPanel UAPI - PheonixSolutions Knowledge-Base<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Suspend Email Account Login Using cPanel UAPI - PheonixSolutions Knowledge-Base\" \/>\n<meta property=\"og:description\" content=\"Introduction The Email Suspend Login function in cPanel allows administrators to immediately prevent a user from logging into their email account. This is useful for situations where an account may be compromised, inactive, or requires temporary access restriction. Key points: Prerequisites Before using the suspend_login function, ensure the following: Steps \/ Usage 1. Prepare the ..Read more\" \/>\n<meta property=\"og:url\" content=\"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/\" \/>\n<meta property=\"og:site_name\" content=\"PheonixSolutions Knowledge-Base\" \/>\n<meta property=\"article:published_time\" content=\"2026-04-04T04:02:31+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2026-04-04T04:02:35+00:00\" \/>\n<meta name=\"author\" content=\"srisanthosh s\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"srisanthosh s\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2026\\\/04\\\/04\\\/suspend-email-account-login-using-cpanel-uapi\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2026\\\/04\\\/04\\\/suspend-email-account-login-using-cpanel-uapi\\\/\"},\"author\":{\"name\":\"srisanthosh s\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/#\\\/schema\\\/person\\\/070895e04bc57565b04d6106e4da129c\"},\"headline\":\"Suspend Email Account Login Using cPanel UAPI\",\"datePublished\":\"2026-04-04T04:02:31+00:00\",\"dateModified\":\"2026-04-04T04:02:35+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2026\\\/04\\\/04\\\/suspend-email-account-login-using-cpanel-uapi\\\/\"},\"wordCount\":266,\"commentCount\":0,\"articleSection\":[\"WHM\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2026\\\/04\\\/04\\\/suspend-email-account-login-using-cpanel-uapi\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2026\\\/04\\\/04\\\/suspend-email-account-login-using-cpanel-uapi\\\/\",\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2026\\\/04\\\/04\\\/suspend-email-account-login-using-cpanel-uapi\\\/\",\"name\":\"Suspend Email Account Login Using cPanel UAPI - PheonixSolutions Knowledge-Base\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/#website\"},\"datePublished\":\"2026-04-04T04:02:31+00:00\",\"dateModified\":\"2026-04-04T04:02:35+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/#\\\/schema\\\/person\\\/070895e04bc57565b04d6106e4da129c\"},\"breadcrumb\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2026\\\/04\\\/04\\\/suspend-email-account-login-using-cpanel-uapi\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2026\\\/04\\\/04\\\/suspend-email-account-login-using-cpanel-uapi\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2026\\\/04\\\/04\\\/suspend-email-account-login-using-cpanel-uapi\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Suspend Email Account Login Using cPanel UAPI\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/#website\",\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/\",\"name\":\"PheonixSolutions Knowledge-Base\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/#\\\/schema\\\/person\\\/070895e04bc57565b04d6106e4da129c\",\"name\":\"srisanthosh s\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g\",\"caption\":\"srisanthosh s\"},\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/author\\\/srisanthosh\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Suspend Email Account Login Using cPanel UAPI - PheonixSolutions Knowledge-Base","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/","og_locale":"en_US","og_type":"article","og_title":"Suspend Email Account Login Using cPanel UAPI - PheonixSolutions Knowledge-Base","og_description":"Introduction The Email Suspend Login function in cPanel allows administrators to immediately prevent a user from logging into their email account. This is useful for situations where an account may be compromised, inactive, or requires temporary access restriction. Key points: Prerequisites Before using the suspend_login function, ensure the following: Steps \/ Usage 1. Prepare the ..Read more","og_url":"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/","og_site_name":"PheonixSolutions Knowledge-Base","article_published_time":"2026-04-04T04:02:31+00:00","article_modified_time":"2026-04-04T04:02:35+00:00","author":"srisanthosh s","twitter_card":"summary_large_image","twitter_misc":{"Written by":"srisanthosh s","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/#article","isPartOf":{"@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/"},"author":{"name":"srisanthosh s","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/#\/schema\/person\/070895e04bc57565b04d6106e4da129c"},"headline":"Suspend Email Account Login Using cPanel UAPI","datePublished":"2026-04-04T04:02:31+00:00","dateModified":"2026-04-04T04:02:35+00:00","mainEntityOfPage":{"@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/"},"wordCount":266,"commentCount":0,"articleSection":["WHM"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/","url":"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/","name":"Suspend Email Account Login Using cPanel UAPI - PheonixSolutions Knowledge-Base","isPartOf":{"@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/#website"},"datePublished":"2026-04-04T04:02:31+00:00","dateModified":"2026-04-04T04:02:35+00:00","author":{"@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/#\/schema\/person\/070895e04bc57565b04d6106e4da129c"},"breadcrumb":{"@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2026\/04\/04\/suspend-email-account-login-using-cpanel-uapi\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/pheonixsolutions.com\/knowledge-base\/"},{"@type":"ListItem","position":2,"name":"Suspend Email Account Login Using cPanel UAPI"}]},{"@type":"WebSite","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/#website","url":"https:\/\/pheonixsolutions.com\/knowledge-base\/","name":"PheonixSolutions Knowledge-Base","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/pheonixsolutions.com\/knowledge-base\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/#\/schema\/person\/070895e04bc57565b04d6106e4da129c","name":"srisanthosh s","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g","caption":"srisanthosh s"},"url":"https:\/\/pheonixsolutions.com\/knowledge-base\/author\/srisanthosh\/"}]}},"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/posts\/3242","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/users\/11"}],"replies":[{"embeddable":true,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/comments?post=3242"}],"version-history":[{"count":1,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/posts\/3242\/revisions"}],"predecessor-version":[{"id":3243,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/posts\/3242\/revisions\/3243"}],"wp:attachment":[{"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/media?parent=3242"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/categories?post=3242"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/tags?post=3242"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}