Pause Alias

Usage

pause alias $alias@$domain

- or -

pause alias $alias domain $domain

Description

The command pause alias is used to pause a Virtual Alias record for REVLY. Paused aliases will continue to forward emails.

Symbol

pause 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 pause the alias.

- Execute ldapmodify to pause the alias in OpenLDAP.

Template

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

Return Codes

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

Example

Input

pause alias info@example.com

Generated LDIF file

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

Output

Paused the alias 'info@example.com'.