From 5dcef9147496a405bd033fd048ad4917cf543b79 Mon Sep 17 00:00:00 2001 From: Jonathan Eskew Date: Thu, 3 Dec 2015 16:54:44 -0800 Subject: [PATCH] Add a docblock to the generateSmtpPassword method --- src/Ses/SesClient.php | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/Ses/SesClient.php b/src/Ses/SesClient.php index 480fb680ee..bc3e259234 100644 --- a/src/Ses/SesClient.php +++ b/src/Ses/SesClient.php @@ -87,6 +87,17 @@ */ class SesClient extends \Aws\AwsClient { + /** + * Create an SMTP password for a given IAM user's credentials. + * + * The SMTP username is the Access Key ID for the provided credentials. + * + * @link http://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html#smtp-credentials-convert + * + * @param CredentialsInterface $creds + * + * @return string + */ public static function generateSmtpPassword(CredentialsInterface $creds) { static $version = "\x02";