Stop Alias

Usage

stop alias $alias@$domain

- or -

stop alias $alias domain $domain

Description

The command stop alias is used to stop a Virtual Alias record for REVLY. Stopped aliases will not forward emails.

Symbol

stop alias

Cardinal

action-identifier

Language

Alias Admin

Module

Admin

Parameters

ChangeDate

usage: changedate $timestamp

description: A Unix timestamp representing the last time the alias record was modified.

default: Current timestamp

LDAP Suffix

usage: ldap suffix $ldapsuffix

description: The base search path of the LDAP tree.

default: revly

Actions

- Generate a LDIF file to stop the alias.

- Execute ldapmodify to stop the alias in OpenLDAP.

Template

# Stop virtualGroup
dn: alias=:#ALIAS#:,domain=:#DOMAIN#:,o=domains,dc=:#LDAP_SUFFIX#:
changetype: modify
replace: active
active: FALSE
-
replace: delete
delete: TRUE
-
replace: changeDate
:#CHANGE_DATE#:

Return Codes

Code	Human Readable Output
0	Stopped the alias '$alias@$domain'.
1	The alias '$alias@$domain' does not exist.

Example

Input

stop alias info@example.com

Generated LDIF file

# Stop virtualGroup
dn: alias=info,domain=example.com,o=domains,dc=revly
changetype: modify
replace: active
active: FALSE
-
replace: delete
delete: TRUE
-
replace: changeDate
changeDate: 1419358202

Output

Edited the user 'sally@example.com'.