{"id":21674355,"url":"https://github.com/drunomics/simplenews","last_synced_at":"2026-04-16T15:32:04.324Z","repository":{"id":21631792,"uuid":"24952371","full_name":"drunomics/simplenews","owner":"drunomics","description":"Simplenews 7.x-2.x development","archived":false,"fork":false,"pushed_at":"2024-05-01T11:56:32.000Z","size":1501,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"7.x-2.x-drunomics","last_synced_at":"2025-03-16T01:44:56.304Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/drunomics.png","metadata":{"files":{"readme":"README.txt","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-10-08T17:36:38.000Z","updated_at":"2015-05-20T15:43:38.000Z","dependencies_parsed_at":"2024-11-25T16:02:11.706Z","dependency_job_id":null,"html_url":"https://github.com/drunomics/simplenews","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drunomics%2Fsimplenews","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drunomics%2Fsimplenews/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drunomics%2Fsimplenews/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drunomics%2Fsimplenews/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/drunomics","download_url":"https://codeload.github.com/drunomics/simplenews/tar.gz/refs/heads/7.x-2.x-drunomics","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244583189,"owners_count":20476233,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-25T13:44:12.517Z","updated_at":"2026-04-16T15:31:59.299Z","avatar_url":"https://github.com/drunomics.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\nDESCRIPTION\n-----------\n\nSimplenews publishes and sends newsletters to lists of subscribers. Both\nanonymous and authenticated users can opt-in to different mailing lists.\nHTML email can be sent by adding Mime mail module.\n\n\nREQUIREMENTS\n------------\n\n * For large mailing lists, cron is required.\n * HTML-format newsletters and/or newsletters with file attachments require the\n   mime mail or HMTL mail module.\n * When sending newsletters on regular cron (cron.php), it is important that\n   the base url (settings.php, variable $base_url) is set correctly or links\n   inside the newsletter will not work. See the Tips (13.) below.\n * Additionally when using Drush to start cron, it is important to use the\n   argument --uri=http://www.example.com\n\n\nINSTALLATION\n------------\n\n 1. CREATE DIRECTORY\n\n    Create a new directory \"simplenews\" in the sites/all/modules directory and\n    place the entire contents of this simplenews folder in it.\n\n 2. ENABLE THE MODULE\n\n    Enable the module on the Modules admin page.\n\n 3. ACCESS PERMISSION\n\n    Grant the access at the Access control page:\n      People \u003e Permissions.\n\n 4. CONFIGURE SIMPLENEWS\n\n    Configure Simplenews on the Simplenews admin pages:\n      Configuration \u003e Simplenews.\n\n    Enable new content types to use as newsletter:\n      Structure \u003e edit content type \u003e Publishing options\n\n    Add and configure newsletter categories:\n      Structure \u003e Web Services \u003e Newsletters \u003e Add newsletter category\n      Structure \u003e Web Services \u003e Newsletters \u003e edit newsletter category\n\n 5. ENABLE SIMPLENEWS BLOCK\n\n    With the Simplenews block users can subscribe to a newsletter.\n\n    Enable a Simplenews block per Newsletter category:\n      Structure \u003e Newsletters \u003e edit newsletter category\n\n 6. CONFIGURE SIMPLENEWS BLOCK\n\n    Configure the Simplenews block on the Block configuration page. You reach\n    this page from Block admin page (Structure \u003e Blocks).\n    Click the 'Configure' link of the appropriate simplenews block.\n\n    Permission \"subscribe to newsletters\" is required to view the subscription\n    form in the simplenews block or to view the link to the subscription form.\n\n 7. SIMPLENEWS BLOCK THEMING\n\n    More control over the content of simplenews blocks can be achieved using\n    the block theming. Theme your simplenews block by copying\n    simplenews-block.tpl.php into your theme directory and edit the content.\n    The file is self documented listing all available variables.\n\n    The newsletter block can be themed generally and per newsletter:\n      simplenews-block.tpl.php (for all newsletters)\n      simplenews-block.tpl--[tid].php (for newsletter series tid)\n\n 8. MULTILINGUAL SUPPORT\n\n    Simplenews supports multilingual newsletters for node translation and url\n    path prefixes.\n\n    When translated newsletter issues are available subscribers receive the\n    newsletter in their preferred language (according to account setting).\n    Translation module is required for newsletter translation.\n\n    Path prefixes are added to footer message according to the subscribers\n    preferred language.\n\n    The preferred language of anonymous users is set based on the interface\n    language of the page they visit for subscription. Anonymous users can NOT\n    change their preferred language. Users with an account on the site will be\n    subscribed with the preferred language as set in their account settings.\n\n    The confirmation mails can be translated by enableding the Simplenews\n    variables at:\n      Home \u003e Administration \u003e Configuration \u003e Regional and language \u003e Multilingual settings \u003e Variables\n    Afterwards, the mail subject and body can be entered for every enabled\n    language.\n\n9.  NEWSLETTER THEMING\n\n    You can customize the theming of newsletters. Copy any of the *.tpl.php\n    files from the simplenews module directory to your theme directory. Both\n    general and by-newsletter theming can be performed.\n    Theme newsletter body:\n      simplenews-newsletter-body.tpl.php (for all newsletters)\n      simplenews-newsletter-body--[tid].tpl.php\n      simplenews-newsletter-body--[view mode].tpl.php\n      simplenews-newsletter-body--[tid]--[view mode].tpl.php\n\n      [tid]: Machine readable name of the newsletter category\n      [view mode]: 'email-plain', 'email-html', 'email-textalt'\n      Example:\n        simplenews-newsletter-body--1--email-plain.tpl.php\n\n    Theme newsletter footer:\n      simplenews-newsletter-footer.tpl.php (for all newsletters)\n      simplenews-newsletter-footer--[tid].tpl.php\n      simplenews-newsletter-footer--[view mode].tpl.php\n      simplenews-newsletter-footer--[tid]--[view mode].tpl.php\n\n      [tid]: Machine readable name of the newsletter category\n      [view mode]: 'email-plain', 'email-html', 'email-textalt'\n      Example:\n        simplenews-newsletter-footer--1--email-plain.tpl.php\n\n    The template files are self documented listing all available variables.\n    Depending on how the mails are sent (e.g. how cron is triggered), either the\n    default or the admin theme might be used, if one has been configured.\n    To prevent this, Simplenews supports the mail theme setting from the\n    mailsystem module (http://drupal.org/project/mailsystem). Install it, choose\n    the mail theme and the newsletter templates from that theme will be used no\n    matter which other themes are enabled.\n\n    Using the fields Display settings each field of a simplenews newsletter can\n    be displayed or hidden in 'plain text', 'HTML' and 'HTML text alternative'\n    format. You find these settings at:\n      Structure \u003e Content types \u003e Manage display\n    Enable the view modes you want to configure and configure their display.\n\n10. SEND MAILING LISTS\n\n    Cron is required to send large mailing lists.\n    If you have a medium or large size mailing list (i.e. more than 500\n    subscribers) always use cron to send the newsletters.\n\n    To use cron:\n     * Check the 'Use cron to send newsletters' checkbox.\n     * Set the 'Cron throttle' to the number of newsletters send per cron run.\n       Too high values may lead to mail server overload or you may hit hosting\n       restrictions. Contact your host.\n\n    Don't use cron:\n     * Uncheck the 'Use cron to send newsletters' checkbox.\n       All newsletters will be sent immediately when saving the node. If not\n       all emails can be sent within the available php execution time, the\n       remainder will be sent by cron. Therefore ALWAYS enable cron.\n\n    These settings are found on the Newsletter Settings page under\n    'Send mail' options at:\n      Administer \u003e Configuration \u003e Web Services \u003e Newsletters \u003e Settings \u003e Send mail.\n\n11. (UN)SUBSCRIBE CONFIRMATION\n\n    By default the unsubscribe link will direct the user to a confirmation page.\n    Upon confirmation the user is directed to the home page, where a message\n    will be displayed. On the Simplenews subscription admin page you can\n    specify an alternative destination page.\n      Structure \u003e Configuration \u003e Web Services \u003e Newsletters \u003e edit newsletter category \u003e Subscription settings\n\n    To skip the confirmation page you can add parameters to the subscription URL.\n      Example: [simplenews-subscribe-url]/ok\n    When an alternative destination page has been defined the extra parameters\n    will be added to the destination URL.\n      Example: [simplenews-subscriber:subscribe-url]/ok\n      Destination: node/123\n      Destination URL: node/123/ok\n\n 12. SINGLE OR DOUBLE OPT-IN AND OPT-OUT\n\n    Every newsletter can be set to be double opt-in/out (default), single\n    opt-in/out, or hidden.\n\n    Double: A confirmation email is sent to confirm the (un)subscribe action.\n            No confirmation is sent when a user is (un)subscribed by the\n            administrator or when the user subscribes when creating an account.\n    Single: No confirmation email is sent. (un)subscribe is immediately.\n    Hidden: The newsletter is not listed in newsletter lists. Use this for\n    mandatory newsletters. Only administrators or modules can add a user to this\n    mailing list.\n\n    Note that single opt-in/out or hidden (forced) subscription is in some\n    countries forbidden by law.\n\n    SECURITY NOTICE: a newsletter set to be single opt-in or opt-out is\n    vulnerable to Cross Site Request Forgeries. Email addresses may be\n    (un)subscribed without a notice. Do not use this setting in uncontrolled\n    environments (like the internet!).\n\n 13. TIPS\n    A subscription page is available at: /newsletter/subscriptions\n\n    The Elysia Cron module (http://drupal.org/project/elysia_cron) can be used\n    to start the simplenews cron hook more often than others, so that newsletter\n    are sent faster without decreasing site performance due to long-running cron\n    hooks.\n\n    If your unsubscribe URL looks like:\n      http://newsletter/confirm/remove/8acd182182615t632\n    instead of:\n      http://www.example.com/newsletter/confirm/remove/8acd182182615t632\n    You should change the base URL in the settings.php file from\n      #  $base_url = 'http://www.example.com';  // NO trailing slash!\n    to\n      $base_url = 'http://www.example.com';  // NO trailing slash!\n\n\nRELATED MODULES\n------------\n\n * Elysia Cron\n   Allows fine grained control over cron tasks.\n   http://http://drupal.org/project/elysia_cron\n * Mailsystem\n   Extends drupal core mailystem wirh Administrative UI and Developers API.\n   http://drupal.org/project/mailsystem\n * Maillog\n   Captures outgoing mails, helps users debugging simplenews.\n   http://drupal.org/project/maillog\n\n\nDOCUMENTATION\n-------------\nMore help can be found on the help pages: example.com/admin/help/simplenews\nand in the drupal.org handbook: http://drupal.org/node/197057\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrunomics%2Fsimplenews","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdrunomics%2Fsimplenews","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrunomics%2Fsimplenews/lists"}