From 5686cef218537001879b0c9ecceeb9dd7a2161c1 Mon Sep 17 00:00:00 2001
From: Aidan Saunders <aidan.saunders@squiffle.uk>
Date: Mon, 3 Jun 2019 09:53:12 +0100
Subject: [PATCH] Update hook_civicrm_emailProcessorContact.md
Formatting and wording
---
.../hook_civicrm_emailProcessorContact.md | 33 +++++++------------
1 file changed, 12 insertions(+), 21 deletions(-)
diff --git a/docs/hooks/hook_civicrm_emailProcessorContact.md b/docs/hooks/hook_civicrm_emailProcessorContact.md
index efe5feac..802ad442 100644
--- a/docs/hooks/hook_civicrm_emailProcessorContact.md
+++ b/docs/hooks/hook_civicrm_emailProcessorContact.md
@@ -2,8 +2,8 @@
## Summary
-This hook is called by the Email Processor when deciding to which
-contact and activity will be attached.
+This hook is called by the Email Processor when deciding which
+contact to create an activitity for recording an inbound email.
## Notes
@@ -12,27 +12,18 @@ contact or decide whether it should create contacts.
## Definition
- hook_civicrm_emailProcessorContact( $email, $contactID, &$result )
+ hook_civicrm_emailProcessorContact($email, $contactID, &$result)
## Parameters
-- @param string $email the email address
-- @param int $contactID the contactID that matches this email
- address, IF it exists
-- @param array $result (reference) has two fields
-- contactID - the new (or
- same) contactID
-- action - 3 possible
- values:
--
- CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL -
- create a new contact record
-- CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE
- - use the new contactID
--
- CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE - skip this
- email address\
- \
+- @param string $email - the email address
+- @param int $contactID - the contactID that matches this email address, IF it exists
+- @param array $result (reference) has two fields:
+ - contactID - the new (or same) contactID
+ - action - 3 possible values:
+ - `CRM_Utils_Mail_Incoming::EMAILPROCESSOR_CREATE_INDIVIDUAL` - create a new contact record
+ - `CRM_Utils_Mail_Incoming::EMAILPROCESSOR_OVERRIDE` - use the new contactID
+ - `CRM_Utils_Mail_Incoming::EMAILPROCESSOR_IGNORE` - skip this email address
## Returns
@@ -45,7 +36,7 @@ This hook was first available in CiviCRM 4.1.0
## Example
```php
-function civitest_civicrm_emailProcessorContact( $email, $contactID, &$result ) {
+function civitest_civicrm_emailProcessorContact($email, $contactID, &$result) {
require_once 'CRM/Utils/Mail/Incoming.php';
// first split the email into name and domain
--
GitLab