Note

You are viewing the documentation for an older release of Interworx (7.14). To see documentation for the current generally available release of Interworx, click here: 8.2.

Controller: /siteworx/email/mailman

Required Permissions

EMAIL, MAILMAN

Action: access

Added in Version

7.3.0-1840

Description

Manage the access type

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

privacy

integer

No*

0, 1

1

advertise

integer

No*

1, 0

0

subscribe_policy

integer

No*

1, 2, 3

3

* indicates that it’s actually required, but probably already has a valid default value.

Action: add

Added in Version

7.3.0-1840

Description

Add a “from” e-mail filter.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

list

string

Yes

The mailman list name.

accesstype

string

Yes

public, private

password

string

Yes

confirm_password

string

Yes

Confirm the password field by providing it again. Must match the password provided.

Action: delete

Added in Version

7.3.0-1840

Description

Delete list.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

list

struct (string)

Yes

mailmanlist_example.com

Action: fail

Added in Version

n/a

Description

Magic function - test for failure mechanism.

Action: listLists

Added in Version

7.3.0-1840

Description

Lists information about SW mail lists

Sample Output

array (
  'status' => 0,
  'payload' =>
  array (
    0 =>
    array (
      'type' => 'list',
      'accesstype' =>
      array (
        0 => 'private',
      ),
      'delete_input' => 'delete_list',
      'list' => '[email protected]',
      'local_delivery' => true,
    ),
  ),
  'reply_code' => 205,
)

Action: password

Added in Version

7.3.0-1840

Description

Set the mailman list password.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

password

string

Yes

confirm_password

string

Yes

Confirm the password field by providing it again. Must match the password provided.

Action: reroute

Added in Version

n/a

Description

Action to re-route from the current controller to a different one.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

controller

string

Yes

Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, EmailMailman, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.