Child pages
  • UAPI Functions - Email::suspend_login

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt
This function suspends a user's ability to log in to their email account.

 This function immediately suspends the user's login credentials and prevents future authenticated connections to the email account.

Note
titleNotes:
  • When you suspend an account, the user's account still receives email.
  • To suspend incoming email for an account, use the Email::suspend_incoming function.
  • To remove the login suspension for an account, use the Email::unsuspend_login function.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledReceiveMailRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Email/suspend_login?email=user%40example.com

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Suspend log in to the user's email account.
$suspend_login = $cpanel->uapi(
    'Email', 'suspend_login',
    array(
        'email' => 'user@example.com',
        )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Suspend log in to the user's email account.
my $suspend_login = $cpliveapi->uapi(
    'Email', 'suspend_login',
    {
        'email' => 'user@example.com',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
<!-- Suspend log in to the user's email account. -->
[% execute('Email', 'suspend_login', { 'email_address' => 'user@example.com' } ) %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username Email suspend_login email=user%40example.com

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
      "messages":["Logins for “user@example.com” are suspended."],
      "data":null,
      "errors":null,
      "status":1
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email user's account name.

A valid email account username.

user@example.com

Returns

This function only returns metadata.