Skip to content

EmailRoutingRoutingRulesApi.md

Latest commit

 

History

History
395 lines (285 loc) · 15.7 KB

EmailRoutingRoutingRulesApi.md

File metadata and controls

395 lines (285 loc) · 15.7 KB

cloudflare_dart.api.EmailRoutingRoutingRulesApi

Load the API package

import 'package:cloudflare_dart/api.dart';

All URIs are relative to https://api.cloudflare.com/client/v4

Method HTTP request Description
emailRoutingRoutingRulesCreateRoutingRule POST /zones/{zone_id}/email/routing/rules Create routing rule
emailRoutingRoutingRulesDeleteRoutingRule DELETE /zones/{zone_id}/email/routing/rules/{rule_identifier} Delete routing rule
emailRoutingRoutingRulesGetCatchAllRule GET /zones/{zone_id}/email/routing/rules/catch_all Get catch-all rule
emailRoutingRoutingRulesGetRoutingRule GET /zones/{zone_id}/email/routing/rules/{rule_identifier} Get routing rule
emailRoutingRoutingRulesListRoutingRules GET /zones/{zone_id}/email/routing/rules List routing rules
emailRoutingRoutingRulesUpdateCatchAllRule PUT /zones/{zone_id}/email/routing/rules/catch_all Update catch-all rule
emailRoutingRoutingRulesUpdateRoutingRule PUT /zones/{zone_id}/email/routing/rules/{rule_identifier} Update routing rule

emailRoutingRoutingRulesCreateRoutingRule

EmailRuleResponseSingle emailRoutingRoutingRulesCreateRoutingRule(zoneId, emailCreateRuleProperties)

Create routing rule

Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address).

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getEmailRoutingRoutingRulesApi();
final String zoneId = zoneId_example; // String | 
final EmailCreateRuleProperties emailCreateRuleProperties = ; // EmailCreateRuleProperties | 

try {
    final response = api.emailRoutingRoutingRulesCreateRoutingRule(zoneId, emailCreateRuleProperties);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EmailRoutingRoutingRulesApi->emailRoutingRoutingRulesCreateRoutingRule: $e\n');
}

Parameters

Name Type Description Notes
zoneId String
emailCreateRuleProperties EmailCreateRuleProperties

Return type

EmailRuleResponseSingle

Authorization

api_key, api_email

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

emailRoutingRoutingRulesDeleteRoutingRule

EmailRuleResponseSingle emailRoutingRoutingRulesDeleteRoutingRule(ruleIdentifier, zoneId)

Delete routing rule

Delete a specific routing rule.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getEmailRoutingRoutingRulesApi();
final String ruleIdentifier = ruleIdentifier_example; // String | 
final String zoneId = zoneId_example; // String | 

try {
    final response = api.emailRoutingRoutingRulesDeleteRoutingRule(ruleIdentifier, zoneId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EmailRoutingRoutingRulesApi->emailRoutingRoutingRulesDeleteRoutingRule: $e\n');
}

Parameters

Name Type Description Notes
ruleIdentifier String
zoneId String

Return type

EmailRuleResponseSingle

Authorization

api_key, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

emailRoutingRoutingRulesGetCatchAllRule

EmailCatchAllRuleResponseSingle emailRoutingRoutingRulesGetCatchAllRule(zoneId)

Get catch-all rule

Get information on the default catch-all routing rule.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getEmailRoutingRoutingRulesApi();
final String zoneId = zoneId_example; // String | 

try {
    final response = api.emailRoutingRoutingRulesGetCatchAllRule(zoneId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EmailRoutingRoutingRulesApi->emailRoutingRoutingRulesGetCatchAllRule: $e\n');
}

Parameters

Name Type Description Notes
zoneId String

Return type

EmailCatchAllRuleResponseSingle

Authorization

api_key, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

emailRoutingRoutingRulesGetRoutingRule

EmailRuleResponseSingle emailRoutingRoutingRulesGetRoutingRule(ruleIdentifier, zoneId)

Get routing rule

Get information for a specific routing rule already created.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getEmailRoutingRoutingRulesApi();
final String ruleIdentifier = ruleIdentifier_example; // String | 
final String zoneId = zoneId_example; // String | 

try {
    final response = api.emailRoutingRoutingRulesGetRoutingRule(ruleIdentifier, zoneId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EmailRoutingRoutingRulesApi->emailRoutingRoutingRulesGetRoutingRule: $e\n');
}

Parameters

Name Type Description Notes
ruleIdentifier String
zoneId String

Return type

EmailRuleResponseSingle

Authorization

api_key, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

emailRoutingRoutingRulesListRoutingRules

EmailRulesResponseCollection emailRoutingRoutingRulesListRoutingRules(zoneId, page, perPage, enabled)

List routing rules

Lists existing routing rules.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getEmailRoutingRoutingRulesApi();
final String zoneId = zoneId_example; // String | 
final num page = 8.14; // num | 
final num perPage = 8.14; // num | 
final bool enabled = true; // bool | 

try {
    final response = api.emailRoutingRoutingRulesListRoutingRules(zoneId, page, perPage, enabled);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EmailRoutingRoutingRulesApi->emailRoutingRoutingRulesListRoutingRules: $e\n');
}

Parameters

Name Type Description Notes
zoneId String
page num [optional] [default to 1]
perPage num [optional] [default to 20]
enabled bool [optional]

Return type

EmailRulesResponseCollection

Authorization

api_key, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

emailRoutingRoutingRulesUpdateCatchAllRule

EmailCatchAllRuleResponseSingle emailRoutingRoutingRulesUpdateCatchAllRule(zoneId, emailUpdateCatchAllRuleProperties)

Update catch-all rule

Enable or disable catch-all routing rule, or change action to forward to specific destination address.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getEmailRoutingRoutingRulesApi();
final String zoneId = zoneId_example; // String | 
final EmailUpdateCatchAllRuleProperties emailUpdateCatchAllRuleProperties = ; // EmailUpdateCatchAllRuleProperties | 

try {
    final response = api.emailRoutingRoutingRulesUpdateCatchAllRule(zoneId, emailUpdateCatchAllRuleProperties);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EmailRoutingRoutingRulesApi->emailRoutingRoutingRulesUpdateCatchAllRule: $e\n');
}

Parameters

Name Type Description Notes
zoneId String
emailUpdateCatchAllRuleProperties EmailUpdateCatchAllRuleProperties

Return type

EmailCatchAllRuleResponseSingle

Authorization

api_key, api_email

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

emailRoutingRoutingRulesUpdateRoutingRule

EmailRuleResponseSingle emailRoutingRoutingRulesUpdateRoutingRule(ruleIdentifier, zoneId, emailUpdateRuleProperties)

Update routing rule

Update actions and matches, or enable/disable specific routing rules.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getEmailRoutingRoutingRulesApi();
final String ruleIdentifier = ruleIdentifier_example; // String | 
final String zoneId = zoneId_example; // String | 
final EmailUpdateRuleProperties emailUpdateRuleProperties = ; // EmailUpdateRuleProperties | 

try {
    final response = api.emailRoutingRoutingRulesUpdateRoutingRule(ruleIdentifier, zoneId, emailUpdateRuleProperties);
    print(response);
} catch on DioException (e) {
    print('Exception when calling EmailRoutingRoutingRulesApi->emailRoutingRoutingRulesUpdateRoutingRule: $e\n');
}

Parameters

Name Type Description Notes
ruleIdentifier String
zoneId String
emailUpdateRuleProperties EmailUpdateRuleProperties

Return type

EmailRuleResponseSingle

Authorization

api_key, api_email

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]