{"action":"created","comment":{"url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/comments/171753124","pull_request_review_id":100663054,"id":171753124,"diff_hunk":"@@ -0,0 +1,42 @@\n+# hook_civicrm_alterMailingRecipients\n+\n+## Summary\n+\n+This hook is called to allow the user to alter the mailing recipients after they have been constructed.\n+\n+### Notes\n+\n+!!! Note\n+    This hook is called two times, once at the start and once at the end of mail recipients\n+    building, identified by $context as 'pre' or 'post' respectively\n+\n+## Availability\n+\n+This hook was first available in CiviCRM 4.7.32\n+\n+## Definition\n+\n+```php\n+    function hook_civicrm_alterMailingRecipients(&$mailingObject, &$params, $context);\n+```\n+\n+## Parameters\n+\n+-   object `$mailingObject` - reference to CRM_Mailing_DAO_Mailing object\n+-   array `&$params` - the mailing parameters used to filter mailing recipients\n+-   string `$context` - contain 'pre' or 'post' value to indicate when the hook is fired","path":"docs/hooks/hook_civicrm_alterMailingRecipients.md","position":27,"original_position":27,"commit_id":"bd93a985d6354fab3e5c912a15b36c1b6836e450","original_commit_id":"bd93a985d6354fab3e5c912a15b36c1b6836e450","user":{"login":"totten","id":1336047,"avatar_url":"https://avatars0.githubusercontent.com/u/1336047?v=4","gravatar_id":"","url":"https://api.github.com/users/totten","html_url":"https://github.com/totten","followers_url":"https://api.github.com/users/totten/followers","following_url":"https://api.github.com/users/totten/following{/other_user}","gists_url":"https://api.github.com/users/totten/gists{/gist_id}","starred_url":"https://api.github.com/users/totten/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/totten/subscriptions","organizations_url":"https://api.github.com/users/totten/orgs","repos_url":"https://api.github.com/users/totten/repos","events_url":"https://api.github.com/users/totten/events{/privacy}","received_events_url":"https://api.github.com/users/totten/received_events","type":"User","site_admin":false},"body":"In the `$context`, I like how it provides concrete examples.\r\n\r\nI think it's good do that with all array and string parameters -- so, *what keys and values are expected in `$params`*?\r\n","created_at":"2018-03-02T02:40:46Z","updated_at":"2018-03-02T02:40:46Z","html_url":"https://github.com/civicrm/civicrm-dev-docs/pull/221#discussion_r171753124","pull_request_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/221","author_association":"OWNER","_links":{"self":{"href":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/comments/171753124"},"html":{"href":"https://github.com/civicrm/civicrm-dev-docs/pull/221#discussion_r171753124"},"pull_request":{"href":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/221"}}},"pull_request":{"url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/221","id":130750237,"html_url":"https://github.com/civicrm/civicrm-dev-docs/pull/221","diff_url":"https://github.com/civicrm/civicrm-dev-docs/pull/221.diff","patch_url":"https://github.com/civicrm/civicrm-dev-docs/pull/221.patch","issue_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/issues/221","number":221,"state":"open","locked":false,"title":"CRM-20845: document alterMailingRecipients hook","user":{"login":"monishdeb","id":3735621,"avatar_url":"https://avatars3.githubusercontent.com/u/3735621?v=4","gravatar_id":"","url":"https://api.github.com/users/monishdeb","html_url":"https://github.com/monishdeb","followers_url":"https://api.github.com/users/monishdeb/followers","following_url":"https://api.github.com/users/monishdeb/following{/other_user}","gists_url":"https://api.github.com/users/monishdeb/gists{/gist_id}","starred_url":"https://api.github.com/users/monishdeb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/monishdeb/subscriptions","organizations_url":"https://api.github.com/users/monishdeb/orgs","repos_url":"https://api.github.com/users/monishdeb/repos","events_url":"https://api.github.com/users/monishdeb/events{/privacy}","received_events_url":"https://api.github.com/users/monishdeb/received_events","type":"User","site_admin":false},"body":"","created_at":"2017-07-16T12:51:00Z","updated_at":"2018-03-02T02:40:46Z","closed_at":null,"merged_at":null,"merge_commit_sha":"be0c8f5c0d218b00aa6d1628d60590bd28b5b189","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[{"id":618698507,"url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/labels/needs:%20core%20merge%20first","name":"needs: core merge first","color":"730606","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/221/commits","review_comments_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/221/comments","review_comment_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/issues/221/comments","statuses_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/statuses/bd93a985d6354fab3e5c912a15b36c1b6836e450","head":{"label":"monishdeb:CRM-20845","ref":"CRM-20845","sha":"bd93a985d6354fab3e5c912a15b36c1b6836e450","user":{"login":"monishdeb","id":3735621,"avatar_url":"https://avatars3.githubusercontent.com/u/3735621?v=4","gravatar_id":"","url":"https://api.github.com/users/monishdeb","html_url":"https://github.com/monishdeb","followers_url":"https://api.github.com/users/monishdeb/followers","following_url":"https://api.github.com/users/monishdeb/following{/other_user}","gists_url":"https://api.github.com/users/monishdeb/gists{/gist_id}","starred_url":"https://api.github.com/users/monishdeb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/monishdeb/subscriptions","organizations_url":"https://api.github.com/users/monishdeb/orgs","repos_url":"https://api.github.com/users/monishdeb/repos","events_url":"https://api.github.com/users/monishdeb/events{/privacy}","received_events_url":"https://api.github.com/users/monishdeb/received_events","type":"User","site_admin":false},"repo":{"id":86446415,"name":"civicrm-dev-docs","full_name":"monishdeb/civicrm-dev-docs","owner":{"login":"monishdeb","id":3735621,"avatar_url":"https://avatars3.githubusercontent.com/u/3735621?v=4","gravatar_id":"","url":"https://api.github.com/users/monishdeb","html_url":"https://github.com/monishdeb","followers_url":"https://api.github.com/users/monishdeb/followers","following_url":"https://api.github.com/users/monishdeb/following{/other_user}","gists_url":"https://api.github.com/users/monishdeb/gists{/gist_id}","starred_url":"https://api.github.com/users/monishdeb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/monishdeb/subscriptions","organizations_url":"https://api.github.com/users/monishdeb/orgs","repos_url":"https://api.github.com/users/monishdeb/repos","events_url":"https://api.github.com/users/monishdeb/events{/privacy}","received_events_url":"https://api.github.com/users/monishdeb/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/monishdeb/civicrm-dev-docs","description":null,"fork":true,"url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs","forks_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/forks","keys_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/teams","hooks_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/hooks","issue_events_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/issues/events{/number}","events_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/events","assignees_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/assignees{/user}","branches_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/branches{/branch}","tags_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/tags","blobs_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/languages","stargazers_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/stargazers","contributors_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/contributors","subscribers_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/subscribers","subscription_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/subscription","commits_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/contents/{+path}","compare_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/merges","archive_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/downloads","issues_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/issues{/number}","pulls_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/labels{/name}","releases_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/releases{/id}","deployments_url":"https://api.github.com/repos/monishdeb/civicrm-dev-docs/deployments","created_at":"2017-03-28T10:23:46Z","updated_at":"2017-03-28T10:23:48Z","pushed_at":"2018-02-20T12:07:51Z","git_url":"git://github.com/monishdeb/civicrm-dev-docs.git","ssh_url":"git@github.com:monishdeb/civicrm-dev-docs.git","clone_url":"https://github.com/monishdeb/civicrm-dev-docs.git","svn_url":"https://github.com/monishdeb/civicrm-dev-docs","homepage":null,"size":1769,"stargazers_count":0,"watchers_count":0,"language":"PHP","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":null,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"civicrm:master","ref":"master","sha":"62f5df5f7823a94b2168d1640d59795ec7318816","user":{"login":"civicrm","id":136373,"avatar_url":"https://avatars2.githubusercontent.com/u/136373?v=4","gravatar_id":"","url":"https://api.github.com/users/civicrm","html_url":"https://github.com/civicrm","followers_url":"https://api.github.com/users/civicrm/followers","following_url":"https://api.github.com/users/civicrm/following{/other_user}","gists_url":"https://api.github.com/users/civicrm/gists{/gist_id}","starred_url":"https://api.github.com/users/civicrm/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/civicrm/subscriptions","organizations_url":"https://api.github.com/users/civicrm/orgs","repos_url":"https://api.github.com/users/civicrm/repos","events_url":"https://api.github.com/users/civicrm/events{/privacy}","received_events_url":"https://api.github.com/users/civicrm/received_events","type":"Organization","site_admin":false},"repo":{"id":54499136,"name":"civicrm-dev-docs","full_name":"civicrm/civicrm-dev-docs","owner":{"login":"civicrm","id":136373,"avatar_url":"https://avatars2.githubusercontent.com/u/136373?v=4","gravatar_id":"","url":"https://api.github.com/users/civicrm","html_url":"https://github.com/civicrm","followers_url":"https://api.github.com/users/civicrm/followers","following_url":"https://api.github.com/users/civicrm/following{/other_user}","gists_url":"https://api.github.com/users/civicrm/gists{/gist_id}","starred_url":"https://api.github.com/users/civicrm/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/civicrm/subscriptions","organizations_url":"https://api.github.com/users/civicrm/orgs","repos_url":"https://api.github.com/users/civicrm/repos","events_url":"https://api.github.com/users/civicrm/events{/privacy}","received_events_url":"https://api.github.com/users/civicrm/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/civicrm/civicrm-dev-docs","description":"Documentation for CiviCRM developers","fork":false,"url":"https://api.github.com/repos/civicrm/civicrm-dev-docs","forks_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/forks","keys_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/teams","hooks_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/hooks","issue_events_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/issues/events{/number}","events_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/events","assignees_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/assignees{/user}","branches_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/branches{/branch}","tags_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/tags","blobs_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/languages","stargazers_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/stargazers","contributors_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/contributors","subscribers_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/subscribers","subscription_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/subscription","commits_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/contents/{+path}","compare_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/merges","archive_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/downloads","issues_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/issues{/number}","pulls_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/labels{/name}","releases_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/releases{/id}","deployments_url":"https://api.github.com/repos/civicrm/civicrm-dev-docs/deployments","created_at":"2016-03-22T18:27:06Z","updated_at":"2018-03-01T12:08:42Z","pushed_at":"2018-03-01T11:32:03Z","git_url":"git://github.com/civicrm/civicrm-dev-docs.git","ssh_url":"git@github.com:civicrm/civicrm-dev-docs.git","clone_url":"https://github.com/civicrm/civicrm-dev-docs.git","svn_url":"https://github.com/civicrm/civicrm-dev-docs","homepage":"https://docs.civicrm.org/dev/en/latest/","size":1805,"stargazers_count":21,"watchers_count":21,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":75,"mirror_url":null,"archived":false,"open_issues_count":53,"license":{"key":"other","name":"Other","spdx_id":null,"url":null},"forks":75,"open_issues":53,"watchers":21,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/221"},"html":{"href":"https://github.com/civicrm/civicrm-dev-docs/pull/221"},"issue":{"href":"https://api.github.com/repos/civicrm/civicrm-dev-docs/issues/221"},"comments":{"href":"https://api.github.com/repos/civicrm/civicrm-dev-docs/issues/221/comments"},"review_comments":{"href":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/221/comments"},"review_comment":{"href":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/civicrm/civicrm-dev-docs/pulls/221/commits"},"statuses":{"href":"https://api.github.com/repos/civicrm/civicrm-dev-docs/statuses/bd93a985d6354fab3e5c912a15b36c1b6836e450"}},"author_association":"OWNER"}}
{"actor":{"display_login":"totten"}}