{"id":27646070,"url":"https://github.com/in2code-de/groupmailer","last_synced_at":"2025-04-24T01:16:28.309Z","repository":{"id":56990697,"uuid":"269070742","full_name":"in2code-de/groupmailer","owner":"in2code-de","description":null,"archived":false,"fork":false,"pushed_at":"2020-06-08T09:04:18.000Z","size":91,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-04-24T01:16:14.604Z","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/in2code-de.png","metadata":{"files":{"readme":"README.md","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}},"created_at":"2020-06-03T11:32:17.000Z","updated_at":"2020-06-08T09:03:49.000Z","dependencies_parsed_at":"2022-08-21T13:50:20.690Z","dependency_job_id":null,"html_url":"https://github.com/in2code-de/groupmailer","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/in2code-de%2Fgroupmailer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/in2code-de%2Fgroupmailer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/in2code-de%2Fgroupmailer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/in2code-de%2Fgroupmailer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/in2code-de","download_url":"https://codeload.github.com/in2code-de/groupmailer/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250540935,"owners_count":21447428,"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":"2025-04-24T01:16:27.645Z","updated_at":"2025-04-24T01:16:28.303Z","avatar_url":"https://github.com/in2code-de.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TYPO3 Extension `groupmailer`\n\n## Usage\n\n### Generate Mailing via MailService\n\n#### Parameter for generateMailing:\n\n- $backendGroups [array]: an array with backend groups\n- $subject [string]: the email subject. The max length is currently 255. This can be increased via the TCA\n- $bodytext [string]: the email content\n- optional $senderEmail [string]: the sender email. If not defined the fallback `$GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress']` is used\n- optional $senderName [string]: the sender name. If not defined the fallback `$GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']` is used\n- optional $mailFormat [string]: default `FluidEmail::FORMAT_BOTH` valid options are `FluidEmail::FORMAT_BOTH`,  `FluidEmail::FORMAT_HTML` or `FluidEmail::FORMAT_PLAIN`\n- optional $context [string]: default `Context::FRONTEND` valid options are `Context::FRONTEND`,  `Context::BACKEND`\n- optional $workflowState [int]: default `Workflow::STATE_DRAFT` valid options are `Workflow::STATE_DRAFT`, `Workflow::STATE_REVIEW`, `Workflow::STATE_APPROVED`, `Workflow::STATE_REJECTED`\n- optional $attachments [array]: an array with SysFile Objects\n\n#### How to use the mailService\n\n```php\n        $beGroupRepository = \\TYPO3\\CMS\\Core\\Utility\\GeneralUtility::makeInstance(\\TYPO3\\CMS\\Extbase\\Domain\\Repository\\BackendUserGroupRepository::class);\n        $beGroups = [\n            $beGroupRepository-\u003efindByUid(2),\n            $beGroupRepository-\u003efindByUid(4)\n        ];\n        \n        $fileRepository = \\TYPO3\\CMS\\Core\\Utility\\GeneralUtility::makeInstance(\\TYPO3\\CMS\\Core\\Resource\\FileRepository::class);\n        $attachments = [\n            $fileRepository-\u003efindByUid(2)\n        ];\n\n        $mailService = \\TYPO3\\CMS\\Core\\Utility\\GeneralUtility::makeInstance(\\In2code\\Groupmailer\\Service\\MailService::class);\n        $mailService-\u003egenerateMailing(\n            $beGroups,\n            'Betreff',\n            'Inhalt',\n            'sender@in2code.de',\n            'Sender Name',\n            \\TYPO3\\CMS\\Core\\Mail\\FluidEmail::FORMAT_PLAIN,\n            \\In2code\\Groupmailer\\Context\\Context::BACKEND,\n            \\In2code\\Groupmailer\\Workflow\\Workflow::STATE_DRAFT,\n            $attachments\n        );\n```\n\n### Generate the mail queue \n\nThe mail queue can be generated via the `groupmailer:generateMailQueue` command.\n\n```\n./vendor/bin/typo3 groupmailer:generateMailQueue\n```\n\nThis can be automated via an Scheduler task.\n\n### Process the mail queue (sends the actual mails)\n\nThe mail queue can be generated via the `groupmailer:processMailQueue` command.\n\n```\n./vendor/bin/typo3 groupmailer:processMailQueue\n```\n\nThis can be automated via an Scheduler task.\n\n## Configuration\n\nThis extension can be configured in the \"Extension Configuration\" (Backend Module 'Settings' -\u003e \"Extension Configuration\")\n\n### Configuration options\n\n- Storage Pid [integer]: Sets the PID on which the records are stored\n- Emails to sent per execution [integer]: Defines how many mails should be sent on one execution of the process mail queue command\n- Recursion Level [integer]: Defines the recursion level for the given backend user groups in a mailing\n\n### Workflow\n\n- DRAFT: mailings with this status will be ignored if mail queue entries will be generated\n- REVIEW: mailings with this status will be ignored if mail queue entries will be generated\n- REJECTED: mailings with this status will be moved into locked mailings and no mail queue entries will be generated\n- APPROVED: queue entries will be generated on the next execution of the generateMailQueue command\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fin2code-de%2Fgroupmailer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fin2code-de%2Fgroupmailer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fin2code-de%2Fgroupmailer/lists"}