From e4831865aa5988a0cc55dd219b26f27b778d8650 Mon Sep 17 00:00:00 2001 From: Zhang Huangbin Date: Mon, 3 Jul 2017 10:02:07 +0800 Subject: [PATCH] Update en_US/howto/sql.create.mail.alias.md with new sql structure. --- .../howto/0-sql.create.mail.alias-20170701.md | 68 +++++++++++ en_US/howto/sql.create.mail.alias.md | 83 +++++++++---- html/sql.create.mail.alias-20170701.html | 96 +++++++++++++++ html/sql.create.mail.alias.html | 115 ++++++++++++++---- 4 files changed, 313 insertions(+), 49 deletions(-) create mode 100644 en_US/howto/0-sql.create.mail.alias-20170701.md create mode 100644 html/sql.create.mail.alias-20170701.html diff --git a/en_US/howto/0-sql.create.mail.alias-20170701.md b/en_US/howto/0-sql.create.mail.alias-20170701.md new file mode 100644 index 00000000..f3198343 --- /dev/null +++ b/en_US/howto/0-sql.create.mail.alias-20170701.md @@ -0,0 +1,68 @@ +# SQL: Add a mail alias account + +[TOC] + +!!! note + + This document is applicable to iRedMail-0.9.6 and earlier releases. + +## Create mail alias account with iRedAdmin-Pro + +With iRedAdmin-Pro, you can easily add mail list account by click menu: +`Add -> Mail List` (or `Add -> Alias` for SQL backends) in main +navigation bar. + +![](../images/iredadmin/maillist_create.png) + +## Create mail alias account with SQL command line + +To create an mail alias account, you can simply insert a SQL record in table +`vmail.alias`. For example: + +```mysql +sql> USE vmail; +sql> INSERT INTO alias (address, goto, domain, islist) \ + VALUES ('original@example.com', \ + 'user1@example.com,user2@example.com,user1@test.com', \ + 'example.com', \ + 1); +``` + +__NOTES__: + +* Please always use lower cases for email addresses. +* Multiple destination addresses must be separated by comma. +* If destination address is a mail user under domain hosted on localhost, + it must exist. Otherwise emails sent to alias account will be bounced after + expanded to destination addresses. + +## Access policy + +You can restrict which senders are allowed to send email to this mail alias +account by adding proper policy name in SQL column `alias.accesspolicy`. +For example: + +``` +sql> UPDATE alias SET accesspolicy='domain' WHERE address='original@example.com'; +``` + +Available access policies are: + +* `public`: no restrictions. +* `domain`: all users under same domain are allowed to send email to this mail list. +* `subdomain`: all users under same domain and sub-domains are allowed to send email to this mail list. +* `membersOnly`: only members of this mail list are allowd. +* `allowedOnly`: only moderators of this mail list are allowed. Moderators + are email addresses stored in SQL column `alias.moderators`. With iRedAPD-1.4.5, + it's ok to use `*@domain.com` as (one of) moderator for all users under + mail domain 'domain.com'. +* `membersAndModeratorsOnly`: only members and moderators of this mail list are allowed. + +Access restriction is implemented in iRedAPD (a simple Postfix policy server), +iRedMail has it enabled by default. You'd better check its config file +`/opt/iredapd/settings.py` to make sure plugin `sql_alias_access_policy` is +enabled in parameter `plugins = []`. + +## See also + +* [Create mailing list for OpenLDAP backend](./ldap.add.mail.list.html) diff --git a/en_US/howto/sql.create.mail.alias.md b/en_US/howto/sql.create.mail.alias.md index 86f1fcab..d353d1bc 100644 --- a/en_US/howto/sql.create.mail.alias.md +++ b/en_US/howto/sql.create.mail.alias.md @@ -2,6 +2,11 @@ [TOC] +!!! note + + * This document is applicable to iRedMail-0.9.7 and later releases. + * Here's [doc for iRedMail-0.9.6 and earlier releases](./sql.create.mail.alias-20170701.html). + ## Create mail alias account with iRedAdmin-Pro With iRedAdmin-Pro, you can easily add mail list account by click menu: @@ -12,52 +17,84 @@ navigation bar. ## Create mail alias account with SQL command line -To create an mail alias account, you can simply insert a SQL record in table -`vmail.alias`. For example: +To create an mail alias account, you need to add SQL records in 2 sql tables. +for example: create a mail alias account `alias@mydomain.com` and forward emails +to two addresses `someone@gmail.com` and `someone@test.com`: ```mysql sql> USE vmail; -sql> INSERT INTO alias (address, goto, domain, islist) \ - VALUES ('original@example.com', \ - 'user1@example.com,user2@example.com,user1@test.com', \ - 'example.com', \ - 1); + +-- Create mail alias account +sql> INSERT INTO alias (address, domain, active) + VALUES ('alias@mydomain.com', 'mydomain.com', 1); + +-- Forward email to 'someone@gmail.com' +sql> INSERT INTO forwardings (address, forwarding, + domain, dest_domain, + is_list, active) + VALUES ('alias@mydomain.com', 'someone@gmail.com', + 'mydomain.com', 'gmail.com', + 1, 1); + +-- Forward email to 'someone@test.com' +sql> INSERT INTO forwardings (address, forwarding, + domain, dest_domain, + is_list, active) + VALUES ('alias@mydomain.com', 'someone@test.com', + 'mydomain.com', 'test.com', + 1, 1); ``` __NOTES__: * Please always use lower cases for email addresses. -* Multiple destination addresses must be separated by comma. * If destination address is a mail user under domain hosted on localhost, it must exist. Otherwise emails sent to alias account will be bounced after expanded to destination addresses. ## Access policy +!!! attention + + Access restriction requires iRedAPD plugin `sql_alias_access_policy`, + please make sure it's enabled in iRedAPD config file + `/opt/iredapd/settings.py`. + You can restrict which senders are allowed to send email to this mail alias account by adding proper policy name in SQL column `alias.accesspolicy`. For example: ``` -sql> UPDATE alias SET accesspolicy='domain' WHERE address='original@example.com'; +sql> UPDATE alias SET accesspolicy='domain' WHERE address='alias@mydomain.com'; ``` -Available access policies are: +Available access policies: -* `public`: no restrictions. -* `domain`: all users under same domain are allowed to send email to this mail list. -* `subdomain`: all users under same domain and sub-domains are allowed to send email to this mail list. -* `membersOnly`: only members of this mail list are allowd. -* `allowedOnly`: only moderators of this mail list are allowed. Moderators - are email addresses stored in SQL column `alias.moderators`. With iRedAPD-1.4.5, - it's ok to use `*@domain.com` as (one of) moderator for all users under - mail domain 'domain.com'. -* `membersAndModeratorsOnly`: only members and moderators of this mail list are allowed. +Access Policy Name | Comment +--- |--- +`public` | no restrictions +`domain` | all users under same domain are allowed to send email to this mail list. +`subdomain` | all users under same domain and all sub-domains are allowed to send email to this mail list. +`membersonly` | only members of this mail list are allowd. +`moderatorsonly` | only moderators of this mail list are allowed. +`membersandmoderatorsonly` | only members and moderators of this mail list are allowed. -Access restriction is implemented in iRedAPD (a simple Postfix policy server), -iRedMail has it enabled by default. You'd better check its config file -`/opt/iredapd/settings.py` to make sure plugin `sql_alias_access_policy` is -enabled in parameter `plugins = []`. +### How to assign a moderator + +Moderators are email addresses stored in SQL table `alias_moderators`. With +iRedAPD-1.4.5 and later releases, it's ok to use `*@domain.com` as (one of) +moderator for all users under mail domain 'domain.com'. + +To assign user `someone@gmail.com` and `someone@outlook.com` as moderator of +mail alias `alias@mydomain.com`: + +``` +sql> INSERT INTO alias_moderators (address, moderator, domain, dest_domain) + VALUES ('alias@mydomain.com', 'someone@gmail.com', 'mydomain.com', 'gmail.com'); + +sql> INSERT INTO alias_moderators (address, moderator, domain, dest_domain) + VALUES ('alias@mydomain.com', 'someone@outlook.com', 'mydomain.com', 'outlook.com'); +``` ## See also diff --git a/html/sql.create.mail.alias-20170701.html b/html/sql.create.mail.alias-20170701.html new file mode 100644 index 00000000..44f030a4 --- /dev/null +++ b/html/sql.create.mail.alias-20170701.html @@ -0,0 +1,96 @@ + + + + + SQL: Add a mail alias account + + + + +

