Creating an email trigger that invokes a Cloud Functions function
Create an email trigger to invoke a Cloud Functions function when an email arrives. The service automatically generates an email address when creating the trigger.
Getting started
To create a trigger, you need:
-
A function that the trigger will invoke. If you do not have a function:
-
(Optional) A Dead Letter Queue where messages that could not be processed by a function will be redirected. If you do not have a queue, create one.
-
Service accounts with rights:
- To invoke a function.
- (Optional) To write to a Dead Letter Queue.
- (Optional) To upload objects to buckets.
You can use the same service account or different ones. If you do not have a service account, create one.
-
(Optional) Bucket to save email attachments to. If you do not have a bucket, create one with restricted access.
Creating a trigger
Note
The trigger is initiated within 5 minutes of being created.
-
In the management console
, select the folder where you want to create your trigger. -
Select Cloud Functions.
-
In the left-hand panel, select
Triggers. -
Click Create trigger.
-
Under Basic settings:
- (Optional) Enter a trigger name and description.
- In the Type field, select
Email
. - In the Launched resource field, select
Function
.
-
(Optional) Under Settings for saving attachments:
- In the Bucket field, select the bucket to save email attachments to.
- In the Service account field, specify a service account authorized to upload objects to the Object Storage bucket.
-
Under Function settings, select a function and specify:
- Function version tag.
- Service account to invoke the function under.
-
(Optional) Under Repeat request settings:
- In the Interval field, specify the time after which the function will be invoked again if the current attempt fails. The values may range from 10 to 60 seconds. The default value is 10 seconds.
- In the Number of attempts field, specify the number of invocation retries before the trigger moves a message to the Dead Letter Queue. The values may range from 1 to 5. The default value is 1.
-
(Optional) Under Dead Letter Queue settings, select the Dead Letter Queue and the service account with write privileges for this queue.
-
Click Create trigger.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To create a trigger that invokes a function, run this command:
yc serverless trigger create mail \
--name <trigger_name> \
--batch-size <batch_size> \
--batch-cutoff <maximum_wait_time> \
--attachements-bucket <bucket_name> \
--attachements-service-account-id <service_account_ID> \
--invoke-function-id <function_ID> \
--invoke-function-service-account-id <service_account_ID> \
--retry-attempts 1 \
--retry-interval 10s \
--dlq-queue-id <Dead_Letter_Queue_ID> \
--dlq-service-account-id <service_account_ID>
Where:
--name
: Trigger name
--batch-size
: Message batch size. This is an optional parameter. The values may range from 1 to 10. The default value is 1.--batch-cutoff
: Maximum wait time. This is an optional parameter. The values may range from 1 to 60 seconds. The default value is 1 second. The trigger groups messages for a period not exceedingbatch-cutoff
and sends them to a function. The number of messages cannot exceedbatch-size
.
--attachements-bucket
: Name of the bucket to save email attachments to. This is an optional parameter.--attachements-service-account-id
: ID of the service account authorized to upload objects to Object Storage buckets. This is an optional parameter.
--invoke-function-id
: Function ID.--invoke-function-service-account-id
: Service account with rights to invoke the function.--retry-attempts
: Number of invocation retries before the trigger moves a message to the Dead Letter Queue. Optional parameter. The values may range from 1 to 5. The default value is 1.--retry-interval
: Time after which the function will be invoked again if the current attempt fails. Optional parameter. The values may range from 10 to 60 seconds. The default value is 10 seconds.--dlq-queue-id
: Dead Letter Queue ID. Optional parameter.--dlq-service-account-id
: Service account with the permission to write messages to the Dead Letter Queue. Optional parameter.
Result:
id: a1sfe084v4**********
folder_id: b1g88tflru**********
created_at: "2022-12-04T08:45:31.131391Z"
name: mail-trigger
rule:
mail:
email: a1s8h8avgl**********-cho1****@serverless.yandexcloud.net
batch_settings:
size: "3"
cutoff: 20s
attachments_bucket:
bucket_id: bucket-for-attachments
service_account_id: ajejeis235ma********
invoke_function:
function_id: d4eofc7n0m**********
function_tag: $latest
service_account_id: aje3932acd**********
retry_settings:
retry_attempts: "1"
interval: 10s
dead_letter_queue:
queue-id: yrn:yc:ymq:ru-central1:aoek49ghmk**********:dlq
service-account-id: aje3932acd**********
status: ACTIVE
To create an email trigger, use the create REST API method for the Trigger resource or the TriggerService/Create gRPC API call.
Cloud Functions will automatically generate an email address that will cause the trigger to fire when messages are sent to it. To see it, retrieve detailed trigger information.
Checking the result
Check that the trigger operates correctly. Do it by viewing function logs that present information on invocations.