Свойство | Тип | Описание | |
---|---|---|---|
$__accessKey | AWS SES Access key | ||
$__bulk_sending_mode | Controls the reuse of CURL hander for sending a bulk of messages | ||
$__host | AWS SES Target host of region | ||
$__secretKey | AWS Secret key | ||
$__ses_request | Optionally reusable SimpleEmailServiceRequest instance | ||
$__trigger_errors | Enable/disable | ||
$__verifyHost | Controls CURLOPT_SSL_VERIFYHOST setting for SimpleEmailServiceRequest's curl handler | ||
$__verifyPeer | Controls CURLOPT_SSL_VERIFYPEER setting for SimpleEmailServiceRequest's curl handler |
Метод | Описание | |
---|---|---|
__construct ( string $accessKey = null, string $secretKey = null, string $host = self::AWS_US_EAST_1, boolean $trigger_errors = true ) : void | Constructor | |
__triggerError ( string $functionname, array $error ) : void | Trigger an error message | |
deleteVerifiedEmailAddress ( string $email ) : array | Removes the specified email address from the list of verified addresses. | |
enableVerifyHost ( $enable = true ) | DEPRECATED | |
enableVerifyPeer ( $enable = true ) | DEPRECATED | |
getAccessKey ( ) : string | Get AWS SES auth access key | |
getBulkMode ( ) : boolean | Get bulk email sending mode | |
getHost ( ) : boolean | Get AWS target host | |
getSecretKey ( ) : string | Get AWS SES auth secret key | |
getSendQuota ( ) : array | Retrieves information on the current activity limits for this account. | |
getSendStatistics ( ) : array | Retrieves statistics for the last two weeks of activity on this account. | |
getVerifyHost ( ) : boolean | Get the verify host CURL mode | |
getVerifyPeer ( ) : boolean | Get the verify peer CURL mode | |
listVerifiedEmailAddresses ( ) : array | Lists the email addresses that have been verified and can be used as the 'From' address | |
sendEmail ( SimpleEmailServiceMessage $sesMessage, boolean $use_raw_request = false, boolean $trigger_error = null ) : array | Given a SimpleEmailServiceMessage object, submits the message to the service for sending. | |
setAuth ( string $accessKey, string $secretKey ) : SimpleEmailService | Set AWS access key and secret key | |
setBulkMode ( boolean $enable = true ) : SimpleEmailService | Enable/disable bulk email sending mode | |
setVerifyHost ( boolean $enable = true ) : SimpleEmailService | Enable/disable CURLOPT_SSL_VERIFYHOST for SimpleEmailServiceRequest's curl handler verifyHost and verifyPeer determine whether curl verifies ssl certificates. | |
setVerifyPeer ( boolean $enable = true ) : SimpleEmailService | Enable/disable CURLOPT_SSL_VERIFYPEER for SimpleEmailServiceRequest's curl handler verifyHost and verifyPeer determine whether curl verifies ssl certificates. | |
verifyEmailAddress ( string $email ) : array | Requests verification of the provided email address, so it can be used as the 'From' address when sending emails through SimpleEmailService. | |
verifyHost ( ) | DEPRECATED | |
verifyPeer ( ) | DEPRECATED |
Метод | Описание | |
---|---|---|
getRequestHandler ( $verb ) |
public __construct ( string $accessKey = null, string $secretKey = null, string $host = self::AWS_US_EAST_1, boolean $trigger_errors = true ) : void | ||
$accessKey | string | Access key |
$secretKey | string | Secret key |
$host | string | Amazon Host through which to send the emails |
$trigger_errors | boolean | Trigger PHP errors when AWS SES API returns an error |
Результат | void |
public deleteVerifiedEmailAddress ( string $email ) : array | ||
string | The email address to remove | |
Результат | array | The request id for this request. |
public getAccessKey ( ) : string | ||
Результат | string |
public getBulkMode ( ) : boolean | ||
Результат | boolean |
public getSecretKey ( ) : string | ||
Результат | string |
public getSendQuota ( ) : array | ||
Результат | array | An array containing information on this account's activity limits. |
public getSendStatistics ( ) : array | ||
Результат | array | An array of activity statistics. Each array item covers a 15-minute period. |
public getVerifyHost ( ) : boolean | ||
Результат | boolean |
public getVerifyPeer ( ) : boolean | ||
Результат | boolean |
public listVerifiedEmailAddresses ( ) : array | ||
Результат | array | An array containing two items: a list of verified email addresses, and the request id. |
public sendEmail ( SimpleEmailServiceMessage $sesMessage, boolean $use_raw_request = false, boolean $trigger_error = null ) : array | ||
$sesMessage | SimpleEmailServiceMessage | An instance of the message class |
$use_raw_request | boolean | If this is true or there are attachments to the email `SendRawEmail` call will be used |
$trigger_error | boolean | Optionally overwrite the class setting for triggering an error (with type check to true/false) |
Результат | array | An array containing the unique identifier for this message and a separate request id. Returns false if the provided message is missing any required fields. @link(AWS SES Response formats, http://docs.aws.amazon.com/ses/latest/DeveloperGuide/query-interface-responses.html) |
public setBulkMode ( boolean $enable = true ) : SimpleEmailService | ||
$enable | boolean | New status for the mode |
Результат | SimpleEmailService | $this |
public setVerifyHost ( boolean $enable = true ) : SimpleEmailService | ||
$enable | boolean | New status for the mode |
Результат | SimpleEmailService | $this |
public setVerifyPeer ( boolean $enable = true ) : SimpleEmailService | ||
$enable | boolean | New status for the mode |
Результат | SimpleEmailService | $this |
public verifyEmailAddress ( string $email ) : array | ||
string | The email address to get verified | |
Результат | array | The request id for this request. |
protected $__bulk_sending_mode |
protected $__ses_request |
protected $__verifyHost |