SQL: Add a mail alias account

+
+ +
+
+

Note

+

This document is applicable to iRedMail-0.9.6 and earlier releases.

+
+

Create mail alias account with iRedAdmin-Pro

+

With iRedAdmin-Pro, you can easily add mail list account by click menu: +Add -> Mail List (or Add -> Alias for SQL backends) in main +navigation bar.

+

+

Create mail alias account with SQL command line

+

To create an mail alias account, you can simply insert a SQL record in table +vmail.alias. For example:

+
sql> USE vmail;
+sql> INSERT INTO alias (address, goto, domain, islist) \
+     VALUES ('original@example.com', \
+             'user1@example.com,user2@example.com,user1@test.com', \
+             'example.com', \
+             1);
+
+ +

NOTES:

+ +

Access policy

+

You can restrict which senders are allowed to send email to this mail alias +account by adding proper policy name in SQL column alias.accesspolicy. +For example:

+
sql> UPDATE alias SET accesspolicy='domain' WHERE address='original@example.com';
+
+ +

Available access policies are:

+ +

Access restriction is implemented in iRedAPD (a simple Postfix policy server), +iRedMail has it enabled by default. You'd better check its config file +/opt/iredapd/settings.py to make sure plugin sql_alias_access_policy is +enabled in parameter plugins = [].

+

See also

+
+

All documents are available in BitBucket repository, and published under Creative Commons license. You can download the latest version for offline reading. If you found something wrong, please do contact us to fix it.

+
+ + \ No newline at end of file diff --git a/html/sql.create.mail.alias.html b/html/sql.create.mail.alias.html index c3ee59a7..b08486c6 100644 --- a/html/sql.create.mail.alias.html +++ b/html/sql.create.mail.alias.html @@ -21,59 +21,122 @@
  • SQL: Add a mail alias account
    • +
    +

    Note

    + +

    Create mail alias account with iRedAdmin-Pro

    With iRedAdmin-Pro, you can easily add mail list account by click menu: Add -> Mail List (or Add -> Alias for SQL backends) in main navigation bar.

    Create mail alias account with SQL command line

    -

    To create an mail alias account, you can simply insert a SQL record in table -vmail.alias. For example:

    +

    To create an mail alias account, you need to add SQL records in 2 sql tables. +for example: create a mail alias account alias@mydomain.com and forward emails +to two addresses someone@gmail.com and someone@test.com:

    sql> USE vmail;
-sql> INSERT INTO alias (address, goto, domain, islist) \
-     VALUES ('original@example.com', \
-             'user1@example.com,user2@example.com,user1@test.com', \
-             'example.com', \
-             1);
+
+-- Create mail alias account
+sql> INSERT INTO alias (address, domain, active)
+                VALUES ('alias@mydomain.com', 'mydomain.com', 1);
+
+-- Forward email to 'someone@gmail.com'
+sql> INSERT INTO forwardings (address, forwarding,
+                              domain, dest_domain,
+                              is_list, active)
+                      VALUES ('alias@mydomain.com', 'someone@gmail.com',
+                              'mydomain.com', 'gmail.com',
+                              1, 1);
+
+-- Forward email to 'someone@test.com'
+sql> INSERT INTO forwardings (address, forwarding,
+                              domain, dest_domain,
+                              is_list, active)
+                      VALUES ('alias@mydomain.com', 'someone@test.com',
+                              'mydomain.com', 'test.com',
+                              1, 1);

    NOTES:

    Access policy

    +
    +

    Attention

    +

    Access restriction requires iRedAPD plugin sql_alias_access_policy, +please make sure it's enabled in iRedAPD config file +/opt/iredapd/settings.py.

    +

    You can restrict which senders are allowed to send email to this mail alias account by adding proper policy name in SQL column alias.accesspolicy. For example:

    -
    sql> UPDATE alias SET accesspolicy='domain' WHERE address='original@example.com';
+
    sql> UPDATE alias SET accesspolicy='domain' WHERE address='alias@mydomain.com';
+
    
+
+
    Available access policies:
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    Access Policy NameComment
    publicno restrictions
    domainall users under same domain are allowed to send email to this mail list.
    subdomainall users under same domain and all sub-domains are allowed to send email to this mail list.
    membersonlyonly members of this mail list are allowd.
    moderatorsonlyonly moderators of this mail list are allowed.
    membersandmoderatorsonlyonly members and moderators of this mail list are allowed.
    
+
    How to assign a moderator
    
+
    Moderators are email addresses stored in SQL table alias_moderators. With
+iRedAPD-1.4.5 and later releases, it's ok to use *@domain.com as (one of)
+moderator for all users under mail domain 'domain.com'.
    
+
    To assign user someone@gmail.com and someone@outlook.com as moderator of
+mail alias alias@mydomain.com:
    
+
    sql> INSERT INTO alias_moderators (address, moderator, domain, dest_domain)
+                          VALUES ('alias@mydomain.com', 'someone@gmail.com', 'mydomain.com', 'gmail.com');
+
+sql> INSERT INTO alias_moderators (address, moderator, domain, dest_domain)
+                          VALUES ('alias@mydomain.com', 'someone@outlook.com', 'mydomain.com', 'outlook.com');
 
    
 
-
    Available access policies are:
    
-
      
-
    • public: no restrictions.
      • 
-
    • domain: all users under same domain are allowed to send email to this mail list.
      • 
-
    • subdomain: all users under same domain and sub-domains are allowed to send email to this mail list.
      • 
-
    • membersOnly: only members of this mail list are allowd.
      • 
-
    • allowedOnly: only moderators of this mail list are allowed. Moderators
-  are email addresses stored in SQL column alias.moderators. With iRedAPD-1.4.5,
-  it's ok to use *@domain.com as (one of) moderator for all users under
-  mail domain 'domain.com'.
      • 
-
    • membersAndModeratorsOnly: only members and moderators of this mail list are allowed.
      • 
-
    
-
    Access restriction is implemented in iRedAPD (a simple Postfix policy server),
-iRedMail has it enabled by default. You'd better check its config file
-/opt/iredapd/settings.py to make sure plugin sql_alias_access_policy is
-enabled in parameter plugins = [].
    
 
    See also